software.amazon.awssdk.services.mturk.model.NotifyWorkersRequest 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.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 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.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 NotifyWorkersRequest extends MTurkRequest implements
ToCopyableBuilder {
private static final SdkField SUBJECT_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Subject")
.getter(getter(NotifyWorkersRequest::subject)).setter(setter(Builder::subject))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Subject").build()).build();
private static final SdkField MESSAGE_TEXT_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("MessageText").getter(getter(NotifyWorkersRequest::messageText)).setter(setter(Builder::messageText))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MessageText").build()).build();
private static final SdkField> WORKER_IDS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("WorkerIds")
.getter(getter(NotifyWorkersRequest::workerIds))
.setter(setter(Builder::workerIds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("WorkerIds").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 List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(SUBJECT_FIELD,
MESSAGE_TEXT_FIELD, WORKER_IDS_FIELD));
private final String subject;
private final String messageText;
private final List workerIds;
private NotifyWorkersRequest(BuilderImpl builder) {
super(builder);
this.subject = builder.subject;
this.messageText = builder.messageText;
this.workerIds = builder.workerIds;
}
/**
*
* The subject line of the email message to send. Can include up to 200 characters.
*
*
* @return The subject line of the email message to send. Can include up to 200 characters.
*/
public final String subject() {
return subject;
}
/**
*
* The text of the email message to send. Can include up to 4,096 characters
*
*
* @return The text of the email message to send. Can include up to 4,096 characters
*/
public final String messageText() {
return messageText;
}
/**
* For responses, this returns true if the service returned a value for the WorkerIds 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 hasWorkerIds() {
return workerIds != null && !(workerIds instanceof SdkAutoConstructList);
}
/**
*
* A list of Worker IDs you wish to notify. You can notify upto 100 Workers at a time.
*
*
* 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 #hasWorkerIds} method.
*
*
* @return A list of Worker IDs you wish to notify. You can notify upto 100 Workers at a time.
*/
public final List workerIds() {
return workerIds;
}
@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(subject());
hashCode = 31 * hashCode + Objects.hashCode(messageText());
hashCode = 31 * hashCode + Objects.hashCode(hasWorkerIds() ? workerIds() : 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 NotifyWorkersRequest)) {
return false;
}
NotifyWorkersRequest other = (NotifyWorkersRequest) obj;
return Objects.equals(subject(), other.subject()) && Objects.equals(messageText(), other.messageText())
&& hasWorkerIds() == other.hasWorkerIds() && Objects.equals(workerIds(), other.workerIds());
}
/**
* 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("NotifyWorkersRequest").add("Subject", subject()).add("MessageText", messageText())
.add("WorkerIds", hasWorkerIds() ? workerIds() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Subject":
return Optional.ofNullable(clazz.cast(subject()));
case "MessageText":
return Optional.ofNullable(clazz.cast(messageText()));
case "WorkerIds":
return Optional.ofNullable(clazz.cast(workerIds()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((NotifyWorkersRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends MTurkRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The subject line of the email message to send. Can include up to 200 characters.
*
*
* @param subject
* The subject line of the email message to send. Can include up to 200 characters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder subject(String subject);
/**
*
* The text of the email message to send. Can include up to 4,096 characters
*
*
* @param messageText
* The text of the email message to send. Can include up to 4,096 characters
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder messageText(String messageText);
/**
*
* A list of Worker IDs you wish to notify. You can notify upto 100 Workers at a time.
*
*
* @param workerIds
* A list of Worker IDs you wish to notify. You can notify upto 100 Workers at a time.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder workerIds(Collection workerIds);
/**
*
* A list of Worker IDs you wish to notify. You can notify upto 100 Workers at a time.
*
*
* @param workerIds
* A list of Worker IDs you wish to notify. You can notify upto 100 Workers at a time.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder workerIds(String... workerIds);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends MTurkRequest.BuilderImpl implements Builder {
private String subject;
private String messageText;
private List workerIds = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(NotifyWorkersRequest model) {
super(model);
subject(model.subject);
messageText(model.messageText);
workerIds(model.workerIds);
}
public final String getSubject() {
return subject;
}
public final void setSubject(String subject) {
this.subject = subject;
}
@Override
@Transient
public final Builder subject(String subject) {
this.subject = subject;
return this;
}
public final String getMessageText() {
return messageText;
}
public final void setMessageText(String messageText) {
this.messageText = messageText;
}
@Override
@Transient
public final Builder messageText(String messageText) {
this.messageText = messageText;
return this;
}
public final Collection getWorkerIds() {
if (workerIds instanceof SdkAutoConstructList) {
return null;
}
return workerIds;
}
public final void setWorkerIds(Collection workerIds) {
this.workerIds = CustomerIdListCopier.copy(workerIds);
}
@Override
@Transient
public final Builder workerIds(Collection workerIds) {
this.workerIds = CustomerIdListCopier.copy(workerIds);
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder workerIds(String... workerIds) {
workerIds(Arrays.asList(workerIds));
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 NotifyWorkersRequest build() {
return new NotifyWorkersRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy