Package software.amazon.awssdk.services.batch.model

Interface SubmitJobRequest.Builder

    • Method Detail

      • jobName

        SubmitJobRequest.Builder jobName​(String jobName)

        The name of the job. It can be up to 128 letters long. The first character must be alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

        Parameters:
        jobName - The name of the job. It can be up to 128 letters long. The first character must be alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • jobQueue

        SubmitJobRequest.Builder jobQueue​(String jobQueue)

        The job queue where the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.

        Parameters:
        jobQueue - The job queue where the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • shareIdentifier

        SubmitJobRequest.Builder shareIdentifier​(String shareIdentifier)

        The share identifier for the job. Don't specify this parameter if the job queue doesn't have a scheduling policy. If the job queue has a scheduling policy, then this parameter must be specified.

        This string is limited to 255 alphanumeric characters, and can be followed by an asterisk (*).

        Parameters:
        shareIdentifier - The share identifier for the job. Don't specify this parameter if the job queue doesn't have a scheduling policy. If the job queue has a scheduling policy, then this parameter must be specified.

        This string is limited to 255 alphanumeric characters, and can be followed by an asterisk (*).

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

      • schedulingPriorityOverride

        SubmitJobRequest.Builder schedulingPriorityOverride​(Integer schedulingPriorityOverride)

        The scheduling priority for the job. This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority. This overrides any scheduling priority in the job definition and works only within a single share identifier.

        The minimum supported value is 0 and the maximum supported value is 9999.

        Parameters:
        schedulingPriorityOverride - The scheduling priority for the job. This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority. This overrides any scheduling priority in the job definition and works only within a single share identifier.

        The minimum supported value is 0 and the maximum supported value is 9999.

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

      • arrayProperties

        SubmitJobRequest.Builder arrayProperties​(ArrayProperties arrayProperties)

        The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. For more information, see Array Jobs in the Batch User Guide.

        Parameters:
        arrayProperties - The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. For more information, see Array Jobs in the Batch User Guide.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dependsOn

        SubmitJobRequest.Builder dependsOn​(Collection<JobDependency> dependsOn)

        A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.

        Parameters:
        dependsOn - A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dependsOn

        SubmitJobRequest.Builder dependsOn​(JobDependency... dependsOn)

        A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.

        Parameters:
        dependsOn - A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dependsOn

        SubmitJobRequest.Builder dependsOn​(Consumer<JobDependency.Builder>... dependsOn)

        A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.

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

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #dependsOn(List).

        Parameters:
        dependsOn - a consumer that will call methods on JobDependency.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #dependsOn(java.util.Collection)

      • jobDefinition

        SubmitJobRequest.Builder jobDefinition​(String jobDefinition)

        The job definition used by this job. This value can be one of definition-name, definition-name:revision, or the Amazon Resource Name (ARN) for the job definition, with or without the revision ( arn:aws:batch:region:account:job-definition/definition-name:revision , or arn:aws:batch:region:account:job-definition/definition-name ).

        If the revision is not specified, then the latest active revision is used.

        Parameters:
        jobDefinition - The job definition used by this job. This value can be one of definition-name, definition-name:revision, or the Amazon Resource Name (ARN) for the job definition, with or without the revision ( arn:aws:batch:region:account:job-definition/definition-name:revision , or arn:aws:batch:region:account:job-definition/definition-name ).

        If the revision is not specified, then the latest active revision is used.

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

      • parameters

        SubmitJobRequest.Builder parameters​(Map<String,​String> parameters)

        Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.

        Parameters:
        parameters - Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • containerOverrides

        SubmitJobRequest.Builder containerOverrides​(ContainerOverrides containerOverrides)

        An object with various properties that override the defaults for the job definition that specify the name of a container in the specified job definition and the overrides it should receive. You can override the default command for a container, which is specified in the job definition or the Docker image, with a command override. You can also override existing environment variables on a container or add new environment variables to it with an environment override.

        Parameters:
        containerOverrides - An object with various properties that override the defaults for the job definition that specify the name of a container in the specified job definition and the overrides it should receive. You can override the default command for a container, which is specified in the job definition or the Docker image, with a command override. You can also override existing environment variables on a container or add new environment variables to it with an environment override.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • nodeOverrides

        SubmitJobRequest.Builder nodeOverrides​(NodeOverrides nodeOverrides)

        A list of node overrides in JSON format that specify the node range to target and the container overrides for that node range.

        This parameter isn't applicable to jobs that are running on Fargate resources; use containerOverrides instead.

        Parameters:
        nodeOverrides - A list of node overrides in JSON format that specify the node range to target and the container overrides for that node range.

        This parameter isn't applicable to jobs that are running on Fargate resources; use containerOverrides instead.

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

      • retryStrategy

        SubmitJobRequest.Builder retryStrategy​(RetryStrategy retryStrategy)

        The retry strategy to use for failed jobs from this SubmitJob operation. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.

        Parameters:
        retryStrategy - The retry strategy to use for failed jobs from this SubmitJob operation. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • propagateTags

        SubmitJobRequest.Builder propagateTags​(Boolean propagateTags)

        Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state. When specified, this overrides the tag propagation setting in the job definition.

        Parameters:
        propagateTags - Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state. When specified, this overrides the tag propagation setting in the job definition.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • timeout

        SubmitJobRequest.Builder timeout​(JobTimeout timeout)

        The timeout configuration for this SubmitJob operation. You can specify a timeout duration after which Batch terminates your jobs if they haven't finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. This configuration overrides any timeout configuration specified in the job definition. For array jobs, child jobs have the same timeout configuration as the parent job. For more information, see Job Timeouts in the Amazon Elastic Container Service Developer Guide.

        Parameters:
        timeout - The timeout configuration for this SubmitJob operation. You can specify a timeout duration after which Batch terminates your jobs if they haven't finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. This configuration overrides any timeout configuration specified in the job definition. For array jobs, child jobs have the same timeout configuration as the parent job. For more information, see Job Timeouts in the Amazon Elastic Container Service Developer Guide.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • timeout

        default SubmitJobRequest.Builder timeout​(Consumer<JobTimeout.Builder> timeout)

        The timeout configuration for this SubmitJob operation. You can specify a timeout duration after which Batch terminates your jobs if they haven't finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. This configuration overrides any timeout configuration specified in the job definition. For array jobs, child jobs have the same timeout configuration as the parent job. For more information, see Job Timeouts in the Amazon Elastic Container Service Developer Guide.

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

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to timeout(JobTimeout).

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

      • tags

        SubmitJobRequest.Builder tags​(Map<String,​String> tags)

        The tags that you apply to the job request to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Amazon Web Services General Reference.

        Parameters:
        tags - The tags that you apply to the job request to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Amazon Web Services General Reference.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • eksPropertiesOverride

        SubmitJobRequest.Builder eksPropertiesOverride​(EksPropertiesOverride eksPropertiesOverride)

        An object that can only be specified for jobs that are run on Amazon EKS resources with various properties that override defaults for the job definition.

        Parameters:
        eksPropertiesOverride - An object that can only be specified for jobs that are run on Amazon EKS resources with various properties that override defaults for the job definition.
        Returns:
        Returns a reference to this object so that method calls can be chained together.