software.amazon.awssdk.services.connect.model.ListTaskTemplatesRequest Maven / Gradle / Ivy
Show all versions of connect 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.connect.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 ListTaskTemplatesRequest extends ConnectRequest implements
ToCopyableBuilder {
private static final SdkField INSTANCE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("InstanceId").getter(getter(ListTaskTemplatesRequest::instanceId)).setter(setter(Builder::instanceId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("InstanceId").build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextToken").getter(getter(ListTaskTemplatesRequest::nextToken)).setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("nextToken").build()).build();
private static final SdkField MAX_RESULTS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxResults").getter(getter(ListTaskTemplatesRequest::maxResults)).setter(setter(Builder::maxResults))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("maxResults").build()).build();
private static final SdkField STATUS_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Status")
.getter(getter(ListTaskTemplatesRequest::statusAsString)).setter(setter(Builder::status))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("status").build()).build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(ListTaskTemplatesRequest::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("name").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(INSTANCE_ID_FIELD,
NEXT_TOKEN_FIELD, MAX_RESULTS_FIELD, STATUS_FIELD, NAME_FIELD));
private final String instanceId;
private final String nextToken;
private final Integer maxResults;
private final String status;
private final String name;
private ListTaskTemplatesRequest(BuilderImpl builder) {
super(builder);
this.instanceId = builder.instanceId;
this.nextToken = builder.nextToken;
this.maxResults = builder.maxResults;
this.status = builder.status;
this.name = builder.name;
}
/**
*
* The identifier of the Amazon Connect instance. You can find the instance ID in
* the Amazon Resource Name (ARN) of the instance.
*
*
* @return The identifier of the Amazon Connect instance. You can find the instance
* ID in the Amazon Resource Name (ARN) of the instance.
*/
public final String instanceId() {
return instanceId;
}
/**
*
* The token for the next set of results. Use the value returned in the previous response in the next request to
* retrieve the next set of results.
*
*
*
* It is not expected that you set this because the value returned in the previous response is always null.
*
*
*
* @return The token for the next set of results. Use the value returned in the previous response in the next
* request to retrieve the next set of results.
*
* It is not expected that you set this because the value returned in the previous response is always null.
*
*/
public final String nextToken() {
return nextToken;
}
/**
*
* The maximum number of results to return per page.
*
*
*
* It is not expected that you set this.
*
*
*
* @return The maximum number of results to return per page.
*
* It is not expected that you set this.
*
*/
public final Integer maxResults() {
return maxResults;
}
/**
*
* Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only be
* created from ACTIVE templates. If a template is marked as INACTIVE, then a task that
* refers to this template cannot be created.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link TaskTemplateStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #statusAsString}.
*
*
* @return Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can
* only be created from ACTIVE templates. If a template is marked as INACTIVE,
* then a task that refers to this template cannot be created.
* @see TaskTemplateStatus
*/
public final TaskTemplateStatus status() {
return TaskTemplateStatus.fromValue(status);
}
/**
*
* Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only be
* created from ACTIVE templates. If a template is marked as INACTIVE, then a task that
* refers to this template cannot be created.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link TaskTemplateStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #statusAsString}.
*
*
* @return Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can
* only be created from ACTIVE templates. If a template is marked as INACTIVE,
* then a task that refers to this template cannot be created.
* @see TaskTemplateStatus
*/
public final String statusAsString() {
return status;
}
/**
*
* The name of the task template.
*
*
* @return The name of the task template.
*/
public final String name() {
return name;
}
@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(instanceId());
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(maxResults());
hashCode = 31 * hashCode + Objects.hashCode(statusAsString());
hashCode = 31 * hashCode + Objects.hashCode(name());
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 ListTaskTemplatesRequest)) {
return false;
}
ListTaskTemplatesRequest other = (ListTaskTemplatesRequest) obj;
return Objects.equals(instanceId(), other.instanceId()) && Objects.equals(nextToken(), other.nextToken())
&& Objects.equals(maxResults(), other.maxResults()) && Objects.equals(statusAsString(), other.statusAsString())
&& Objects.equals(name(), other.name());
}
/**
* 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("ListTaskTemplatesRequest").add("InstanceId", instanceId()).add("NextToken", nextToken())
.add("MaxResults", maxResults()).add("Status", statusAsString()).add("Name", name()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "InstanceId":
return Optional.ofNullable(clazz.cast(instanceId()));
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "MaxResults":
return Optional.ofNullable(clazz.cast(maxResults()));
case "Status":
return Optional.ofNullable(clazz.cast(statusAsString()));
case "Name":
return Optional.ofNullable(clazz.cast(name()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ListTaskTemplatesRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends ConnectRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The identifier of the Amazon Connect instance. You can find the instance ID
* in the Amazon Resource Name (ARN) of the instance.
*
*
* @param instanceId
* The identifier of the Amazon Connect instance. You can find the instance
* ID in the Amazon Resource Name (ARN) of the instance.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder instanceId(String instanceId);
/**
*
* The token for the next set of results. Use the value returned in the previous response in the next request to
* retrieve the next set of results.
*
*
*
* It is not expected that you set this because the value returned in the previous response is always null.
*
*
*
* @param nextToken
* The token for the next set of results. Use the value returned in the previous response in the next
* request to retrieve the next set of results.
*
* It is not expected that you set this because the value returned in the previous response is always
* null.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
/**
*
* The maximum number of results to return per page.
*
*
*
* It is not expected that you set this.
*
*
*
* @param maxResults
* The maximum number of results to return per page.
*
* It is not expected that you set this.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxResults(Integer maxResults);
/**
*
* Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only be
* created from ACTIVE templates. If a template is marked as INACTIVE, then a task
* that refers to this template cannot be created.
*
*
* @param status
* Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can
* only be created from ACTIVE templates. If a template is marked as INACTIVE,
* then a task that refers to this template cannot be created.
* @see TaskTemplateStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see TaskTemplateStatus
*/
Builder status(String status);
/**
*
* Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only be
* created from ACTIVE templates. If a template is marked as INACTIVE, then a task
* that refers to this template cannot be created.
*
*
* @param status
* Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can
* only be created from ACTIVE templates. If a template is marked as INACTIVE,
* then a task that refers to this template cannot be created.
* @see TaskTemplateStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see TaskTemplateStatus
*/
Builder status(TaskTemplateStatus status);
/**
*
* The name of the task template.
*
*
* @param name
* The name of the task template.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends ConnectRequest.BuilderImpl implements Builder {
private String instanceId;
private String nextToken;
private Integer maxResults;
private String status;
private String name;
private BuilderImpl() {
}
private BuilderImpl(ListTaskTemplatesRequest model) {
super(model);
instanceId(model.instanceId);
nextToken(model.nextToken);
maxResults(model.maxResults);
status(model.status);
name(model.name);
}
public final String getInstanceId() {
return instanceId;
}
public final void setInstanceId(String instanceId) {
this.instanceId = instanceId;
}
@Override
public final Builder instanceId(String instanceId) {
this.instanceId = instanceId;
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;
}
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(TaskTemplateStatus status) {
this.status(status == null ? null : status.toString());
return this;
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
public final Builder name(String name) {
this.name = name;
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 ListTaskTemplatesRequest build() {
return new ListTaskTemplatesRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}