software.amazon.awssdk.services.ecs.model.ListTaskDefinitionsRequest Maven / Gradle / Ivy
Show all versions of ecs 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.ecs.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 ListTaskDefinitionsRequest extends EcsRequest implements
ToCopyableBuilder {
private static final SdkField FAMILY_PREFIX_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("familyPrefix").getter(getter(ListTaskDefinitionsRequest::familyPrefix))
.setter(setter(Builder::familyPrefix))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("familyPrefix").build()).build();
private static final SdkField STATUS_FIELD = SdkField. builder(MarshallingType.STRING).memberName("status")
.getter(getter(ListTaskDefinitionsRequest::statusAsString)).setter(setter(Builder::status))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("status").build()).build();
private static final SdkField SORT_FIELD = SdkField. builder(MarshallingType.STRING).memberName("sort")
.getter(getter(ListTaskDefinitionsRequest::sortAsString)).setter(setter(Builder::sort))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("sort").build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("nextToken").getter(getter(ListTaskDefinitionsRequest::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(ListTaskDefinitionsRequest::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(FAMILY_PREFIX_FIELD,
STATUS_FIELD, SORT_FIELD, NEXT_TOKEN_FIELD, MAX_RESULTS_FIELD));
private final String familyPrefix;
private final String status;
private final String sort;
private final String nextToken;
private final Integer maxResults;
private ListTaskDefinitionsRequest(BuilderImpl builder) {
super(builder);
this.familyPrefix = builder.familyPrefix;
this.status = builder.status;
this.sort = builder.sort;
this.nextToken = builder.nextToken;
this.maxResults = builder.maxResults;
}
/**
*
* The full family name to filter the ListTaskDefinitions results with. Specifying a
* familyPrefix limits the listed task definitions to task definition revisions that belong to that
* family.
*
*
* @return The full family name to filter the ListTaskDefinitions results with. Specifying a
* familyPrefix limits the listed task definitions to task definition revisions that belong to
* that family.
*/
public final String familyPrefix() {
return familyPrefix;
}
/**
*
* The task definition status to filter the ListTaskDefinitions results with. By default, only
* ACTIVE task definitions are listed. By setting this parameter to INACTIVE, you can view
* task definitions that are INACTIVE as long as an active task or service still references them. If
* you paginate the resulting output, be sure to keep the status value constant in each subsequent
* request.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link TaskDefinitionStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #statusAsString}.
*
*
* @return The task definition status to filter the ListTaskDefinitions results with. By default, only
* ACTIVE task definitions are listed. By setting this parameter to INACTIVE, you
* can view task definitions that are INACTIVE as long as an active task or service still
* references them. If you paginate the resulting output, be sure to keep the status value
* constant in each subsequent request.
* @see TaskDefinitionStatus
*/
public final TaskDefinitionStatus status() {
return TaskDefinitionStatus.fromValue(status);
}
/**
*
* The task definition status to filter the ListTaskDefinitions results with. By default, only
* ACTIVE task definitions are listed. By setting this parameter to INACTIVE, you can view
* task definitions that are INACTIVE as long as an active task or service still references them. If
* you paginate the resulting output, be sure to keep the status value constant in each subsequent
* request.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link TaskDefinitionStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #statusAsString}.
*
*
* @return The task definition status to filter the ListTaskDefinitions results with. By default, only
* ACTIVE task definitions are listed. By setting this parameter to INACTIVE, you
* can view task definitions that are INACTIVE as long as an active task or service still
* references them. If you paginate the resulting output, be sure to keep the status value
* constant in each subsequent request.
* @see TaskDefinitionStatus
*/
public final String statusAsString() {
return status;
}
/**
*
* The order to sort the results in. Valid values are ASC and DESC. By default, (
* ASC) task definitions are listed lexicographically by family name and in ascending numerical order
* by revision so that the newest task definitions in a family are listed last. Setting this parameter to
* DESC reverses the sort order on family name and revision. This is so that the newest task
* definitions in a family are listed first.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #sort} will return
* {@link SortOrder#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #sortAsString}.
*
*
* @return The order to sort the results in. Valid values are ASC and DESC. By default, (
* ASC) task definitions are listed lexicographically by family name and in ascending numerical
* order by revision so that the newest task definitions in a family are listed last. Setting this parameter
* to DESC reverses the sort order on family name and revision. This is so that the newest task
* definitions in a family are listed first.
* @see SortOrder
*/
public final SortOrder sort() {
return SortOrder.fromValue(sort);
}
/**
*
* The order to sort the results in. Valid values are ASC and DESC. By default, (
* ASC) task definitions are listed lexicographically by family name and in ascending numerical order
* by revision so that the newest task definitions in a family are listed last. Setting this parameter to
* DESC reverses the sort order on family name and revision. This is so that the newest task
* definitions in a family are listed first.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #sort} will return
* {@link SortOrder#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #sortAsString}.
*
*
* @return The order to sort the results in. Valid values are ASC and DESC. By default, (
* ASC) task definitions are listed lexicographically by family name and in ascending numerical
* order by revision so that the newest task definitions in a family are listed last. Setting this parameter
* to DESC reverses the sort order on family name and revision. This is so that the newest task
* definitions in a family are listed first.
* @see SortOrder
*/
public final String sortAsString() {
return sort;
}
/**
*
* The nextToken value returned from a ListTaskDefinitions request indicating that more
* results are available to fulfill the request and further calls will be needed. If maxResults was
* provided, it is possible the number of results to be fewer than maxResults.
*
*
*
* This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and
* not for other programmatic purposes.
*
*
*
* @return The nextToken value returned from a ListTaskDefinitions request indicating that
* more results are available to fulfill the request and further calls will be needed. If
* maxResults was provided, it is possible the number of results to be fewer than
* maxResults.
*
* This token should be treated as an opaque identifier that is only used to retrieve the next items in a
* list and not for other programmatic purposes.
*
*/
public final String nextToken() {
return nextToken;
}
/**
*
* The maximum number of task definition results that ListTaskDefinitions returned in paginated output.
* When this parameter is used, ListTaskDefinitions only returns maxResults results in a
* single page along with a nextToken response element. The remaining results of the initial request
* can be seen by sending another ListTaskDefinitions request with the returned nextToken
* value. This value can be between 1 and 100. If this parameter isn't used, then ListTaskDefinitions
* returns up to 100 results and a nextToken value if applicable.
*
*
* @return The maximum number of task definition results that ListTaskDefinitions returned in paginated
* output. When this parameter is used, ListTaskDefinitions only returns
* maxResults results in a single page along with a nextToken response element.
* The remaining results of the initial request can be seen by sending another
* ListTaskDefinitions request with the returned nextToken value. This value can
* be between 1 and 100. If this parameter isn't used, then ListTaskDefinitions returns up to
* 100 results and a nextToken value if applicable.
*/
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(familyPrefix());
hashCode = 31 * hashCode + Objects.hashCode(statusAsString());
hashCode = 31 * hashCode + Objects.hashCode(sortAsString());
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 ListTaskDefinitionsRequest)) {
return false;
}
ListTaskDefinitionsRequest other = (ListTaskDefinitionsRequest) obj;
return Objects.equals(familyPrefix(), other.familyPrefix()) && Objects.equals(statusAsString(), other.statusAsString())
&& Objects.equals(sortAsString(), other.sortAsString()) && 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("ListTaskDefinitionsRequest").add("FamilyPrefix", familyPrefix()).add("Status", statusAsString())
.add("Sort", sortAsString()).add("NextToken", nextToken()).add("MaxResults", maxResults()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "familyPrefix":
return Optional.ofNullable(clazz.cast(familyPrefix()));
case "status":
return Optional.ofNullable(clazz.cast(statusAsString()));
case "sort":
return Optional.ofNullable(clazz.cast(sortAsString()));
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((ListTaskDefinitionsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends EcsRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The full family name to filter the ListTaskDefinitions results with. Specifying a
* familyPrefix limits the listed task definitions to task definition revisions that belong to that
* family.
*
*
* @param familyPrefix
* The full family name to filter the ListTaskDefinitions results with. Specifying a
* familyPrefix limits the listed task definitions to task definition revisions that belong
* to that family.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder familyPrefix(String familyPrefix);
/**
*
* The task definition status to filter the ListTaskDefinitions results with. By default, only
* ACTIVE task definitions are listed. By setting this parameter to INACTIVE, you can
* view task definitions that are INACTIVE as long as an active task or service still references
* them. If you paginate the resulting output, be sure to keep the status value constant in each
* subsequent request.
*
*
* @param status
* The task definition status to filter the ListTaskDefinitions results with. By default,
* only ACTIVE task definitions are listed. By setting this parameter to
* INACTIVE, you can view task definitions that are INACTIVE as long as an
* active task or service still references them. If you paginate the resulting output, be sure to keep
* the status value constant in each subsequent request.
* @see TaskDefinitionStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see TaskDefinitionStatus
*/
Builder status(String status);
/**
*
* The task definition status to filter the ListTaskDefinitions results with. By default, only
* ACTIVE task definitions are listed. By setting this parameter to INACTIVE, you can
* view task definitions that are INACTIVE as long as an active task or service still references
* them. If you paginate the resulting output, be sure to keep the status value constant in each
* subsequent request.
*
*
* @param status
* The task definition status to filter the ListTaskDefinitions results with. By default,
* only ACTIVE task definitions are listed. By setting this parameter to
* INACTIVE, you can view task definitions that are INACTIVE as long as an
* active task or service still references them. If you paginate the resulting output, be sure to keep
* the status value constant in each subsequent request.
* @see TaskDefinitionStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see TaskDefinitionStatus
*/
Builder status(TaskDefinitionStatus status);
/**
*
* The order to sort the results in. Valid values are ASC and DESC. By default, (
* ASC) task definitions are listed lexicographically by family name and in ascending numerical
* order by revision so that the newest task definitions in a family are listed last. Setting this parameter to
* DESC reverses the sort order on family name and revision. This is so that the newest task
* definitions in a family are listed first.
*
*
* @param sort
* The order to sort the results in. Valid values are ASC and DESC. By default,
* (ASC) task definitions are listed lexicographically by family name and in ascending
* numerical order by revision so that the newest task definitions in a family are listed last. Setting
* this parameter to DESC reverses the sort order on family name and revision. This is so
* that the newest task definitions in a family are listed first.
* @see SortOrder
* @return Returns a reference to this object so that method calls can be chained together.
* @see SortOrder
*/
Builder sort(String sort);
/**
*
* The order to sort the results in. Valid values are ASC and DESC. By default, (
* ASC) task definitions are listed lexicographically by family name and in ascending numerical
* order by revision so that the newest task definitions in a family are listed last. Setting this parameter to
* DESC reverses the sort order on family name and revision. This is so that the newest task
* definitions in a family are listed first.
*
*
* @param sort
* The order to sort the results in. Valid values are ASC and DESC. By default,
* (ASC) task definitions are listed lexicographically by family name and in ascending
* numerical order by revision so that the newest task definitions in a family are listed last. Setting
* this parameter to DESC reverses the sort order on family name and revision. This is so
* that the newest task definitions in a family are listed first.
* @see SortOrder
* @return Returns a reference to this object so that method calls can be chained together.
* @see SortOrder
*/
Builder sort(SortOrder sort);
/**
*
* The nextToken value returned from a ListTaskDefinitions request indicating that
* more results are available to fulfill the request and further calls will be needed. If
* maxResults was provided, it is possible the number of results to be fewer than
* maxResults.
*
*
*
* This token should be treated as an opaque identifier that is only used to retrieve the next items in a list
* and not for other programmatic purposes.
*
*
*
* @param nextToken
* The nextToken value returned from a ListTaskDefinitions request indicating
* that more results are available to fulfill the request and further calls will be needed. If
* maxResults was provided, it is possible the number of results to be fewer than
* maxResults.
*
* This token should be treated as an opaque identifier that is only used to retrieve the next items in a
* list and not for other programmatic purposes.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
/**
*
* The maximum number of task definition results that ListTaskDefinitions returned in paginated
* output. When this parameter is used, ListTaskDefinitions only returns maxResults
* results in a single page along with a nextToken response element. The remaining results of the
* initial request can be seen by sending another ListTaskDefinitions request with the returned
* nextToken value. This value can be between 1 and 100. If this parameter isn't used, then
* ListTaskDefinitions returns up to 100 results and a nextToken value if applicable.
*
*
* @param maxResults
* The maximum number of task definition results that ListTaskDefinitions returned in
* paginated output. When this parameter is used, ListTaskDefinitions only returns
* maxResults results in a single page along with a nextToken response element.
* The remaining results of the initial request can be seen by sending another
* ListTaskDefinitions request with the returned nextToken value. This value
* can be between 1 and 100. If this parameter isn't used, then ListTaskDefinitions returns
* up to 100 results and a nextToken value if applicable.
* @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 EcsRequest.BuilderImpl implements Builder {
private String familyPrefix;
private String status;
private String sort;
private String nextToken;
private Integer maxResults;
private BuilderImpl() {
}
private BuilderImpl(ListTaskDefinitionsRequest model) {
super(model);
familyPrefix(model.familyPrefix);
status(model.status);
sort(model.sort);
nextToken(model.nextToken);
maxResults(model.maxResults);
}
public final String getFamilyPrefix() {
return familyPrefix;
}
public final void setFamilyPrefix(String familyPrefix) {
this.familyPrefix = familyPrefix;
}
@Override
public final Builder familyPrefix(String familyPrefix) {
this.familyPrefix = familyPrefix;
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(TaskDefinitionStatus status) {
this.status(status == null ? null : status.toString());
return this;
}
public final String getSort() {
return sort;
}
public final void setSort(String sort) {
this.sort = sort;
}
@Override
public final Builder sort(String sort) {
this.sort = sort;
return this;
}
@Override
public final Builder sort(SortOrder sort) {
this.sort(sort == null ? null : sort.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 ListTaskDefinitionsRequest build() {
return new ListTaskDefinitionsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}