Class ListTasksRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.ecs.model.ListTasksRequest
All Implemented Interfaces:
ReadLimitInfo, Serializable, Cloneable

public class ListTasksRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
See Also:
  • Constructor Details

    • ListTasksRequest

      public ListTasksRequest()
  • Method Details

    • setCluster

      public void setCluster(String 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..

      Parameters:
      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..
    • getCluster

      public String getCluster()

      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..

      Returns:
      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..
    • withCluster

      public ListTasksRequest withCluster(String 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..

      Parameters:
      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..
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setContainerInstance

      public void setContainerInstance(String 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.

      Parameters:
      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.
    • getContainerInstance

      public String getContainerInstance()

      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.

      Returns:
      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.
    • withContainerInstance

      public ListTasksRequest withContainerInstance(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setFamily

      public void setFamily(String 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.

      Parameters:
      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.
    • getFamily

      public String getFamily()

      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.

      Returns:
      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.
    • withFamily

      public ListTasksRequest withFamily(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setNextToken

      public void setNextToken(String 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.

      Parameters:
      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.

    • getNextToken

      public String getNextToken()

      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.

      Returns:
      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.

    • withNextToken

      public ListTasksRequest withNextToken(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setMaxResults

      public void setMaxResults(Integer 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.

      Parameters:
      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.
    • getMaxResults

      public Integer getMaxResults()

      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.

      Returns:
      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.
    • withMaxResults

      public ListTasksRequest withMaxResults(Integer 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setStartedBy

      public void setStartedBy(String 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.

      Parameters:
      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.
    • getStartedBy

      public String getStartedBy()

      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.

      Returns:
      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.
    • withStartedBy

      public ListTasksRequest withStartedBy(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setServiceName

      public void setServiceName(String 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.

      Parameters:
      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.
    • getServiceName

      public String getServiceName()

      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.

      Returns:
      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.
    • withServiceName

      public ListTasksRequest withServiceName(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setDesiredStatus

      public void setDesiredStatus(String 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 RUNNING.

      Parameters:
      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 RUNNING.
      See Also:
    • getDesiredStatus

      public String getDesiredStatus()

      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 RUNNING.

      Returns:
      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 RUNNING.
      See Also:
    • withDesiredStatus

      public ListTasksRequest withDesiredStatus(String 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 RUNNING.

      Parameters:
      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 RUNNING.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • setDesiredStatus

      public void setDesiredStatus(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 RUNNING.

      Parameters:
      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 RUNNING.
      See Also:
    • withDesiredStatus

      public ListTasksRequest withDesiredStatus(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 RUNNING.

      Parameters:
      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 RUNNING.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • toString

      public String toString()
      Returns a string representation of this object; useful for testing and debugging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object.
      See Also:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public ListTasksRequest clone()
      Description copied from class: AmazonWebServiceRequest
      Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.
      Overrides:
      clone in class AmazonWebServiceRequest
      See Also: