Interface ListJobsByConsumableResourceRequest.Builder

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

  • Method Details

    • consumableResource

      ListJobsByConsumableResourceRequest.Builder consumableResource(String consumableResource)

      The name or ARN of the consumable resource.

      Parameters:
      consumableResource - The name or ARN of the consumable resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      ListJobsByConsumableResourceRequest.Builder filters(Collection<KeyValuesPair> filters)

      The filters to apply to the job list query. If used, only those jobs requiring the specified consumable resource (consumableResource) and that match the value of the filters are listed. The filter names and values can be:

      • name: JOB_STATUS

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

      • name: JOB_NAME

        The values are 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 job list query. If used, only those jobs requiring the specified consumable resource (consumableResource) and that match the value of the filters are listed. The filter names and values can be:

      • name: JOB_STATUS

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

      • name: JOB_NAME

        The values are 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

      ListJobsByConsumableResourceRequest.Builder filters(KeyValuesPair... filters)

      The filters to apply to the job list query. If used, only those jobs requiring the specified consumable resource (consumableResource) and that match the value of the filters are listed. The filter names and values can be:

      • name: JOB_STATUS

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

      • name: JOB_NAME

        The values are 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 job list query. If used, only those jobs requiring the specified consumable resource (consumableResource) and that match the value of the filters are listed. The filter names and values can be:

      • name: JOB_STATUS

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

      • name: JOB_NAME

        The values are 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

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

      The filters to apply to the job list query. If used, only those jobs requiring the specified consumable resource (consumableResource) and that match the value of the filters are listed. The filter names and values can be:

      • name: JOB_STATUS

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

      • name: JOB_NAME

        The values are 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:

    • maxResults

      ListJobsByConsumableResourceRequest.Builder maxResults(Integer maxResults)

      The maximum number of results returned by ListJobsByConsumableResource in paginated output. When this parameter is used, ListJobsByConsumableResource 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 ListJobsByConsumableResource request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListJobsByConsumableResource returns up to 100 results and a nextToken value if applicable.

      Parameters:
      maxResults - The maximum number of results returned by ListJobsByConsumableResource in paginated output. When this parameter is used, ListJobsByConsumableResource 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 ListJobsByConsumableResource request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListJobsByConsumableResource 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

      ListJobsByConsumableResourceRequest.Builder nextToken(String nextToken)

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

    • overrideConfiguration

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

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