software.amazon.awssdk.services.mturk.model.ListReviewableHiTsRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of mturk Show documentation
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.
/*
* 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 ListReviewableHiTsRequest extends MTurkRequest implements
ToCopyableBuilder {
private static final SdkField HIT_TYPE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("HITTypeId").getter(getter(ListReviewableHiTsRequest::hitTypeId)).setter(setter(Builder::hitTypeId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("HITTypeId").build()).build();
private static final SdkField STATUS_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Status")
.getter(getter(ListReviewableHiTsRequest::statusAsString)).setter(setter(Builder::status))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Status").build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextToken").getter(getter(ListReviewableHiTsRequest::nextToken)).setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextToken").build()).build();
private static final SdkField MAX_RESULTS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxResults").getter(getter(ListReviewableHiTsRequest::maxResults)).setter(setter(Builder::maxResults))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxResults").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(HIT_TYPE_ID_FIELD,
STATUS_FIELD, NEXT_TOKEN_FIELD, MAX_RESULTS_FIELD));
private final String hitTypeId;
private final String status;
private final String nextToken;
private final Integer maxResults;
private ListReviewableHiTsRequest(BuilderImpl builder) {
super(builder);
this.hitTypeId = builder.hitTypeId;
this.status = builder.status;
this.nextToken = builder.nextToken;
this.maxResults = builder.maxResults;
}
/**
*
* The ID of the HIT type of the HITs to consider for the query. If not specified, all HITs for the Reviewer are
* considered
*
*
* @return The ID of the HIT type of the HITs to consider for the query. If not specified, all HITs for the Reviewer
* are considered
*/
public final String hitTypeId() {
return hitTypeId;
}
/**
*
* Can be either Reviewable or Reviewing. Reviewable is the default value.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link ReviewableHITStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #statusAsString}.
*
*
* @return Can be either Reviewable or Reviewing. Reviewable is the default value.
* @see ReviewableHITStatus
*/
public final ReviewableHITStatus status() {
return ReviewableHITStatus.fromValue(status);
}
/**
*
* Can be either Reviewable or Reviewing. Reviewable is the default value.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link ReviewableHITStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #statusAsString}.
*
*
* @return Can be either Reviewable or Reviewing. Reviewable is the default value.
* @see ReviewableHITStatus
*/
public final String statusAsString() {
return status;
}
/**
*
* Pagination Token
*
*
* @return Pagination Token
*/
public final String nextToken() {
return nextToken;
}
/**
*
* Limit the number of results returned.
*
*
* @return Limit the number of results returned.
*/
public final Integer maxResults() {
return maxResults;
}
@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(hitTypeId());
hashCode = 31 * hashCode + Objects.hashCode(statusAsString());
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(maxResults());
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 ListReviewableHiTsRequest)) {
return false;
}
ListReviewableHiTsRequest other = (ListReviewableHiTsRequest) obj;
return Objects.equals(hitTypeId(), other.hitTypeId()) && Objects.equals(statusAsString(), other.statusAsString())
&& Objects.equals(nextToken(), other.nextToken()) && Objects.equals(maxResults(), other.maxResults());
}
/**
* 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("ListReviewableHiTsRequest").add("HITTypeId", hitTypeId()).add("Status", statusAsString())
.add("NextToken", nextToken()).add("MaxResults", maxResults()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "HITTypeId":
return Optional.ofNullable(clazz.cast(hitTypeId()));
case "Status":
return Optional.ofNullable(clazz.cast(statusAsString()));
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "MaxResults":
return Optional.ofNullable(clazz.cast(maxResults()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ListReviewableHiTsRequest) 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 type of the HITs to consider for the query. If not specified, all HITs for the Reviewer are
* considered
*
*
* @param hitTypeId
* The ID of the HIT type of the HITs to consider for the query. If not specified, all HITs for the
* Reviewer are considered
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder hitTypeId(String hitTypeId);
/**
*
* Can be either Reviewable or Reviewing. Reviewable is the default value.
*
*
* @param status
* Can be either Reviewable or Reviewing. Reviewable is the default value.
* @see ReviewableHITStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see ReviewableHITStatus
*/
Builder status(String status);
/**
*
* Can be either Reviewable or Reviewing. Reviewable is the default value.
*
*
* @param status
* Can be either Reviewable or Reviewing. Reviewable is the default value.
* @see ReviewableHITStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see ReviewableHITStatus
*/
Builder status(ReviewableHITStatus status);
/**
*
* Pagination Token
*
*
* @param nextToken
* Pagination Token
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
/**
*
* Limit the number of results returned.
*
*
* @param maxResults
* Limit the number of results returned.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxResults(Integer maxResults);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends MTurkRequest.BuilderImpl implements Builder {
private String hitTypeId;
private String status;
private String nextToken;
private Integer maxResults;
private BuilderImpl() {
}
private BuilderImpl(ListReviewableHiTsRequest model) {
super(model);
hitTypeId(model.hitTypeId);
status(model.status);
nextToken(model.nextToken);
maxResults(model.maxResults);
}
public final String getHitTypeId() {
return hitTypeId;
}
public final void setHitTypeId(String hitTypeId) {
this.hitTypeId = hitTypeId;
}
@Override
public final Builder hitTypeId(String hitTypeId) {
this.hitTypeId = hitTypeId;
return this;
}
public final String getStatus() {
return status;
}
public final void setStatus(String status) {
this.status = status;
}
@Override
public final Builder status(String status) {
this.status = status;
return this;
}
@Override
public final Builder status(ReviewableHITStatus status) {
this.status(status == null ? null : status.toString());
return this;
}
public final String getNextToken() {
return nextToken;
}
public final void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
@Override
public final Builder nextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
public final Integer getMaxResults() {
return maxResults;
}
public final void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
@Override
public final Builder maxResults(Integer maxResults) {
this.maxResults = maxResults;
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 ListReviewableHiTsRequest build() {
return new ListReviewableHiTsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy