public static interface JobDetail.Builder extends SdkPojo, CopyableBuilder<JobDetail.Builder,JobDetail>
| Modifier and Type | Method and Description |
|---|---|
JobDetail.Builder |
arrayProperties(ArrayPropertiesDetail arrayProperties)
The array properties of the job, if it's an array job.
|
default JobDetail.Builder |
arrayProperties(Consumer<ArrayPropertiesDetail.Builder> arrayProperties)
The array properties of the job, if it's an array job.
|
JobDetail.Builder |
attempts(AttemptDetail... attempts)
A list of job attempts that are associated with this job.
|
JobDetail.Builder |
attempts(Collection<AttemptDetail> attempts)
A list of job attempts that are associated with this job.
|
JobDetail.Builder |
attempts(Consumer<AttemptDetail.Builder>... attempts)
A list of job attempts that are associated with this job.
|
default JobDetail.Builder |
container(Consumer<ContainerDetail.Builder> container)
An object that represents the details for the container that's associated with the job.
|
JobDetail.Builder |
container(ContainerDetail container)
An object that represents the details for 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 |
eksAttempts(Collection<EksAttemptDetail> eksAttempts)
A list of job attempts that are associated with this job.
|
JobDetail.Builder |
eksAttempts(Consumer<EksAttemptDetail.Builder>... eksAttempts)
A list of job attempts that are associated with this job.
|
JobDetail.Builder |
eksAttempts(EksAttemptDetail... eksAttempts)
A list of job attempts that are associated with this job.
|
default JobDetail.Builder |
eksProperties(Consumer<EksPropertiesDetail.Builder> eksProperties)
An object with various properties that are specific to Amazon EKS based jobs.
|
JobDetail.Builder |
eksProperties(EksPropertiesDetail eksProperties)
An object with various properties that are specific to Amazon EKS based jobs.
|
JobDetail.Builder |
isCancelled(Boolean isCancelled)
Indicates whether the job is canceled.
|
JobDetail.Builder |
isTerminated(Boolean isTerminated)
Indicates whether the job is terminated.
|
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 this job uses.
|
JobDetail.Builder |
jobId(String jobId)
The job ID.
|
JobDetail.Builder |
jobName(String jobName)
The job name.
|
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 that represents the details of a node that's associated with a multi-node parallel job.
|
JobDetail.Builder |
nodeDetails(NodeDetails nodeDetails)
An object that represents the details of a node that's associated with a multi-node parallel job.
|
default JobDetail.Builder |
nodeProperties(Consumer<NodeProperties.Builder> nodeProperties)
An object that represents the node properties of a multi-node parallel job.
|
JobDetail.Builder |
nodeProperties(NodeProperties nodeProperties)
An object that represents the node properties of a multi-node parallel job.
|
JobDetail.Builder |
parameters(Map<String,String> parameters)
Additional parameters that are 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.
|
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 more details for the current status of the job.
|
JobDetail.Builder |
stoppedAt(Long stoppedAt)
The Unix timestamp (in milliseconds) for when the job was stopped.
|
JobDetail.Builder |
tags(Map<String,String> tags)
The tags that are 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.
|
equalsBySdkFields, sdkFieldscopyapplyMutation, buildJobDetail.Builder jobArn(String jobArn)
The Amazon Resource Name (ARN) of the job.
jobArn - The Amazon Resource Name (ARN) of the job.JobDetail.Builder jobName(String jobName)
The job name.
jobName - The job name.JobDetail.Builder jobId(String jobId)
The job ID.
jobId - The job ID.JobDetail.Builder jobQueue(String jobQueue)
The Amazon Resource Name (ARN) of the job queue that the job is associated with.
jobQueue - The Amazon Resource Name (ARN) of the job queue that the job is associated with.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.
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.
JobStatus,
JobStatusJobDetail.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.
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.
JobStatus,
JobStatusJobDetail.Builder shareIdentifier(String shareIdentifier)
The share identifier for the job.
shareIdentifier - The share identifier for the job.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.
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.JobDetail.Builder attempts(Collection<AttemptDetail> attempts)
A list of job attempts that are associated with this job.
attempts - A list of job attempts that are associated with this job.JobDetail.Builder attempts(AttemptDetail... attempts)
A list of job attempts that are associated with this job.
attempts - A list of job attempts that are associated with this job.JobDetail.Builder attempts(Consumer<AttemptDetail.Builder>... attempts)
A list of job attempts that are associated with this job.
This is a convenience method that creates an instance of theAttemptDetail.Builder avoiding the need to create one
manually via AttemptDetail.builder().
When the Consumer completes,
SdkBuilder.build() is called immediately and
its result is passed to #attempts(List.
attempts - a consumer that will call methods on
AttemptDetail.Builder#attempts(java.util.Collection) JobDetail.Builder statusReason(String statusReason)
A short, human-readable string to provide more details for the current status of the job.
statusReason - A short, human-readable string to provide more details for the current status of the job.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. This is specifically 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.
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. This is specifically 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.JobDetail.Builder retryStrategy(RetryStrategy retryStrategy)
The retry strategy to use for this job if an attempt fails.
retryStrategy - The retry strategy to use for this job if an attempt fails.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 theRetryStrategy.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).
retryStrategy - a consumer that will call methods on RetryStrategy.BuilderretryStrategy(RetryStrategy)JobDetail.Builder startedAt(Long startedAt)
The Unix timestamp (in milliseconds) for when the job was started. More specifically, it's 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.
startedAt - The Unix timestamp (in milliseconds) for when the job was started. More specifically, it's 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.JobDetail.Builder stoppedAt(Long stoppedAt)
The Unix timestamp (in milliseconds) for when the job was stopped. More specifically, it's when the job
transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or
FAILED.
stoppedAt - The Unix timestamp (in milliseconds) for when the job was stopped. More specifically, it's when the
job transitioned from the RUNNING state to a terminal state, such as
SUCCEEDED or FAILED.JobDetail.Builder dependsOn(Collection<JobDependency> dependsOn)
A list of job IDs that this job depends on.
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.
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.
This is a convenience method that creates an instance of theJobDependency.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.
dependsOn - a consumer that will call methods on
JobDependency.Builder#dependsOn(java.util.Collection) JobDetail.Builder jobDefinition(String jobDefinition)
The Amazon Resource Name (ARN) of the job definition that this job uses.
jobDefinition - The Amazon Resource Name (ARN) of the job definition that this job uses.JobDetail.Builder parameters(Map<String,String> parameters)
Additional parameters that are passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.
parameters - Additional parameters that are passed to the job that replace parameter substitution placeholders or
override any corresponding parameter defaults from the job definition.JobDetail.Builder container(ContainerDetail container)
An object that represents the details for the container that's associated with the job.
container - An object that represents the details for the container that's associated with the job.default JobDetail.Builder container(Consumer<ContainerDetail.Builder> container)
An object that represents the details for the container that's associated with the job.
This is a convenience method that creates an instance of theContainerDetail.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).
container - a consumer that will call methods on ContainerDetail.Buildercontainer(ContainerDetail)JobDetail.Builder nodeDetails(NodeDetails nodeDetails)
An object that represents the details of a node that's associated with a multi-node parallel job.
nodeDetails - An object that represents the details of a node that's associated with a multi-node parallel job.default JobDetail.Builder nodeDetails(Consumer<NodeDetails.Builder> nodeDetails)
An object that represents the details of a node that's associated with a multi-node parallel job.
This is a convenience method that creates an instance of theNodeDetails.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).
nodeDetails - a consumer that will call methods on NodeDetails.BuildernodeDetails(NodeDetails)JobDetail.Builder nodeProperties(NodeProperties nodeProperties)
An object that represents the node properties of a multi-node parallel job.
This isn't applicable to jobs that are running on Fargate resources.
nodeProperties - An object that represents the node properties of a multi-node parallel job. This isn't applicable to jobs that are running on Fargate resources.
default JobDetail.Builder nodeProperties(Consumer<NodeProperties.Builder> nodeProperties)
An object that represents the node properties of a multi-node parallel job.
This isn't applicable to jobs that are running on Fargate resources.
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).
nodeProperties - a consumer that will call methods on NodeProperties.BuildernodeProperties(NodeProperties)JobDetail.Builder arrayProperties(ArrayPropertiesDetail arrayProperties)
The array properties of the job, if it's an array job.
arrayProperties - The array properties of the job, if it's an array job.default JobDetail.Builder arrayProperties(Consumer<ArrayPropertiesDetail.Builder> arrayProperties)
The array properties of the job, if it's an array job.
This is a convenience method that creates an instance of theArrayPropertiesDetail.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).
arrayProperties - a consumer that will call methods on ArrayPropertiesDetail.BuilderarrayProperties(ArrayPropertiesDetail)JobDetail.Builder timeout(JobTimeout timeout)
The timeout configuration for the job.
timeout - The timeout configuration for the job.default JobDetail.Builder timeout(Consumer<JobTimeout.Builder> timeout)
The timeout configuration for the job.
This is a convenience method that creates an instance of theJobTimeout.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).
timeout - a consumer that will call methods on JobTimeout.Buildertimeout(JobTimeout)JobDetail.Builder tags(Map<String,String> tags)
The tags that are applied to the job.
tags - The tags that are applied to the job.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 when the tasks
are created. 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.
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
when the tasks are created. 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.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.
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.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.
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.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.
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.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.
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.JobDetail.Builder eksProperties(EksPropertiesDetail eksProperties)
An object with various properties that are specific to Amazon EKS based jobs. Only one of
container, eksProperties, or nodeDetails is specified.
eksProperties - An object with various properties that are specific to Amazon EKS based jobs. Only one of
container, eksProperties, or nodeDetails is specified.default JobDetail.Builder eksProperties(Consumer<EksPropertiesDetail.Builder> eksProperties)
An object with various properties that are specific to Amazon EKS based jobs. Only one of
container, eksProperties, or nodeDetails is specified.
EksPropertiesDetail.Builder avoiding the
need to create one manually via EksPropertiesDetail.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and
its result is passed to eksProperties(EksPropertiesDetail).
eksProperties - a consumer that will call methods on EksPropertiesDetail.BuildereksProperties(EksPropertiesDetail)JobDetail.Builder eksAttempts(Collection<EksAttemptDetail> eksAttempts)
A list of job attempts that are associated with this job.
eksAttempts - A list of job attempts that are associated with this job.JobDetail.Builder eksAttempts(EksAttemptDetail... eksAttempts)
A list of job attempts that are associated with this job.
eksAttempts - A list of job attempts that are associated with this job.JobDetail.Builder eksAttempts(Consumer<EksAttemptDetail.Builder>... eksAttempts)
A list of job attempts that are associated with this job.
This is a convenience method that creates an instance of theEksAttemptDetail.Builder avoiding the need to create one
manually via EksAttemptDetail.builder().
When the Consumer completes,
SdkBuilder.build() is called immediately
and its result is passed to #eksAttempts(List.
eksAttempts - a consumer that will call methods on
EksAttemptDetail.Builder#eksAttempts(java.util.Collection) JobDetail.Builder isCancelled(Boolean isCancelled)
Indicates whether the job is canceled.
isCancelled - Indicates whether the job is canceled.JobDetail.Builder isTerminated(Boolean isTerminated)
Indicates whether the job is terminated.
isTerminated - Indicates whether the job is terminated.Copyright © 2023. All rights reserved.