JobDetail.Builder (AWS Java SDK :: Services

All Superinterfaces:

Buildable, CopyableBuilder<JobDetail.Builder,JobDetail>, SdkBuilder<JobDetail.Builder,JobDetail>, SdkPojo

Enclosing class:

JobDetail
```
public static interface JobDetail.Builder
extends SdkPojo, CopyableBuilder<JobDetail.Builder,JobDetail>
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`JobDetail.Builder`	`arrayProperties(ArrayPropertiesDetail arrayProperties)` The array properties of the job, if it is an array job.
`default JobDetail.Builder`	`arrayProperties(Consumer<ArrayPropertiesDetail.Builder> arrayProperties)` The array properties of the job, if it is an array job.
`JobDetail.Builder`	`attempts(AttemptDetail... attempts)` A list of job attempts associated with this job.
`JobDetail.Builder`	`attempts(Collection<AttemptDetail> attempts)` A list of job attempts associated with this job.
`JobDetail.Builder`	`attempts(Consumer<AttemptDetail.Builder>... attempts)` A list of job attempts associated with this job.
`default JobDetail.Builder`	`container(Consumer<ContainerDetail.Builder> container)` An object representing the details of the container that's associated with the job.
`JobDetail.Builder`	`container(ContainerDetail container)` An object representing the details of the container that's associated with the job.
`JobDetail.Builder`	`createdAt(Long createdAt)` The Unix timestamp (in milliseconds) for when the job was created.
`JobDetail.Builder`	`dependsOn(Collection<JobDependency> dependsOn)` A list of job IDs that this job depends on.
`JobDetail.Builder`	`dependsOn(Consumer<JobDependency.Builder>... dependsOn)` A list of job IDs that this job depends on.
`JobDetail.Builder`	`dependsOn(JobDependency... dependsOn)` A list of job IDs that this job depends on.
`JobDetail.Builder`	`jobArn(String jobArn)` The Amazon Resource Name (ARN) of the job.
`JobDetail.Builder`	`jobDefinition(String jobDefinition)` The Amazon Resource Name (ARN) of the job definition that's used by this job.
`JobDetail.Builder`	`jobId(String jobId)` The ID for the job.
`JobDetail.Builder`	`jobName(String jobName)` The name of the job.
`JobDetail.Builder`	`jobQueue(String jobQueue)` The Amazon Resource Name (ARN) of the job queue that the job is associated with.
`default JobDetail.Builder`	`nodeDetails(Consumer<NodeDetails.Builder> nodeDetails)` An object representing the details of a node that's associated with a multi-node parallel job.
`JobDetail.Builder`	`nodeDetails(NodeDetails nodeDetails)` An object representing the details of a node that's associated with a multi-node parallel job.
`default JobDetail.Builder`	`nodeProperties(Consumer<NodeProperties.Builder> nodeProperties)` An object representing the node properties of a multi-node parallel job.
`JobDetail.Builder`	`nodeProperties(NodeProperties nodeProperties)` An object representing the node properties of a multi-node parallel job.
`JobDetail.Builder`	`parameters(Map<String,String> parameters)` Additional parameters passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.
`JobDetail.Builder`	`platformCapabilities(Collection<PlatformCapability> platformCapabilities)` The platform capabilities required by the job definition.
`JobDetail.Builder`	`platformCapabilities(PlatformCapability... platformCapabilities)` The platform capabilities required by the job definition.
`JobDetail.Builder`	`platformCapabilitiesWithStrings(Collection<String> platformCapabilities)` The platform capabilities required by the job definition.
`JobDetail.Builder`	`platformCapabilitiesWithStrings(String... platformCapabilities)` The platform capabilities required by the job definition.
`JobDetail.Builder`	`propagateTags(Boolean propagateTags)` Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task.
`default JobDetail.Builder`	`retryStrategy(Consumer<RetryStrategy.Builder> retryStrategy)` The retry strategy to use for this job if an attempt fails.
`JobDetail.Builder`	`retryStrategy(RetryStrategy retryStrategy)` The retry strategy to use for this job if an attempt fails.
`JobDetail.Builder`	`schedulingPriority(Integer schedulingPriority)` The scheduling policy of the job definition.
`JobDetail.Builder`	`shareIdentifier(String shareIdentifier)` The share identifier for the job.
`JobDetail.Builder`	`startedAt(Long startedAt)` The Unix timestamp (in milliseconds) for when the job was started (when the job transitioned from the `STARTING` state to the `RUNNING` state).
`JobDetail.Builder`	`status(JobStatus status)` The current status for the job.
`JobDetail.Builder`	`status(String status)` The current status for the job.
`JobDetail.Builder`	`statusReason(String statusReason)` A short, human-readable string to provide additional details about the current status of the job.
`JobDetail.Builder`	`stoppedAt(Long stoppedAt)` The Unix timestamp (in milliseconds) for when the job was stopped (when the job transitioned from the `RUNNING` state to a terminal state, such as `SUCCEEDED` or `FAILED`).
`JobDetail.Builder`	`tags(Map<String,String> tags)` The tags applied to the job.
`default JobDetail.Builder`	`timeout(Consumer<JobTimeout.Builder> timeout)` The timeout configuration for the job.
`JobDetail.Builder`	`timeout(JobTimeout timeout)` The timeout configuration for the job.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - jobArn
```
JobDetail.Builder jobArn(String jobArn)
```
    The Amazon Resource Name (ARN) of the job.
    
    Parameters:
    
    jobArn - The Amazon Resource Name (ARN) of the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - jobName
```
JobDetail.Builder jobName(String jobName)
```
    The name of the job.
    
    Parameters:
    
    jobName - The name of the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - jobId
```
JobDetail.Builder jobId(String jobId)
```
    The ID for the job.
    
    Parameters:
    
    jobId - The ID for the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - jobQueue
```
JobDetail.Builder jobQueue(String jobQueue)
```
    The Amazon Resource Name (ARN) of the job queue that the job is associated with.
    
    Parameters:
    
    jobQueue - The Amazon Resource Name (ARN) of the job queue that the job is associated with.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - status
```
JobDetail.Builder status(String status)
```
    The current status for the job.
    
    If your jobs don't progress to STARTING, see Jobs stuck in RUNNABLE status in the troubleshooting section of the Batch User Guide.
    
    Parameters:
    
    status - The current status for the job.
    
    If your jobs don't progress to STARTING, see Jobs stuck in RUNNABLE status in the troubleshooting section of the Batch User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobStatus, JobStatus
  - status
```
JobDetail.Builder status(JobStatus status)
```
    The current status for the job.
    
    If your jobs don't progress to STARTING, see Jobs stuck in RUNNABLE status in the troubleshooting section of the Batch User Guide.
    
    Parameters:
    
    status - The current status for the job.
    
    If your jobs don't progress to STARTING, see Jobs stuck in RUNNABLE status in the troubleshooting section of the Batch User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobStatus, JobStatus
  - shareIdentifier
```
JobDetail.Builder shareIdentifier(String shareIdentifier)
```
    The share identifier for the job.
    
    Parameters:
    
    shareIdentifier - The share identifier for the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - schedulingPriority
```
JobDetail.Builder schedulingPriority(Integer schedulingPriority)
```
    The scheduling policy of the job definition. 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.
    
    Parameters:
    
    schedulingPriority - The scheduling policy of the job definition. 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - attempts
```
JobDetail.Builder attempts(Collection<AttemptDetail> attempts)
```
    A list of job attempts associated with this job.
    
    Parameters:
    
    attempts - A list of job attempts associated with this job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - attempts
```
JobDetail.Builder attempts(AttemptDetail... attempts)
```
    A list of job attempts associated with this job.
    
    Parameters:
    
    attempts - A list of job attempts associated with this job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - attempts
```
JobDetail.Builder attempts(Consumer<AttemptDetail.Builder>... attempts)
```
    A list of job attempts associated with this job.
    This is a convenience method that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #attempts(List).
    
    Parameters:
    
    attempts - a consumer that will call methods on List.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #attempts(List)
  - statusReason
```
JobDetail.Builder statusReason(String statusReason)
```
    A short, human-readable string to provide additional details about the current status of the job.
    
    Parameters:
    
    statusReason - A short, human-readable string to provide additional details about the current status of the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - createdAt
```
JobDetail.Builder createdAt(Long createdAt)
```
    The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and parent array jobs, this is when the job entered the SUBMITTED state (at the time SubmitJob was called). For array child jobs, this is when the child job was spawned by its parent and entered the PENDING state.
    
    Parameters:
    
    createdAt - The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and parent array jobs, this is when the job entered the SUBMITTED state (at the time SubmitJob was called). For array child jobs, this is when the child job was spawned by its parent and entered the PENDING state.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - retryStrategy
```
JobDetail.Builder retryStrategy(RetryStrategy retryStrategy)
```
    The retry strategy to use for this job if an attempt fails.
    
    Parameters:
    
    retryStrategy - The retry strategy to use for this job if an attempt fails.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - retryStrategy
```
default JobDetail.Builder retryStrategy(Consumer<RetryStrategy.Builder> retryStrategy)
```
    The retry strategy to use for this job if an attempt fails.
    This is a convenience method that creates an instance of the RetryStrategy.Builder avoiding the need to create one manually via RetryStrategy.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to retryStrategy(RetryStrategy).
    
    Parameters:
    
    retryStrategy - a consumer that will call methods on RetryStrategy.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    retryStrategy(RetryStrategy)
  - startedAt
```
JobDetail.Builder startedAt(Long startedAt)
```
    The Unix timestamp (in milliseconds) for when the job was started (when the job transitioned from the STARTING state to the RUNNING state). This parameter isn't provided for child jobs of array jobs or multi-node parallel jobs.
    
    Parameters:
    
    startedAt - The Unix timestamp (in milliseconds) for when the job was started (when the job transitioned from the STARTING state to the RUNNING state). This parameter isn't provided for child jobs of array jobs or multi-node parallel jobs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - stoppedAt
```
JobDetail.Builder stoppedAt(Long stoppedAt)
```
    The Unix timestamp (in milliseconds) for when the job was stopped (when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED).
    
    Parameters:
    
    stoppedAt - The Unix timestamp (in milliseconds) for when the job was stopped (when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED ).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - dependsOn
```
JobDetail.Builder dependsOn(Collection<JobDependency> dependsOn)
```
    A list of job IDs that this job depends on.
    
    Parameters:
    
    dependsOn - A list of job IDs that this job depends on.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - dependsOn
```
JobDetail.Builder dependsOn(JobDependency... dependsOn)
```
    A list of job IDs that this job depends on.
    
    Parameters:
    
    dependsOn - A list of job IDs that this job depends on.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - dependsOn
```
JobDetail.Builder dependsOn(Consumer<JobDependency.Builder>... dependsOn)
```
    A list of job IDs that this job depends on.
    This is a convenience method that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #dependsOn(List).
    
    Parameters:
    
    dependsOn - a consumer that will call methods on List.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #dependsOn(List)
  - jobDefinition
```
JobDetail.Builder jobDefinition(String jobDefinition)
```
    The Amazon Resource Name (ARN) of the job definition that's used by this job.
    
    Parameters:
    
    jobDefinition - The Amazon Resource Name (ARN) of the job definition that's used by this job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - parameters
```
JobDetail.Builder parameters(Map<String,String> parameters)
```
    Additional parameters passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.
    
    Parameters:
    
    parameters - Additional parameters passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - container
```
JobDetail.Builder container(ContainerDetail container)
```
    An object representing the details of the container that's associated with the job.
    
    Parameters:
    
    container - An object representing the details of the container that's associated with the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - container
```
default JobDetail.Builder container(Consumer<ContainerDetail.Builder> container)
```
    An object representing the details of the container that's associated with the job.
    This is a convenience method that creates an instance of the ContainerDetail.Builder avoiding the need to create one manually via ContainerDetail.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to container(ContainerDetail).
    
    Parameters:
    
    container - a consumer that will call methods on ContainerDetail.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    container(ContainerDetail)
  - nodeDetails
```
JobDetail.Builder nodeDetails(NodeDetails nodeDetails)
```
    An object representing the details of a node that's associated with a multi-node parallel job.
    
    Parameters:
    
    nodeDetails - An object representing the details of a node that's associated with a multi-node parallel job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - nodeDetails
```
default JobDetail.Builder nodeDetails(Consumer<NodeDetails.Builder> nodeDetails)
```
    An object representing the details of a node that's associated with a multi-node parallel job.
    This is a convenience method that creates an instance of the NodeDetails.Builder avoiding the need to create one manually via NodeDetails.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to nodeDetails(NodeDetails).
    
    Parameters:
    
    nodeDetails - a consumer that will call methods on NodeDetails.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    nodeDetails(NodeDetails)
  - nodeProperties
```
JobDetail.Builder nodeProperties(NodeProperties nodeProperties)
```
    An object representing the node properties of a multi-node parallel job.
    
    This isn't applicable to jobs that are running on Fargate resources.
    
    Parameters:
    
    nodeProperties - An object representing the node properties of a multi-node parallel job.
    
    This isn't applicable to jobs that are running on Fargate resources.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - nodeProperties
```
default JobDetail.Builder nodeProperties(Consumer<NodeProperties.Builder> nodeProperties)
```
    An object representing the node properties of a multi-node parallel job.
    
    This isn't applicable to jobs that are running on Fargate resources.
    This is a convenience method that creates an instance of the NodeProperties.Builder avoiding the need to create one manually via NodeProperties.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to nodeProperties(NodeProperties).
    
    Parameters:
    
    nodeProperties - a consumer that will call methods on NodeProperties.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    nodeProperties(NodeProperties)
  - arrayProperties
```
JobDetail.Builder arrayProperties(ArrayPropertiesDetail arrayProperties)
```
    The array properties of the job, if it is an array job.
    
    Parameters:
    
    arrayProperties - The array properties of the job, if it is an array job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - arrayProperties
```
default JobDetail.Builder arrayProperties(Consumer<ArrayPropertiesDetail.Builder> arrayProperties)
```
    The array properties of the job, if it is an array job.
    This is a convenience method that creates an instance of the ArrayPropertiesDetail.Builder avoiding the need to create one manually via ArrayPropertiesDetail.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to arrayProperties(ArrayPropertiesDetail).
    
    Parameters:
    
    arrayProperties - a consumer that will call methods on ArrayPropertiesDetail.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    arrayProperties(ArrayPropertiesDetail)
  - timeout
```
JobDetail.Builder timeout(JobTimeout timeout)
```
    The timeout configuration for the job.
    
    Parameters:
    
    timeout - The timeout configuration for the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - timeout
```
default JobDetail.Builder timeout(Consumer<JobTimeout.Builder> timeout)
```
    The timeout configuration for the job.
    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
```
JobDetail.Builder tags(Map<String,String> tags)
```
    The tags applied to the job.
    
    Parameters:
    
    tags - The tags applied to the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - propagateTags
```
JobDetail.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.
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - platformCapabilitiesWithStrings
```
JobDetail.Builder platformCapabilitiesWithStrings(Collection<String> platformCapabilities)
```
    The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.
    
    Parameters:
    
    platformCapabilities - The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - platformCapabilitiesWithStrings
```
JobDetail.Builder platformCapabilitiesWithStrings(String... platformCapabilities)
```
    The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.
    
    Parameters:
    
    platformCapabilities - The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - platformCapabilities
```
JobDetail.Builder platformCapabilities(Collection<PlatformCapability> platformCapabilities)
```
    The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.
    
    Parameters:
    
    platformCapabilities - The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - platformCapabilities
```
JobDetail.Builder platformCapabilities(PlatformCapability... platformCapabilities)
```
    The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.
    
    Parameters:
    
    platformCapabilities - The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.

Interface JobDetail.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

Method Detail

jobArn

jobName

jobId

jobQueue

status

status

shareIdentifier

schedulingPriority

attempts

attempts

attempts

statusReason

createdAt

retryStrategy

retryStrategy

startedAt

stoppedAt

dependsOn

dependsOn

dependsOn

jobDefinition

parameters

container

container

nodeDetails

nodeDetails

nodeProperties

nodeProperties

arrayProperties

arrayProperties

timeout

timeout

tags

propagateTags

platformCapabilitiesWithStrings

platformCapabilitiesWithStrings

platformCapabilities

platformCapabilities