software.amazon.awssdk.services.mturk.model.ListHiTsResponse Maven / Gradle / Ivy
Show all versions of mturk Show documentation
/*
* 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.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
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.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
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 ListHiTsResponse extends MTurkResponse implements
ToCopyableBuilder {
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextToken").getter(getter(ListHiTsResponse::nextToken)).setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextToken").build()).build();
private static final SdkField NUM_RESULTS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("NumResults").getter(getter(ListHiTsResponse::numResults)).setter(setter(Builder::numResults))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NumResults").build()).build();
private static final SdkField> HI_TS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("HITs")
.getter(getter(ListHiTsResponse::hiTs))
.setter(setter(Builder::hiTs))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("HITs").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(HIT::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NEXT_TOKEN_FIELD,
NUM_RESULTS_FIELD, HI_TS_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private final String nextToken;
private final Integer numResults;
private final List hiTs;
private ListHiTsResponse(BuilderImpl builder) {
super(builder);
this.nextToken = builder.nextToken;
this.numResults = builder.numResults;
this.hiTs = builder.hiTs;
}
/**
* Returns the value of the NextToken property for this object.
*
* @return The value of the NextToken property for this object.
*/
public final String nextToken() {
return nextToken;
}
/**
*
* The number of HITs on this page in the filtered results list, equivalent to the number of HITs being returned by
* this call.
*
*
* @return The number of HITs on this page in the filtered results list, equivalent to the number of HITs being
* returned by this call.
*/
public final Integer numResults() {
return numResults;
}
/**
* For responses, this returns true if the service returned a value for the HITs property. This DOES NOT check that
* the value is non-empty (for which, you should check the {@code isEmpty()} method on the property). This is useful
* because the SDK will never return a null collection or map, but you may need to differentiate between the service
* returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
* if a value for the property was specified in the request builder, and false if a value was not specified.
*/
public final boolean hasHiTs() {
return hiTs != null && !(hiTs instanceof SdkAutoConstructList);
}
/**
*
* The list of HIT elements returned by the query.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasHiTs} method.
*
*
* @return The list of HIT elements returned by the query.
*/
public final List hiTs() {
return hiTs;
}
@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(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(numResults());
hashCode = 31 * hashCode + Objects.hashCode(hasHiTs() ? hiTs() : null);
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 ListHiTsResponse)) {
return false;
}
ListHiTsResponse other = (ListHiTsResponse) obj;
return Objects.equals(nextToken(), other.nextToken()) && Objects.equals(numResults(), other.numResults())
&& hasHiTs() == other.hasHiTs() && Objects.equals(hiTs(), other.hiTs());
}
/**
* 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("ListHiTsResponse").add("NextToken", nextToken()).add("NumResults", numResults())
.add("HITs", hasHiTs() ? hiTs() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "NumResults":
return Optional.ofNullable(clazz.cast(numResults()));
case "HITs":
return Optional.ofNullable(clazz.cast(hiTs()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Map> memberNameToFieldInitializer() {
Map> map = new HashMap<>();
map.put("NextToken", NEXT_TOKEN_FIELD);
map.put("NumResults", NUM_RESULTS_FIELD);
map.put("HITs", HI_TS_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function getter(Function g) {
return obj -> g.apply((ListHiTsResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends MTurkResponse.Builder, SdkPojo, CopyableBuilder {
/**
* Sets the value of the NextToken property for this object.
*
* @param nextToken
* The new value for the NextToken property for this object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
/**
*
* The number of HITs on this page in the filtered results list, equivalent to the number of HITs being returned
* by this call.
*
*
* @param numResults
* The number of HITs on this page in the filtered results list, equivalent to the number of HITs being
* returned by this call.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder numResults(Integer numResults);
/**
*
* The list of HIT elements returned by the query.
*
*
* @param hiTs
* The list of HIT elements returned by the query.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder hiTs(Collection hiTs);
/**
*
* The list of HIT elements returned by the query.
*
*
* @param hiTs
* The list of HIT elements returned by the query.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder hiTs(HIT... hiTs);
/**
*
* The list of HIT elements returned by the query.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.mturk.model.HIT.Builder} avoiding the need to create one manually via
* {@link software.amazon.awssdk.services.mturk.model.HIT#builder()}.
*
*
* When the {@link Consumer} completes, {@link software.amazon.awssdk.services.mturk.model.HIT.Builder#build()}
* is called immediately and its result is passed to {@link #hiTs(List)}.
*
* @param hiTs
* a consumer that will call methods on {@link software.amazon.awssdk.services.mturk.model.HIT.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #hiTs(java.util.Collection)
*/
Builder hiTs(Consumer... hiTs);
}
static final class BuilderImpl extends MTurkResponse.BuilderImpl implements Builder {
private String nextToken;
private Integer numResults;
private List hiTs = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(ListHiTsResponse model) {
super(model);
nextToken(model.nextToken);
numResults(model.numResults);
hiTs(model.hiTs);
}
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 getNumResults() {
return numResults;
}
public final void setNumResults(Integer numResults) {
this.numResults = numResults;
}
@Override
public final Builder numResults(Integer numResults) {
this.numResults = numResults;
return this;
}
public final List getHiTs() {
List result = HITListCopier.copyToBuilder(this.hiTs);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setHiTs(Collection hiTs) {
this.hiTs = HITListCopier.copyFromBuilder(hiTs);
}
@Override
public final Builder hiTs(Collection hiTs) {
this.hiTs = HITListCopier.copy(hiTs);
return this;
}
@Override
@SafeVarargs
public final Builder hiTs(HIT... hiTs) {
hiTs(Arrays.asList(hiTs));
return this;
}
@Override
@SafeVarargs
public final Builder hiTs(Consumer... hiTs) {
hiTs(Stream.of(hiTs).map(c -> HIT.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public ListHiTsResponse build() {
return new ListHiTsResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}