Interface DescribeJobDefinitionsRequest.Builder

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

  • Method Details

    • jobDefinitions

      DescribeJobDefinitionsRequest.Builder jobDefinitions(Collection<String> jobDefinitions)

      A list of up to 100 job definitions. Each entry in the list can either be an ARN in the format arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision} or a short version using the form ${JobDefinitionName}:${Revision}. This parameter can't be used with other parameters.

      Parameters:
      jobDefinitions - A list of up to 100 job definitions. Each entry in the list can either be an ARN in the format arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision} or a short version using the form ${JobDefinitionName}:${Revision}. This parameter can't be used with other parameters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • jobDefinitions

      DescribeJobDefinitionsRequest.Builder jobDefinitions(String... jobDefinitions)

      A list of up to 100 job definitions. Each entry in the list can either be an ARN in the format arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision} or a short version using the form ${JobDefinitionName}:${Revision}. This parameter can't be used with other parameters.

      Parameters:
      jobDefinitions - A list of up to 100 job definitions. Each entry in the list can either be an ARN in the format arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision} or a short version using the form ${JobDefinitionName}:${Revision}. This parameter can't be used with other parameters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      DescribeJobDefinitionsRequest.Builder maxResults(Integer maxResults)

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

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

    • jobDefinitionName

      DescribeJobDefinitionsRequest.Builder jobDefinitionName(String jobDefinitionName)

      The name of the job definition to describe.

      Parameters:
      jobDefinitionName - The name of the job definition to describe.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      DescribeJobDefinitionsRequest.Builder status(String status)

      The status used to filter job definitions.

      Parameters:
      status - The status used to filter job definitions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      DescribeJobDefinitionsRequest.Builder nextToken(String nextToken)

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

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

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