software.amazon.awssdk.services.mturk.model.CreateAdditionalAssignmentsForHitRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mturk Show documentation
The AWS Java SDK for Amazon Mechanical Turk Requester module holds the client classes that are used for communicating with Amazon Mechanical Turk Requester Service.
There is a newer version: 2.30.1
Show newest version
/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
 * the License. A copy of the License is located at
 * 
 * http://aws.amazon.com/apache2.0
 * 
 * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
 * and limitations under the License.
 */

package software.amazon.awssdk.services.mturk.model;

import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;

/**
 */
@Generated("software.amazon.awssdk:codegen")
public final class CreateAdditionalAssignmentsForHitRequest extends MTurkRequest implements
        ToCopyableBuilder {
    private static final SdkField HIT_ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("HITId")
            .getter(getter(CreateAdditionalAssignmentsForHitRequest::hitId)).setter(setter(Builder::hitId))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("HITId").build()).build();

    private static final SdkField NUMBER_OF_ADDITIONAL_ASSIGNMENTS_FIELD = SdkField
            . builder(MarshallingType.INTEGER)
            .memberName("NumberOfAdditionalAssignments")
            .getter(getter(CreateAdditionalAssignmentsForHitRequest::numberOfAdditionalAssignments))
            .setter(setter(Builder::numberOfAdditionalAssignments))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NumberOfAdditionalAssignments")
                    .build()).build();

    private static final SdkField UNIQUE_REQUEST_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
            .memberName("UniqueRequestToken").getter(getter(CreateAdditionalAssignmentsForHitRequest::uniqueRequestToken))
            .setter(setter(Builder::uniqueRequestToken))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("UniqueRequestToken").build())
            .build();

    private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(HIT_ID_FIELD,
            NUMBER_OF_ADDITIONAL_ASSIGNMENTS_FIELD, UNIQUE_REQUEST_TOKEN_FIELD));

    private final String hitId;

    private final Integer numberOfAdditionalAssignments;

    private final String uniqueRequestToken;

    private CreateAdditionalAssignmentsForHitRequest(BuilderImpl builder) {
        super(builder);
        this.hitId = builder.hitId;
        this.numberOfAdditionalAssignments = builder.numberOfAdditionalAssignments;
        this.uniqueRequestToken = builder.uniqueRequestToken;
    }

    /**
     * 
     * The ID of the HIT to extend.
     * 
     * 
     * @return The ID of the HIT to extend.
     */
    public final String hitId() {
        return hitId;
    }

    /**
     * 
     * The number of additional assignments to request for this HIT.
     * 
     * 
     * @return The number of additional assignments to request for this HIT.
     */
    public final Integer numberOfAdditionalAssignments() {
        return numberOfAdditionalAssignments;
    }

    /**
     * 
     * A unique identifier for this request, which allows you to retry the call on error without extending the HIT
     * multiple times. This is useful in cases such as network timeouts where it is unclear whether or not the call
     * succeeded on the server. If the extend HIT already exists in the system from a previous call using the same
     * UniqueRequestToken, subsequent calls will return an error with a message containing the request ID.
     * 
     * 
     * @return A unique identifier for this request, which allows you to retry the call on error without extending the
     *         HIT multiple times. This is useful in cases such as network timeouts where it is unclear whether or not
     *         the call succeeded on the server. If the extend HIT already exists in the system from a previous call
     *         using the same UniqueRequestToken, subsequent calls will return an error with a message
     *         containing the request ID.
     */
    public final String uniqueRequestToken() {
        return uniqueRequestToken;
    }

    @Override
    public Builder toBuilder() {
        return new BuilderImpl(this);
    }

    public static Builder builder() {
        return new BuilderImpl();
    }

    public static Class serializableBuilderClass() {
        return BuilderImpl.class;
    }

    @Override
    public final int hashCode() {
        int hashCode = 1;
        hashCode = 31 * hashCode + super.hashCode();
        hashCode = 31 * hashCode + Objects.hashCode(hitId());
        hashCode = 31 * hashCode + Objects.hashCode(numberOfAdditionalAssignments());
        hashCode = 31 * hashCode + Objects.hashCode(uniqueRequestToken());
        return hashCode;
    }

    @Override
    public final boolean equals(Object obj) {
        return super.equals(obj) && equalsBySdkFields(obj);
    }

    @Override
    public final boolean equalsBySdkFields(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if (!(obj instanceof CreateAdditionalAssignmentsForHitRequest)) {
            return false;
        }
        CreateAdditionalAssignmentsForHitRequest other = (CreateAdditionalAssignmentsForHitRequest) obj;
        return Objects.equals(hitId(), other.hitId())
                && Objects.equals(numberOfAdditionalAssignments(), other.numberOfAdditionalAssignments())
                && Objects.equals(uniqueRequestToken(), other.uniqueRequestToken());
    }

    /**
     * Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
     * redacted from this string using a placeholder value.
     */
    @Override
    public final String toString() {
        return ToString.builder("CreateAdditionalAssignmentsForHitRequest").add("HITId", hitId())
                .add("NumberOfAdditionalAssignments", numberOfAdditionalAssignments())
                .add("UniqueRequestToken", uniqueRequestToken()).build();
    }

    public final  Optional getValueForField(String fieldName, Class clazz) {
        switch (fieldName) {
        case "HITId":
            return Optional.ofNullable(clazz.cast(hitId()));
        case "NumberOfAdditionalAssignments":
            return Optional.ofNullable(clazz.cast(numberOfAdditionalAssignments()));
        case "UniqueRequestToken":
            return Optional.ofNullable(clazz.cast(uniqueRequestToken()));
        default:
            return Optional.empty();
        }
    }

    @Override
    public final List> sdkFields() {
        return SDK_FIELDS;
    }

    private static  Function getter(Function g) {
        return obj -> g.apply((CreateAdditionalAssignmentsForHitRequest) obj);
    }

    private static  BiConsumer setter(BiConsumer s) {
        return (obj, val) -> s.accept((Builder) obj, val);
    }

    public interface Builder extends MTurkRequest.Builder, SdkPojo,
            CopyableBuilder {
        /**
         * 
         * The ID of the HIT to extend.
         * 
         * 
         * @param hitId
         *        The ID of the HIT to extend.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder hitId(String hitId);

        /**
         * 
         * The number of additional assignments to request for this HIT.
         * 
         * 
         * @param numberOfAdditionalAssignments
         *        The number of additional assignments to request for this HIT.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder numberOfAdditionalAssignments(Integer numberOfAdditionalAssignments);

        /**
         * 
         * A unique identifier for this request, which allows you to retry the call on error without extending the HIT
         * multiple times. This is useful in cases such as network timeouts where it is unclear whether or not the call
         * succeeded on the server. If the extend HIT already exists in the system from a previous call using the same
         * UniqueRequestToken, subsequent calls will return an error with a message containing the request
         * ID.
         * 
         * 
         * @param uniqueRequestToken
         *        A unique identifier for this request, which allows you to retry the call on error without extending
         *        the HIT multiple times. This is useful in cases such as network timeouts where it is unclear whether
         *        or not the call succeeded on the server. If the extend HIT already exists in the system from a
         *        previous call using the same UniqueRequestToken, subsequent calls will return an error
         *        with a message containing the request ID.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder uniqueRequestToken(String uniqueRequestToken);

        @Override
        Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);

        @Override
        Builder overrideConfiguration(Consumer builderConsumer);
    }

    static final class BuilderImpl extends MTurkRequest.BuilderImpl implements Builder {
        private String hitId;

        private Integer numberOfAdditionalAssignments;

        private String uniqueRequestToken;

        private BuilderImpl() {
        }

        private BuilderImpl(CreateAdditionalAssignmentsForHitRequest model) {
            super(model);
            hitId(model.hitId);
            numberOfAdditionalAssignments(model.numberOfAdditionalAssignments);
            uniqueRequestToken(model.uniqueRequestToken);
        }

        public final String getHitId() {
            return hitId;
        }

        public final void setHitId(String hitId) {
            this.hitId = hitId;
        }

        @Override
        public final Builder hitId(String hitId) {
            this.hitId = hitId;
            return this;
        }

        public final Integer getNumberOfAdditionalAssignments() {
            return numberOfAdditionalAssignments;
        }

        public final void setNumberOfAdditionalAssignments(Integer numberOfAdditionalAssignments) {
            this.numberOfAdditionalAssignments = numberOfAdditionalAssignments;
        }

        @Override
        public final Builder numberOfAdditionalAssignments(Integer numberOfAdditionalAssignments) {
            this.numberOfAdditionalAssignments = numberOfAdditionalAssignments;
            return this;
        }

        public final String getUniqueRequestToken() {
            return uniqueRequestToken;
        }

        public final void setUniqueRequestToken(String uniqueRequestToken) {
            this.uniqueRequestToken = uniqueRequestToken;
        }

        @Override
        public final Builder uniqueRequestToken(String uniqueRequestToken) {
            this.uniqueRequestToken = uniqueRequestToken;
            return this;
        }

        @Override
        public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
            super.overrideConfiguration(overrideConfiguration);
            return this;
        }

        @Override
        public Builder overrideConfiguration(Consumer builderConsumer) {
            super.overrideConfiguration(builderConsumer);
            return this;
        }

        @Override
        public CreateAdditionalAssignmentsForHitRequest build() {
            return new CreateAdditionalAssignmentsForHitRequest(this);
        }

        @Override
        public List> sdkFields() {
            return SDK_FIELDS;
        }
    }
}