com.amazonaws.services.ecs.model.ListTaskDefinitionsRequest Maven / Gradle / Ivy
/*
* Copyright 2010-2016 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 com.amazonaws.services.ecs.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
*/
public class ListTaskDefinitionsRequest extends AmazonWebServiceRequest
implements Serializable, Cloneable {
/**
*
* The full family name with which to filter the
* ListTaskDefinitions results. Specifying a
* familyPrefix limits the listed task definitions to task
* definition revisions that belong to that family.
*
*/
private String familyPrefix;
/**
*
* The task definition status with which to filter the
* ListTaskDefinitions results. 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.
*
*/
private String status;
/**
*
* The order in which to sort the results. 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 so that the newest task
* definitions in a family are listed first.
*
*/
private String sort;
/**
*
* The nextToken value returned from a previous paginated
* ListTaskDefinitions request where maxResults
* was used and the results exceeded the value of that parameter. Pagination
* continues from the end of the previous results that returned the
* nextToken value. This value is null when there
* are no more results to return.
*
*/
private String nextToken;
/**
*
* The maximum number of task definition results returned by
* ListTaskDefinitions 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 is not used, then ListTaskDefinitions returns
* up to 100 results and a nextToken value if applicable.
*
*/
private Integer maxResults;
/**
*
* The full family name with which to filter the
* ListTaskDefinitions results. Specifying a
* familyPrefix limits the listed task definitions to task
* definition revisions that belong to that family.
*
*
* @param familyPrefix
* The full family name with which to filter the
* ListTaskDefinitions results. Specifying a
* familyPrefix limits the listed task definitions to
* task definition revisions that belong to that family.
*/
public void setFamilyPrefix(String familyPrefix) {
this.familyPrefix = familyPrefix;
}
/**
*
* The full family name with which to filter the
* ListTaskDefinitions results. Specifying a
* familyPrefix limits the listed task definitions to task
* definition revisions that belong to that family.
*
*
* @return The full family name with which to filter the
* ListTaskDefinitions results. Specifying a
* familyPrefix limits the listed task definitions to
* task definition revisions that belong to that family.
*/
public String getFamilyPrefix() {
return this.familyPrefix;
}
/**
*
* The full family name with which to filter the
* ListTaskDefinitions results. Specifying a
* familyPrefix limits the listed task definitions to task
* definition revisions that belong to that family.
*
*
* @param familyPrefix
* The full family name with which to filter the
* ListTaskDefinitions results. 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.
*/
public ListTaskDefinitionsRequest withFamilyPrefix(String familyPrefix) {
setFamilyPrefix(familyPrefix);
return this;
}
/**
*
* The task definition status with which to filter the
* ListTaskDefinitions results. 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 with which to filter the
* ListTaskDefinitions results. 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 void setStatus(String status) {
this.status = status;
}
/**
*
* The task definition status with which to filter the
* ListTaskDefinitions results. 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.
*
*
* @return The task definition status with which to filter the
* ListTaskDefinitions results. 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 String getStatus() {
return this.status;
}
/**
*
* The task definition status with which to filter the
* ListTaskDefinitions results. 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 with which to filter the
* ListTaskDefinitions results. 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.
* @return Returns a reference to this object so that method calls can be
* chained together.
* @see TaskDefinitionStatus
*/
public ListTaskDefinitionsRequest withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* The task definition status with which to filter the
* ListTaskDefinitions results. 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 with which to filter the
* ListTaskDefinitions results. 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 void setStatus(TaskDefinitionStatus status) {
this.status = status.toString();
}
/**
*
* The task definition status with which to filter the
* ListTaskDefinitions results. 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 with which to filter the
* ListTaskDefinitions results. 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.
* @return Returns a reference to this object so that method calls can be
* chained together.
* @see TaskDefinitionStatus
*/
public ListTaskDefinitionsRequest withStatus(TaskDefinitionStatus status) {
setStatus(status);
return this;
}
/**
*
* The order in which to sort the results. 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 so that the newest task
* definitions in a family are listed first.
*
*
* @param sort
* The order in which to sort the results. 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 so that the newest task
* definitions in a family are listed first.
* @see SortOrder
*/
public void setSort(String sort) {
this.sort = sort;
}
/**
*
* The order in which to sort the results. 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 so that the newest task
* definitions in a family are listed first.
*
*
* @return The order in which to sort the results. 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 so that the newest task
* definitions in a family are listed first.
* @see SortOrder
*/
public String getSort() {
return this.sort;
}
/**
*
* The order in which to sort the results. 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 so that the newest task
* definitions in a family are listed first.
*
*
* @param sort
* The order in which to sort the results. 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 so that the newest task
* definitions in a family are listed first.
* @return Returns a reference to this object so that method calls can be
* chained together.
* @see SortOrder
*/
public ListTaskDefinitionsRequest withSort(String sort) {
setSort(sort);
return this;
}
/**
*
* The order in which to sort the results. 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 so that the newest task
* definitions in a family are listed first.
*
*
* @param sort
* The order in which to sort the results. 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 so that the newest task
* definitions in a family are listed first.
* @see SortOrder
*/
public void setSort(SortOrder sort) {
this.sort = sort.toString();
}
/**
*
* The order in which to sort the results. 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 so that the newest task
* definitions in a family are listed first.
*
*
* @param sort
* The order in which to sort the results. 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 so that the newest task
* definitions in a family are listed first.
* @return Returns a reference to this object so that method calls can be
* chained together.
* @see SortOrder
*/
public ListTaskDefinitionsRequest withSort(SortOrder sort) {
setSort(sort);
return this;
}
/**
*
* The nextToken value returned from a previous paginated
* ListTaskDefinitions request where maxResults
* was used and the results exceeded the value of that parameter. Pagination
* continues from the end of the previous results that returned the
* nextToken value. This value is null when there
* are no more results to return.
*
*
* @param nextToken
* The nextToken value returned from a previous
* paginated ListTaskDefinitions request where
* maxResults was used and the results exceeded the
* value of that parameter. Pagination continues from the end of the
* previous results that returned the nextToken value.
* This value is null when there are no more results to
* return.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* The nextToken value returned from a previous paginated
* ListTaskDefinitions request where maxResults
* was used and the results exceeded the value of that parameter. Pagination
* continues from the end of the previous results that returned the
* nextToken value. This value is null when there
* are no more results to return.
*
*
* @return The nextToken value returned from a previous
* paginated ListTaskDefinitions request where
* maxResults was used and the results exceeded the
* value of that parameter. Pagination continues from the end of the
* previous results that returned the nextToken value.
* This value is null when there are no more results to
* return.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* The nextToken value returned from a previous paginated
* ListTaskDefinitions request where maxResults
* was used and the results exceeded the value of that parameter. Pagination
* continues from the end of the previous results that returned the
* nextToken value. This value is null when there
* are no more results to return.
*
*
* @param nextToken
* The nextToken value returned from a previous
* paginated ListTaskDefinitions request where
* maxResults was used and the results exceeded the
* value of that parameter. Pagination continues from the end of the
* previous results that returned the nextToken value.
* This value is null when there are no more results to
* return.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public ListTaskDefinitionsRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* The maximum number of task definition results returned by
* ListTaskDefinitions 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 is not used, then ListTaskDefinitions returns
* up to 100 results and a nextToken value if applicable.
*
*
* @param maxResults
* The maximum number of task definition results returned by
* ListTaskDefinitions 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 is not used, then
* ListTaskDefinitions returns up to 100 results and a
* nextToken value if applicable.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of task definition results returned by
* ListTaskDefinitions 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 is not used, then ListTaskDefinitions returns
* up to 100 results and a nextToken value if applicable.
*
*
* @return The maximum number of task definition results returned by
* ListTaskDefinitions 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 is not used, then
* ListTaskDefinitions returns up to 100 results and a
* nextToken value if applicable.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of task definition results returned by
* ListTaskDefinitions 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 is not used, then ListTaskDefinitions returns
* up to 100 results and a nextToken value if applicable.
*
*
* @param maxResults
* The maximum number of task definition results returned by
* ListTaskDefinitions 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 is not 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.
*/
public ListTaskDefinitionsRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getFamilyPrefix() != null)
sb.append("FamilyPrefix: " + getFamilyPrefix() + ",");
if (getStatus() != null)
sb.append("Status: " + getStatus() + ",");
if (getSort() != null)
sb.append("Sort: " + getSort() + ",");
if (getNextToken() != null)
sb.append("NextToken: " + getNextToken() + ",");
if (getMaxResults() != null)
sb.append("MaxResults: " + getMaxResults());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ListTaskDefinitionsRequest == false)
return false;
ListTaskDefinitionsRequest other = (ListTaskDefinitionsRequest) obj;
if (other.getFamilyPrefix() == null ^ this.getFamilyPrefix() == null)
return false;
if (other.getFamilyPrefix() != null
&& other.getFamilyPrefix().equals(this.getFamilyPrefix()) == false)
return false;
if (other.getStatus() == null ^ this.getStatus() == null)
return false;
if (other.getStatus() != null
&& other.getStatus().equals(this.getStatus()) == false)
return false;
if (other.getSort() == null ^ this.getSort() == null)
return false;
if (other.getSort() != null
&& other.getSort().equals(this.getSort()) == false)
return false;
if (other.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null
&& other.getNextToken().equals(this.getNextToken()) == false)
return false;
if (other.getMaxResults() == null ^ this.getMaxResults() == null)
return false;
if (other.getMaxResults() != null
&& other.getMaxResults().equals(this.getMaxResults()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime
* hashCode
+ ((getFamilyPrefix() == null) ? 0 : getFamilyPrefix()
.hashCode());
hashCode = prime * hashCode
+ ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode
+ ((getSort() == null) ? 0 : getSort().hashCode());
hashCode = prime * hashCode
+ ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode
+ ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
return hashCode;
}
@Override
public ListTaskDefinitionsRequest clone() {
return (ListTaskDefinitionsRequest) super.clone();
}
}