software.amazon.awssdk.services.mediaconvert.model

Interface Job.Builder

All Superinterfaces:

CopyableBuilder<Job.Builder,Job>, SdkBuilder<Job.Builder,Job>

Enclosing class:

Job

public static interface Job.Builder
extends CopyableBuilder<Job.Builder,Job>

Method Summary

Modifier and Type	Method and Description
Job.Builder	arn(String arn) An identifier for this resource that is unique within all of AWS.
Job.Builder	createdAt(Instant createdAt) The time, in Unix epoch format in seconds, when the job got created.
Job.Builder	errorCode(Integer errorCode) Error code for the job
Job.Builder	errorMessage(String errorMessage) Error message of Job
Job.Builder	id(String id) A portion of the job's ARN, unique within your AWS Elemental MediaConvert resources
Job.Builder	jobTemplate(String jobTemplate) The job template that the job is created from, if it is created from a job template.
Job.Builder	outputGroupDetails(Collection<OutputGroupDetail> outputGroupDetails) List of output group details
Job.Builder	outputGroupDetails(Consumer<OutputGroupDetail.Builder>... outputGroupDetails) List of output group details This is a convenience that creates an instance of the .Builder avoiding the need to create one manually via #builder().
Job.Builder	outputGroupDetails(OutputGroupDetail... outputGroupDetails) List of output group details
Job.Builder	queue(String queue) Optional.
Job.Builder	role(String role) The IAM role you use for creating this job.
default Job.Builder	settings(Consumer<JobSettings.Builder> settings) Sets the value of the Settings property for this object.
Job.Builder	settings(JobSettings settings) Sets the value of the Settings property for this object.
Job.Builder	status(JobStatus status) Sets the value of the Status property for this object.
Job.Builder	status(String status) Sets the value of the Status property for this object.
default Job.Builder	timing(Consumer<Timing.Builder> timing) Sets the value of the Timing property for this object.
Job.Builder	timing(Timing timing) Sets the value of the Timing property for this object.
Job.Builder	userMetadata(Map<String,String> userMetadata) User-defined metadata that you want to associate with an MediaConvert job.

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

copy

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

apply, build

Method Detail

arn

Job.Builder arn(String arn)

An identifier for this resource that is unique within all of AWS.

Parameters:

arn - An identifier for this resource that is unique within all of AWS.

Returns:

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

createdAt

Job.Builder createdAt(Instant createdAt)

The time, in Unix epoch format in seconds, when the job got created.

Parameters:

createdAt - The time, in Unix epoch format in seconds, when the job got created.

Returns:

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

errorCode

Job.Builder errorCode(Integer errorCode)

Error code for the job

Parameters:

errorCode - Error code for the job

Returns:

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

errorMessage

Job.Builder errorMessage(String errorMessage)

Error message of Job

Parameters:

errorMessage - Error message of Job

Returns:

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

id

Job.Builder id(String id)

A portion of the job's ARN, unique within your AWS Elemental MediaConvert resources

Parameters:

id - A portion of the job's ARN, unique within your AWS Elemental MediaConvert resources

Returns:

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

jobTemplate

Job.Builder jobTemplate(String jobTemplate)

The job template that the job is created from, if it is created from a job template.

Parameters:

jobTemplate - The job template that the job is created from, if it is created from a job template.

Returns:

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

outputGroupDetails

Job.Builder outputGroupDetails(Collection<OutputGroupDetail> outputGroupDetails)

List of output group details

Parameters:

outputGroupDetails - List of output group details

Returns:

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

outputGroupDetails

Job.Builder outputGroupDetails(OutputGroupDetail... outputGroupDetails)

List of output group details

Parameters:

outputGroupDetails - List of output group details

Returns:

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

outputGroupDetails

Job.Builder outputGroupDetails(Consumer<OutputGroupDetail.Builder>... outputGroupDetails)

List of output group details This is a convenience that creates an instance of the .Builder avoiding the need to create one manually via #builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #outputGroupDetails(List).

Parameters:

outputGroupDetails - 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:

#outputGroupDetails(List)

queue

Job.Builder queue(String queue)

Optional. When you create a job, you can specify a queue to send it to. If you don't specify, the job will go to the default queue. For more about queues, see the User Guide topic at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html

Parameters:

queue - Optional. When you create a job, you can specify a queue to send it to. If you don't specify, the job will go to the default queue. For more about queues, see the User Guide topic at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html

Returns:

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

role

Job.Builder role(String role)

The IAM role you use for creating this job. For details about permissions, see the User Guide topic at the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html

Parameters:

role - The IAM role you use for creating this job. For details about permissions, see the User Guide topic at the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html

Returns:

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

settings

Job.Builder settings(JobSettings settings)

Sets the value of the Settings property for this object.

Parameters:

settings - The new value for the Settings property for this object.

Returns:

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

settings

default Job.Builder settings(Consumer<JobSettings.Builder> settings)

Sets the value of the Settings property for this object. This is a convenience that creates an instance of the JobSettings.Builder avoiding the need to create one manually via JobSettings.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to settings(JobSettings).

Parameters:

settings - a consumer that will call methods on JobSettings.Builder

Returns:

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

See Also:

settings(JobSettings)

status

Job.Builder status(String status)

Sets the value of the Status property for this object.

Parameters:

status - The new value for the Status property for this object.

Returns:

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

See Also:

JobStatus, JobStatus

status

Job.Builder status(JobStatus status)

Sets the value of the Status property for this object.

Parameters:

status - The new value for the Status property for this object.

Returns:

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

See Also:

JobStatus, JobStatus

timing

Job.Builder timing(Timing timing)

Sets the value of the Timing property for this object.

Parameters:

timing - The new value for the Timing property for this object.

Returns:

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

timing

default Job.Builder timing(Consumer<Timing.Builder> timing)

Sets the value of the Timing property for this object. This is a convenience that creates an instance of the Timing.Builder avoiding the need to create one manually via Timing.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to timing(Timing).

Parameters:

timing - a consumer that will call methods on Timing.Builder

Returns:

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

See Also:

timing(Timing)

userMetadata

Job.Builder userMetadata(Map<String,String> userMetadata)

User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs.

Parameters:

userMetadata - User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs.

Returns:

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