software.amazon.awssdk.services.mturk.model.WorkerBlock 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.29.39
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.beans.Transient;
import java.io.Serializable;
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.Function;
import software.amazon.awssdk.annotations.Generated;
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;

/**
 * 
 * The WorkerBlock data structure represents a Worker who has been blocked. It has two elements: the WorkerId and the
 * Reason for the block.
 * 
 */
@Generated("software.amazon.awssdk:codegen")
public final class WorkerBlock implements SdkPojo, Serializable, ToCopyableBuilder {
    private static final SdkField WORKER_ID_FIELD = SdkField. builder(MarshallingType.STRING)
            .memberName("WorkerId").getter(getter(WorkerBlock::workerId)).setter(setter(Builder::workerId))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("WorkerId").build()).build();

    private static final SdkField REASON_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Reason")
            .getter(getter(WorkerBlock::reason)).setter(setter(Builder::reason))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Reason").build()).build();

    private static final List> SDK_FIELDS = Collections
            .unmodifiableList(Arrays.asList(WORKER_ID_FIELD, REASON_FIELD));

    private static final long serialVersionUID = 1L;

    private final String workerId;

    private final String reason;

    private WorkerBlock(BuilderImpl builder) {
        this.workerId = builder.workerId;
        this.reason = builder.reason;
    }

    /**
     * 
     * The ID of the Worker who accepted the HIT.
     * 
     * 
     * @return The ID of the Worker who accepted the HIT.
     */
    public final String workerId() {
        return workerId;
    }

    /**
     * 
     * A message explaining the reason the Worker was blocked.
     * 
     * 
     * @return A message explaining the reason the Worker was blocked.
     */
    public final String reason() {
        return reason;
    }

    @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 + Objects.hashCode(workerId());
        hashCode = 31 * hashCode + Objects.hashCode(reason());
        return hashCode;
    }

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

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

    /**
     * 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("WorkerBlock").add("WorkerId", workerId()).add("Reason", reason()).build();
    }

    public final  Optional getValueForField(String fieldName, Class clazz) {
        switch (fieldName) {
        case "WorkerId":
            return Optional.ofNullable(clazz.cast(workerId()));
        case "Reason":
            return Optional.ofNullable(clazz.cast(reason()));
        default:
            return Optional.empty();
        }
    }

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

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

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

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

        /**
         * 
         * A message explaining the reason the Worker was blocked.
         * 
         * 
         * @param reason
         *        A message explaining the reason the Worker was blocked.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder reason(String reason);
    }

    static final class BuilderImpl implements Builder {
        private String workerId;

        private String reason;

        private BuilderImpl() {
        }

        private BuilderImpl(WorkerBlock model) {
            workerId(model.workerId);
            reason(model.reason);
        }

        public final String getWorkerId() {
            return workerId;
        }

        public final void setWorkerId(String workerId) {
            this.workerId = workerId;
        }

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

        public final String getReason() {
            return reason;
        }

        public final void setReason(String reason) {
            this.reason = reason;
        }

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

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

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