Package software.amazon.awssdk.services.ecs.model

Interface ListTasksRequest.Builder

    • Method Detail

      • cluster

        ListTasksRequest.Builder cluster​(String cluster)

        The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the ListTasks results. 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 to use when filtering the ListTasks results. 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.

      • containerInstance

        ListTasksRequest.Builder containerInstance​(String containerInstance)

        The container instance ID or full ARN of the container instance to use when filtering 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 ARN of the container instance to use when filtering 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.

      • family

        ListTasksRequest.Builder family​(String family)

        The name of the task definition family to use when filtering the ListTasks results. Specifying a family limits the results to tasks that belong to that family.

        Parameters:
        family - The name of the task definition family to use when filtering 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.

      • nextToken

        ListTasksRequest.Builder nextToken​(String nextToken)

        The nextToken value returned from a ListTasks request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it's 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.

        Parameters:
        nextToken - The nextToken value returned from a ListTasks request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it's 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.

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

      • maxResults

        ListTasksRequest.Builder maxResults​(Integer maxResults)

        The maximum number of task results that ListTasks returned 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 isn't used, then ListTasks returns up to 100 results and a nextToken value if applicable.

        Parameters:
        maxResults - The maximum number of task results that ListTasks returned 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 isn't 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.

      • startedBy

        ListTasksRequest.Builder startedBy​(String startedBy)

        The startedBy value to filter the task results with. Specifying a startedBy value limits the results to tasks that were started with that value.

        When you specify startedBy as the filter, it must be the only filter that you use.

        Parameters:
        startedBy - The startedBy value to filter the task results with. Specifying a startedBy value limits the results to tasks that were started with that value.

        When you specify startedBy as the filter, it must be the only filter that you use.

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

      • serviceName

        ListTasksRequest.Builder serviceName​(String serviceName)

        The name of the service to use when filtering the ListTasks results. Specifying a serviceName limits the results to tasks that belong to that service.

        Parameters:
        serviceName - The name of the service to use when filtering 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.

      • desiredStatus

        ListTasksRequest.Builder desiredStatus​(String desiredStatus)

        The task desired status to use when filtering the ListTasks results. Specifying a desiredStatus of STOPPED limits the results to tasks that Amazon ECS has set the desired status to STOPPED. This can be useful for debugging tasks that aren't starting properly or have died or finished. The default status filter is RUNNING, which shows tasks that Amazon ECS has set the desired status to RUNNING.

        Although you can filter results based on a desired status of PENDING, this doesn't return any results. Amazon ECS never sets the desired status of a task to that value (only a task's lastStatus may have a value of PENDING).

        Parameters:
        desiredStatus - The task desired status to use when filtering the ListTasks results. Specifying a desiredStatus of STOPPED limits the results to tasks that Amazon ECS has set the desired status to STOPPED. This can be useful for debugging tasks that aren't starting properly or have died or finished. The default status filter is RUNNING, which shows tasks that Amazon ECS has set the desired status to RUNNING.

        Although you can filter results based on a desired status of PENDING, this doesn't return any results. Amazon ECS never sets the desired status of a task to that value (only a task's lastStatus may have a value of PENDING).

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DesiredStatus, DesiredStatus

      • desiredStatus

        ListTasksRequest.Builder desiredStatus​(DesiredStatus desiredStatus)

        The task desired status to use when filtering the ListTasks results. Specifying a desiredStatus of STOPPED limits the results to tasks that Amazon ECS has set the desired status to STOPPED. This can be useful for debugging tasks that aren't starting properly or have died or finished. The default status filter is RUNNING, which shows tasks that Amazon ECS has set the desired status to RUNNING.

        Although you can filter results based on a desired status of PENDING, this doesn't return any results. Amazon ECS never sets the desired status of a task to that value (only a task's lastStatus may have a value of PENDING).

        Parameters:
        desiredStatus - The task desired status to use when filtering the ListTasks results. Specifying a desiredStatus of STOPPED limits the results to tasks that Amazon ECS has set the desired status to STOPPED. This can be useful for debugging tasks that aren't starting properly or have died or finished. The default status filter is RUNNING, which shows tasks that Amazon ECS has set the desired status to RUNNING.

        Although you can filter results based on a desired status of PENDING, this doesn't return any results. Amazon ECS never sets the desired status of a task to that value (only a task's lastStatus may have a value of PENDING).

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DesiredStatus, DesiredStatus

      • launchType

        ListTasksRequest.Builder launchType​(String launchType)

        The launch type to use when filtering the ListTasks results.

        Parameters:
        launchType - The launch type to use when filtering the ListTasks results.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        LaunchType, LaunchType

      • launchType

        ListTasksRequest.Builder launchType​(LaunchType launchType)

        The launch type to use when filtering the ListTasks results.

        Parameters:
        launchType - The launch type to use when filtering the ListTasks results.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        LaunchType, LaunchType