Interface ListServiceJobsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, BatchRequest.Builder, Buildable, CopyableBuilder<ListServiceJobsRequest.Builder,ListServiceJobsRequest>, SdkBuilder<ListServiceJobsRequest.Builder,ListServiceJobsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
ListServiceJobsRequest
@Mutable @NotThreadSafe public static interface ListServiceJobsRequest.Builder extends BatchRequest.Builder, SdkPojo, CopyableBuilder<ListServiceJobsRequest.Builder,ListServiceJobsRequest>

  • Method Details

    • jobQueue

      ListServiceJobsRequest.Builder jobQueue(String jobQueue)

      The name or ARN of the job queue with which to list service jobs.

      Parameters:
      jobQueue - The name or ARN of the job queue with which to list service jobs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • jobStatus

      ListServiceJobsRequest.Builder jobStatus(String jobStatus)

      The job status with which to filter service jobs.

      Parameters:
      jobStatus - The job status with which to filter service jobs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • jobStatus

      ListServiceJobsRequest.Builder jobStatus(ServiceJobStatus jobStatus)

      The job status with which to filter service jobs.

      Parameters:
      jobStatus - The job status with which to filter service jobs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maxResults

      ListServiceJobsRequest.Builder maxResults(Integer maxResults)

      The maximum number of results returned by ListServiceJobs in paginated output. When this parameter is used, ListServiceJobs only returns maxResults results in a single page and a nextToken response element. The remaining results of the initial request can be seen by sending another ListServiceJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListServiceJobs returns up to 100 results and a nextToken value if applicable.

      Parameters:
      maxResults - The maximum number of results returned by ListServiceJobs in paginated output. When this parameter is used, ListServiceJobs only returns maxResults results in a single page and a nextToken response element. The remaining results of the initial request can be seen by sending another ListServiceJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListServiceJobs 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.

    • nextToken

      ListServiceJobsRequest.Builder nextToken(String nextToken)

      The nextToken value returned from a previous paginated ListServiceJobs 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.

      Treat this token as an opaque identifier that's 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 ListServiceJobs 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.

      Treat this token as an opaque identifier that's 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.

    • filters

      ListServiceJobsRequest.Builder filters(Collection<KeyValuesPair> filters)

      The filters to apply to the service job list query. The filter names and values can be:

      • name: JOB_STATUS

        values: SUBMITTED | PENDING | RUNNABLE | STARTING | RUNNING | SUCCEEDED | FAILED | SCHEDULED

      • name: JOB_NAME

        values: case-insensitive matches for the job name. If a filter value ends with an asterisk (*), it matches any job name that begins with the string before the '*'.

      Parameters:
      filters - The filters to apply to the service job list query. The filter names and values can be:

      • name: JOB_STATUS

        values: SUBMITTED | PENDING | RUNNABLE | STARTING | RUNNING | SUCCEEDED | FAILED | SCHEDULED

      • name: JOB_NAME

        values: case-insensitive matches for the job name. If a filter value ends with an asterisk (*), it matches any job name that begins with the string before the '*'.

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

    • filters

      ListServiceJobsRequest.Builder filters(KeyValuesPair... filters)

      The filters to apply to the service job list query. The filter names and values can be:

      • name: JOB_STATUS

        values: SUBMITTED | PENDING | RUNNABLE | STARTING | RUNNING | SUCCEEDED | FAILED | SCHEDULED

      • name: JOB_NAME

        values: case-insensitive matches for the job name. If a filter value ends with an asterisk (*), it matches any job name that begins with the string before the '*'.

      Parameters:
      filters - The filters to apply to the service job list query. The filter names and values can be:

      • name: JOB_STATUS

        values: SUBMITTED | PENDING | RUNNABLE | STARTING | RUNNING | SUCCEEDED | FAILED | SCHEDULED

      • name: JOB_NAME

        values: case-insensitive matches for the job name. If a filter value ends with an asterisk (*), it matches any job name that begins with the string before the '*'.

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

    • filters

      ListServiceJobsRequest.Builder filters(Consumer<KeyValuesPair.Builder>... filters)

      The filters to apply to the service job list query. The filter names and values can be:

      • name: JOB_STATUS

        values: SUBMITTED | PENDING | RUNNABLE | STARTING | RUNNING | SUCCEEDED | FAILED | SCHEDULED

      • name: JOB_NAME

        values: case-insensitive matches for the job name. If a filter value ends with an asterisk (*), it matches any job name that begins with the string before the '*'.

      This is a convenience method that creates an instance of the KeyValuesPair.Builder avoiding the need to create one manually via KeyValuesPair.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filters(List<KeyValuesPair>).

      Parameters:
      filters - a consumer that will call methods on KeyValuesPair.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      ListServiceJobsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      ListServiceJobsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.