com.amazonaws.services.ecs.model.ListTasksRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ecs Show documentation
/*
* Copyright 2011-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 ListTasksRequest extends AmazonWebServiceRequest implements
Serializable, Cloneable {
/**
*
* The short name or full Amazon Resource Name (ARN) of the cluster that
* hosts the tasks to list. If you do not specify a cluster, the default
* cluster is assumed..
*
*/
private String cluster;
/**
*
* The container instance ID or full Amazon Resource Name (ARN) of the
* container instance with which to filter the ListTasks
* results. Specifying a containerInstance limits the results
* to tasks that belong to that container instance.
*
*/
private String containerInstance;
/**
*
* The name of the family with which to filter the ListTasks
* results. Specifying a family limits the results to tasks
* that belong to that family.
*
*/
private String family;
/**
*
* The nextToken value returned from a previous paginated
* ListTasks 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.
*
*
*
* 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.
*
*
*/
private String nextToken;
/**
*
* The maximum number of task results returned by ListTasks in
* paginated output. When this parameter is used, ListTasks
* 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 ListTasks
* request with the returned nextToken value. This value can be
* between 1 and 100. If this parameter is not used, then
* ListTasks returns up to 100 results and a
* nextToken value if applicable.
*
*/
private Integer maxResults;
/**
*
* The startedBy value with which to filter the task results.
* Specifying a startedBy value limits the results to tasks
* that were started with that value.
*
*/
private String startedBy;
/**
*
* The name of the service with which to filter the ListTasks
* results. Specifying a serviceName limits the results to
* tasks that belong to that service.
*
*/
private String serviceName;
/**
*
* The task status with which to filter the ListTasks results.
* Specifying a desiredStatus of STOPPED limits
* the results to tasks that are in the STOPPED status, which
* can be useful for debugging tasks that are not starting properly or have
* died or finished. The default status filter is status filter is
* RUNNING, which shows tasks that ECS has set the desired
* status to RUNNING.
*
*
*
* Although you can filter results based on a desired status of
* PENDING, this will not return any results because ECS never
* sets the desired status of a task to that value (only a task's
* lastStatus may have a value of PENDING).
*
*
*/
private String desiredStatus;
/**
*
* The short name or full Amazon Resource Name (ARN) of the cluster that
* hosts the tasks to list. If you do not specify a cluster, the default
* cluster is assumed..
*
*
* @param cluster
* The short name or full Amazon Resource Name (ARN) of the cluster
* that hosts the tasks to list. If you do not specify a cluster, the
* default cluster is assumed..
*/
public void setCluster(String cluster) {
this.cluster = cluster;
}
/**
*
* The short name or full Amazon Resource Name (ARN) of the cluster that
* hosts the tasks to list. If you do not specify a cluster, the default
* cluster is assumed..
*
*
* @return The short name or full Amazon Resource Name (ARN) of the cluster
* that hosts the tasks to list. If you do not specify a cluster,
* the default cluster is assumed..
*/
public String getCluster() {
return this.cluster;
}
/**
*
* The short name or full Amazon Resource Name (ARN) of the cluster that
* hosts the tasks to list. If you do not specify a cluster, the default
* cluster is assumed..
*
*
* @param cluster
* The short name or full Amazon Resource Name (ARN) of the cluster
* that hosts the tasks to list. If you do not specify a cluster, the
* default cluster is assumed..
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public ListTasksRequest withCluster(String cluster) {
setCluster(cluster);
return this;
}
/**
*
* The container instance ID or full Amazon Resource Name (ARN) of the
* container instance with which to filter the ListTasks
* results. Specifying a containerInstance limits the results
* to tasks that belong to that container instance.
*
*
* @param containerInstance
* The container instance ID or full Amazon Resource Name (ARN) of
* the container instance with which to filter the
* ListTasks results. Specifying a
* containerInstance limits the results to tasks that
* belong to that container instance.
*/
public void setContainerInstance(String containerInstance) {
this.containerInstance = containerInstance;
}
/**
*
* The container instance ID or full Amazon Resource Name (ARN) of the
* container instance with which to filter the ListTasks
* results. Specifying a containerInstance limits the results
* to tasks that belong to that container instance.
*
*
* @return The container instance ID or full Amazon Resource Name (ARN) of
* the container instance with which to filter the
* ListTasks results. Specifying a
* containerInstance limits the results to tasks that
* belong to that container instance.
*/
public String getContainerInstance() {
return this.containerInstance;
}
/**
*
* The container instance ID or full Amazon Resource Name (ARN) of the
* container instance with which to filter the ListTasks
* results. Specifying a containerInstance limits the results
* to tasks that belong to that container instance.
*
*
* @param containerInstance
* The container instance ID or full Amazon Resource Name (ARN) of
* the container instance with which to filter the
* ListTasks results. Specifying a
* containerInstance limits the results to tasks that
* belong to that container instance.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public ListTasksRequest withContainerInstance(String containerInstance) {
setContainerInstance(containerInstance);
return this;
}
/**
*
* The name of the family with which to filter the ListTasks
* results. Specifying a family limits the results to tasks
* that belong to that family.
*
*
* @param family
* The name of the family with which to filter the
* ListTasks results. Specifying a family
* limits the results to tasks that belong to that family.
*/
public void setFamily(String family) {
this.family = family;
}
/**
*
* The name of the family with which to filter the ListTasks
* results. Specifying a family limits the results to tasks
* that belong to that family.
*
*
* @return The name of the family with which to filter the
* ListTasks results. Specifying a family
* limits the results to tasks that belong to that family.
*/
public String getFamily() {
return this.family;
}
/**
*
* The name of the family with which to filter the ListTasks
* results. Specifying a family limits the results to tasks
* that belong to that family.
*
*
* @param family
* The name of the family with which to filter the
* ListTasks results. Specifying a family
* limits the results to tasks that belong to that family.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public ListTasksRequest withFamily(String family) {
setFamily(family);
return this;
}
/**
*
* The nextToken value returned from a previous paginated
* ListTasks 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.
*
*
*
* 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 previous
* paginated ListTasks 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.
*
* 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 void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* The nextToken value returned from a previous paginated
* ListTasks 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.
*
*
*
* 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 previous
* paginated ListTasks 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.
*
* 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 String getNextToken() {
return this.nextToken;
}
/**
*
* The nextToken value returned from a previous paginated
* ListTasks 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.
*
*
*
* 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 previous
* paginated ListTasks 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.
*
* 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.
*/
public ListTasksRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* The maximum number of task results returned by ListTasks in
* paginated output. When this parameter is used, ListTasks
* 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 ListTasks
* request with the returned nextToken value. This value can be
* between 1 and 100. If this parameter is not used, then
* ListTasks returns up to 100 results and a
* nextToken value if applicable.
*
*
* @param maxResults
* The maximum number of task results returned by
* ListTasks in paginated output. When this parameter is
* used, ListTasks 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 ListTasks request with the
* returned nextToken value. This value can be between 1
* and 100. If this parameter is not used, then
* ListTasks returns up to 100 results and a
* nextToken value if applicable.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of task results returned by ListTasks in
* paginated output. When this parameter is used, ListTasks
* 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 ListTasks
* request with the returned nextToken value. This value can be
* between 1 and 100. If this parameter is not used, then
* ListTasks returns up to 100 results and a
* nextToken value if applicable.
*
*
* @return The maximum number of task results returned by
* ListTasks in paginated output. When this parameter
* is used, ListTasks 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
* ListTasks request with the returned
* nextToken value. This value can be between 1 and
* 100. If this parameter is not used, then ListTasks
* returns up to 100 results and a nextToken value if
* applicable.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of task results returned by ListTasks in
* paginated output. When this parameter is used, ListTasks
* 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 ListTasks
* request with the returned nextToken value. This value can be
* between 1 and 100. If this parameter is not used, then
* ListTasks returns up to 100 results and a
* nextToken value if applicable.
*
*
* @param maxResults
* The maximum number of task results returned by
* ListTasks in paginated output. When this parameter is
* used, ListTasks 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 ListTasks request with the
* returned nextToken value. This value can be between 1
* and 100. If this parameter is not used, then
* ListTasks 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 ListTasksRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* The startedBy value with which to filter the task results.
* Specifying a startedBy value limits the results to tasks
* that were started with that value.
*
*
* @param startedBy
* The startedBy value with which to filter the task
* results. Specifying a startedBy value limits the
* results to tasks that were started with that value.
*/
public void setStartedBy(String startedBy) {
this.startedBy = startedBy;
}
/**
*
* The startedBy value with which to filter the task results.
* Specifying a startedBy value limits the results to tasks
* that were started with that value.
*
*
* @return The startedBy value with which to filter the task
* results. Specifying a startedBy value limits the
* results to tasks that were started with that value.
*/
public String getStartedBy() {
return this.startedBy;
}
/**
*
* The startedBy value with which to filter the task results.
* Specifying a startedBy value limits the results to tasks
* that were started with that value.
*
*
* @param startedBy
* The startedBy value with which to filter the task
* results. Specifying a startedBy value limits the
* results to tasks that were started with that value.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public ListTasksRequest withStartedBy(String startedBy) {
setStartedBy(startedBy);
return this;
}
/**
*
* The name of the service with which to filter the ListTasks
* results. Specifying a serviceName limits the results to
* tasks that belong to that service.
*
*
* @param serviceName
* The name of the service with which to filter the
* ListTasks results. Specifying a
* serviceName limits the results to tasks that belong
* to that service.
*/
public void setServiceName(String serviceName) {
this.serviceName = serviceName;
}
/**
*
* The name of the service with which to filter the ListTasks
* results. Specifying a serviceName limits the results to
* tasks that belong to that service.
*
*
* @return The name of the service with which to filter the
* ListTasks results. Specifying a
* serviceName limits the results to tasks that belong
* to that service.
*/
public String getServiceName() {
return this.serviceName;
}
/**
*
* The name of the service with which to filter the ListTasks
* results. Specifying a serviceName limits the results to
* tasks that belong to that service.
*
*
* @param serviceName
* The name of the service with which to filter the
* ListTasks results. Specifying a
* serviceName limits the results to tasks that belong
* to that service.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public ListTasksRequest withServiceName(String serviceName) {
setServiceName(serviceName);
return this;
}
/**
*
* The task status with which to filter the ListTasks results.
* Specifying a desiredStatus of STOPPED limits
* the results to tasks that are in the STOPPED status, which
* can be useful for debugging tasks that are not starting properly or have
* died or finished. The default status filter is status filter is
* RUNNING, which shows tasks that ECS has set the desired
* status to RUNNING.
*
*
*
* Although you can filter results based on a desired status of
* PENDING, this will not return any results because ECS never
* sets the desired status of a task to that value (only a task's
* lastStatus may have a value of PENDING).
*
*
*
* @param desiredStatus
* The task status with which to filter the ListTasks
* results. Specifying a desiredStatus of
* STOPPED limits the results to tasks that are in the
* STOPPED status, which can be useful for debugging
* tasks that are not starting properly or have died or finished. The
* default status filter is status filter is RUNNING,
* which shows tasks that ECS has set the desired status to
* RUNNING.
*
* Although you can filter results based on a desired status of
* PENDING, this will not return any results because ECS
* never sets the desired status of a task to that value (only a
* task's lastStatus may have a value of
* PENDING).
*
* @see DesiredStatus
*/
public void setDesiredStatus(String desiredStatus) {
this.desiredStatus = desiredStatus;
}
/**
*
* The task status with which to filter the ListTasks results.
* Specifying a desiredStatus of STOPPED limits
* the results to tasks that are in the STOPPED status, which
* can be useful for debugging tasks that are not starting properly or have
* died or finished. The default status filter is status filter is
* RUNNING, which shows tasks that ECS has set the desired
* status to RUNNING.
*
*
*
* Although you can filter results based on a desired status of
* PENDING, this will not return any results because ECS never
* sets the desired status of a task to that value (only a task's
* lastStatus may have a value of PENDING).
*
*
*
* @return The task status with which to filter the ListTasks
* results. Specifying a desiredStatus of
* STOPPED limits the results to tasks that are in the
* STOPPED status, which can be useful for debugging
* tasks that are not starting properly or have died or finished.
* The default status filter is status filter is
* RUNNING, which shows tasks that ECS has set the
* desired status to RUNNING.
*
* Although you can filter results based on a desired status of
* PENDING, this will not return any results because
* ECS never sets the desired status of a task to that value (only a
* task's lastStatus may have a value of
* PENDING).
*
* @see DesiredStatus
*/
public String getDesiredStatus() {
return this.desiredStatus;
}
/**
*
* The task status with which to filter the ListTasks results.
* Specifying a desiredStatus of STOPPED limits
* the results to tasks that are in the STOPPED status, which
* can be useful for debugging tasks that are not starting properly or have
* died or finished. The default status filter is status filter is
* RUNNING, which shows tasks that ECS has set the desired
* status to RUNNING.
*
*
*
* Although you can filter results based on a desired status of
* PENDING, this will not return any results because ECS never
* sets the desired status of a task to that value (only a task's
* lastStatus may have a value of PENDING).
*
*
*
* @param desiredStatus
* The task status with which to filter the ListTasks
* results. Specifying a desiredStatus of
* STOPPED limits the results to tasks that are in the
* STOPPED status, which can be useful for debugging
* tasks that are not starting properly or have died or finished. The
* default status filter is status filter is RUNNING,
* which shows tasks that ECS has set the desired status to
* RUNNING.
*
* Although you can filter results based on a desired status of
* PENDING, this will not return any results because ECS
* never sets the desired status of a task to that value (only a
* task's lastStatus may have a value of
* PENDING).
*
* @return Returns a reference to this object so that method calls can be
* chained together.
* @see DesiredStatus
*/
public ListTasksRequest withDesiredStatus(String desiredStatus) {
setDesiredStatus(desiredStatus);
return this;
}
/**
*
* The task status with which to filter the ListTasks results.
* Specifying a desiredStatus of STOPPED limits
* the results to tasks that are in the STOPPED status, which
* can be useful for debugging tasks that are not starting properly or have
* died or finished. The default status filter is status filter is
* RUNNING, which shows tasks that ECS has set the desired
* status to RUNNING.
*
*
*
* Although you can filter results based on a desired status of
* PENDING, this will not return any results because ECS never
* sets the desired status of a task to that value (only a task's
* lastStatus may have a value of PENDING).
*
*
*
* @param desiredStatus
* The task status with which to filter the ListTasks
* results. Specifying a desiredStatus of
* STOPPED limits the results to tasks that are in the
* STOPPED status, which can be useful for debugging
* tasks that are not starting properly or have died or finished. The
* default status filter is status filter is RUNNING,
* which shows tasks that ECS has set the desired status to
* RUNNING.
*
* Although you can filter results based on a desired status of
* PENDING, this will not return any results because ECS
* never sets the desired status of a task to that value (only a
* task's lastStatus may have a value of
* PENDING).
*
* @see DesiredStatus
*/
public void setDesiredStatus(DesiredStatus desiredStatus) {
this.desiredStatus = desiredStatus.toString();
}
/**
*
* The task status with which to filter the ListTasks results.
* Specifying a desiredStatus of STOPPED limits
* the results to tasks that are in the STOPPED status, which
* can be useful for debugging tasks that are not starting properly or have
* died or finished. The default status filter is status filter is
* RUNNING, which shows tasks that ECS has set the desired
* status to RUNNING.
*
*
*
* Although you can filter results based on a desired status of
* PENDING, this will not return any results because ECS never
* sets the desired status of a task to that value (only a task's
* lastStatus may have a value of PENDING).
*
*
*
* @param desiredStatus
* The task status with which to filter the ListTasks
* results. Specifying a desiredStatus of
* STOPPED limits the results to tasks that are in the
* STOPPED status, which can be useful for debugging
* tasks that are not starting properly or have died or finished. The
* default status filter is status filter is RUNNING,
* which shows tasks that ECS has set the desired status to
* RUNNING.
*
* Although you can filter results based on a desired status of
* PENDING, this will not return any results because ECS
* never sets the desired status of a task to that value (only a
* task's lastStatus may have a value of
* PENDING).
*
* @return Returns a reference to this object so that method calls can be
* chained together.
* @see DesiredStatus
*/
public ListTasksRequest withDesiredStatus(DesiredStatus desiredStatus) {
setDesiredStatus(desiredStatus);
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 (getCluster() != null)
sb.append("Cluster: " + getCluster() + ",");
if (getContainerInstance() != null)
sb.append("ContainerInstance: " + getContainerInstance() + ",");
if (getFamily() != null)
sb.append("Family: " + getFamily() + ",");
if (getNextToken() != null)
sb.append("NextToken: " + getNextToken() + ",");
if (getMaxResults() != null)
sb.append("MaxResults: " + getMaxResults() + ",");
if (getStartedBy() != null)
sb.append("StartedBy: " + getStartedBy() + ",");
if (getServiceName() != null)
sb.append("ServiceName: " + getServiceName() + ",");
if (getDesiredStatus() != null)
sb.append("DesiredStatus: " + getDesiredStatus());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ListTasksRequest == false)
return false;
ListTasksRequest other = (ListTasksRequest) obj;
if (other.getCluster() == null ^ this.getCluster() == null)
return false;
if (other.getCluster() != null
&& other.getCluster().equals(this.getCluster()) == false)
return false;
if (other.getContainerInstance() == null
^ this.getContainerInstance() == null)
return false;
if (other.getContainerInstance() != null
&& other.getContainerInstance().equals(
this.getContainerInstance()) == false)
return false;
if (other.getFamily() == null ^ this.getFamily() == null)
return false;
if (other.getFamily() != null
&& other.getFamily().equals(this.getFamily()) == 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;
if (other.getStartedBy() == null ^ this.getStartedBy() == null)
return false;
if (other.getStartedBy() != null
&& other.getStartedBy().equals(this.getStartedBy()) == false)
return false;
if (other.getServiceName() == null ^ this.getServiceName() == null)
return false;
if (other.getServiceName() != null
&& other.getServiceName().equals(this.getServiceName()) == false)
return false;
if (other.getDesiredStatus() == null ^ this.getDesiredStatus() == null)
return false;
if (other.getDesiredStatus() != null
&& other.getDesiredStatus().equals(this.getDesiredStatus()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode
+ ((getCluster() == null) ? 0 : getCluster().hashCode());
hashCode = prime
* hashCode
+ ((getContainerInstance() == null) ? 0
: getContainerInstance().hashCode());
hashCode = prime * hashCode
+ ((getFamily() == null) ? 0 : getFamily().hashCode());
hashCode = prime * hashCode
+ ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode
+ ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode
+ ((getStartedBy() == null) ? 0 : getStartedBy().hashCode());
hashCode = prime
* hashCode
+ ((getServiceName() == null) ? 0 : getServiceName().hashCode());
hashCode = prime
* hashCode
+ ((getDesiredStatus() == null) ? 0 : getDesiredStatus()
.hashCode());
return hashCode;
}
@Override
public ListTasksRequest clone() {
return (ListTasksRequest) super.clone();
}
}