software.amazon.awssdk.services.mturk.model.PolicyParameter 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.beans.Transient;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
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 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;
/**
*
* Name of the parameter from the Review policy.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class PolicyParameter implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField KEY_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Key")
.getter(getter(PolicyParameter::key)).setter(setter(Builder::key))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Key").build()).build();
private static final SdkField> VALUES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Values")
.getter(getter(PolicyParameter::values))
.setter(setter(Builder::values))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Values").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> MAP_ENTRIES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("MapEntries")
.getter(getter(PolicyParameter::mapEntries))
.setter(setter(Builder::mapEntries))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MapEntries").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(ParameterMapEntry::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(KEY_FIELD, VALUES_FIELD,
MAP_ENTRIES_FIELD));
private static final long serialVersionUID = 1L;
private final String key;
private final List values;
private final List mapEntries;
private PolicyParameter(BuilderImpl builder) {
this.key = builder.key;
this.values = builder.values;
this.mapEntries = builder.mapEntries;
}
/**
*
* Name of the parameter from the list of Review Polices.
*
*
* @return Name of the parameter from the list of Review Polices.
*/
public final String key() {
return key;
}
/**
* For responses, this returns true if the service returned a value for the Values 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 hasValues() {
return values != null && !(values instanceof SdkAutoConstructList);
}
/**
*
* The list of values of the Parameter
*
*
* 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 #hasValues} method.
*
*
* @return The list of values of the Parameter
*/
public final List values() {
return values;
}
/**
* For responses, this returns true if the service returned a value for the MapEntries 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 hasMapEntries() {
return mapEntries != null && !(mapEntries instanceof SdkAutoConstructList);
}
/**
*
* List of ParameterMapEntry objects.
*
*
* 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 #hasMapEntries} method.
*
*
* @return List of ParameterMapEntry objects.
*/
public final List mapEntries() {
return mapEntries;
}
@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(key());
hashCode = 31 * hashCode + Objects.hashCode(hasValues() ? values() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasMapEntries() ? mapEntries() : null);
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 PolicyParameter)) {
return false;
}
PolicyParameter other = (PolicyParameter) obj;
return Objects.equals(key(), other.key()) && hasValues() == other.hasValues() && Objects.equals(values(), other.values())
&& hasMapEntries() == other.hasMapEntries() && Objects.equals(mapEntries(), other.mapEntries());
}
/**
* 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("PolicyParameter").add("Key", key()).add("Values", hasValues() ? values() : null)
.add("MapEntries", hasMapEntries() ? mapEntries() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Key":
return Optional.ofNullable(clazz.cast(key()));
case "Values":
return Optional.ofNullable(clazz.cast(values()));
case "MapEntries":
return Optional.ofNullable(clazz.cast(mapEntries()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((PolicyParameter) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* Name of the parameter from the list of Review Polices.
*
*
* @param key
* Name of the parameter from the list of Review Polices.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder key(String key);
/**
*
* The list of values of the Parameter
*
*
* @param values
* The list of values of the Parameter
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder values(Collection values);
/**
*
* The list of values of the Parameter
*
*
* @param values
* The list of values of the Parameter
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder values(String... values);
/**
*
* List of ParameterMapEntry objects.
*
*
* @param mapEntries
* List of ParameterMapEntry objects.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder mapEntries(Collection mapEntries);
/**
*
* List of ParameterMapEntry objects.
*
*
* @param mapEntries
* List of ParameterMapEntry objects.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder mapEntries(ParameterMapEntry... mapEntries);
/**
*
* List of ParameterMapEntry objects.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the
* need to create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately
* and its result is passed to {@link #mapEntries(List)}.
*
* @param mapEntries
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #mapEntries(List)
*/
Builder mapEntries(Consumer... mapEntries);
}
static final class BuilderImpl implements Builder {
private String key;
private List values = DefaultSdkAutoConstructList.getInstance();
private List mapEntries = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(PolicyParameter model) {
key(model.key);
values(model.values);
mapEntries(model.mapEntries);
}
public final String getKey() {
return key;
}
public final void setKey(String key) {
this.key = key;
}
@Override
@Transient
public final Builder key(String key) {
this.key = key;
return this;
}
public final Collection getValues() {
if (values instanceof SdkAutoConstructList) {
return null;
}
return values;
}
public final void setValues(Collection values) {
this.values = StringListCopier.copy(values);
}
@Override
@Transient
public final Builder values(Collection values) {
this.values = StringListCopier.copy(values);
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder values(String... values) {
values(Arrays.asList(values));
return this;
}
public final List getMapEntries() {
List result = ParameterMapEntryListCopier.copyToBuilder(this.mapEntries);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setMapEntries(Collection mapEntries) {
this.mapEntries = ParameterMapEntryListCopier.copyFromBuilder(mapEntries);
}
@Override
@Transient
public final Builder mapEntries(Collection mapEntries) {
this.mapEntries = ParameterMapEntryListCopier.copy(mapEntries);
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder mapEntries(ParameterMapEntry... mapEntries) {
mapEntries(Arrays.asList(mapEntries));
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder mapEntries(Consumer... mapEntries) {
mapEntries(Stream.of(mapEntries).map(c -> ParameterMapEntry.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
@Override
public PolicyParameter build() {
return new PolicyParameter(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy