Package software.amazon.awssdk.services.mediaconvert.model

Interface Job.Builder

    • Method Detail

      • accelerationSettings

        Job.Builder accelerationSettings​(AccelerationSettings accelerationSettings)
        Accelerated transcoding can significantly speed up jobs with long, visually complex content.
        Parameters:
        accelerationSettings - Accelerated transcoding can significantly speed up jobs with long, visually complex content.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • accelerationStatus

        Job.Builder accelerationStatus​(String accelerationStatus)
        Describes whether the current job is running with accelerated transcoding. For jobs that have Acceleration (AccelerationMode) set to DISABLED, AccelerationStatus is always NOT_APPLICABLE. For jobs that have Acceleration (AccelerationMode) set to ENABLED or PREFERRED, AccelerationStatus is one of the other states. AccelerationStatus is IN_PROGRESS initially, while the service determines whether the input files and job settings are compatible with accelerated transcoding. If they are, AcclerationStatus is ACCELERATED. If your input files and job settings aren't compatible with accelerated transcoding, the service either fails your job or runs it without accelerated transcoding, depending on how you set Acceleration (AccelerationMode). When the service runs your job without accelerated transcoding, AccelerationStatus is NOT_ACCELERATED.
        Parameters:
        accelerationStatus - Describes whether the current job is running with accelerated transcoding. For jobs that have Acceleration (AccelerationMode) set to DISABLED, AccelerationStatus is always NOT_APPLICABLE. For jobs that have Acceleration (AccelerationMode) set to ENABLED or PREFERRED, AccelerationStatus is one of the other states. AccelerationStatus is IN_PROGRESS initially, while the service determines whether the input files and job settings are compatible with accelerated transcoding. If they are, AcclerationStatus is ACCELERATED. If your input files and job settings aren't compatible with accelerated transcoding, the service either fails your job or runs it without accelerated transcoding, depending on how you set Acceleration (AccelerationMode). When the service runs your job without accelerated transcoding, AccelerationStatus is NOT_ACCELERATED.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AccelerationStatus, AccelerationStatus

      • accelerationStatus

        Job.Builder accelerationStatus​(AccelerationStatus accelerationStatus)
        Describes whether the current job is running with accelerated transcoding. For jobs that have Acceleration (AccelerationMode) set to DISABLED, AccelerationStatus is always NOT_APPLICABLE. For jobs that have Acceleration (AccelerationMode) set to ENABLED or PREFERRED, AccelerationStatus is one of the other states. AccelerationStatus is IN_PROGRESS initially, while the service determines whether the input files and job settings are compatible with accelerated transcoding. If they are, AcclerationStatus is ACCELERATED. If your input files and job settings aren't compatible with accelerated transcoding, the service either fails your job or runs it without accelerated transcoding, depending on how you set Acceleration (AccelerationMode). When the service runs your job without accelerated transcoding, AccelerationStatus is NOT_ACCELERATED.
        Parameters:
        accelerationStatus - Describes whether the current job is running with accelerated transcoding. For jobs that have Acceleration (AccelerationMode) set to DISABLED, AccelerationStatus is always NOT_APPLICABLE. For jobs that have Acceleration (AccelerationMode) set to ENABLED or PREFERRED, AccelerationStatus is one of the other states. AccelerationStatus is IN_PROGRESS initially, while the service determines whether the input files and job settings are compatible with accelerated transcoding. If they are, AcclerationStatus is ACCELERATED. If your input files and job settings aren't compatible with accelerated transcoding, the service either fails your job or runs it without accelerated transcoding, depending on how you set Acceleration (AccelerationMode). When the service runs your job without accelerated transcoding, AccelerationStatus is NOT_ACCELERATED.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AccelerationStatus, AccelerationStatus

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

      • billingTagsSource

        Job.Builder billingTagsSource​(String billingTagsSource)
        The tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on any billing report that you set up.
        Parameters:
        billingTagsSource - The tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on any billing report that you set up.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        BillingTagsSource, BillingTagsSource

      • billingTagsSource

        Job.Builder billingTagsSource​(BillingTagsSource billingTagsSource)
        The tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on any billing report that you set up.
        Parameters:
        billingTagsSource - The tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on any billing report that you set up.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        BillingTagsSource, BillingTagsSource

      • clientRequestToken

        Job.Builder clientRequestToken​(String clientRequestToken)
        Prevent duplicate jobs from being created and ensure idempotency for your requests. A client request token can be any string that includes up to 64 ASCII characters. If you reuse a client request token within one minute of a successful request, the API returns the job details of the original request instead. For more information see https://docs.aws.amazon.com/mediaconvert/latest/apireference/idempotency.html.
        Parameters:
        clientRequestToken - Prevent duplicate jobs from being created and ensure idempotency for your requests. A client request token can be any string that includes up to 64 ASCII characters. If you reuse a client request token within one minute of a successful request, the API returns the job details of the original request instead. For more information see https://docs.aws.amazon.com/mediaconvert/latest/apireference/idempotency.html.
        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.

      • currentPhase

        Job.Builder currentPhase​(String currentPhase)
        A job's phase can be PROBING, TRANSCODING OR UPLOADING
        Parameters:
        currentPhase - A job's phase can be PROBING, TRANSCODING OR UPLOADING
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        JobPhase, JobPhase

      • currentPhase

        Job.Builder currentPhase​(JobPhase currentPhase)
        A job's phase can be PROBING, TRANSCODING OR UPLOADING
        Parameters:
        currentPhase - A job's phase can be PROBING, TRANSCODING OR UPLOADING
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        JobPhase, JobPhase

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

      • hopDestinations

        Job.Builder hopDestinations​(Collection<HopDestination> hopDestinations)
        Optional list of hop destinations.
        Parameters:
        hopDestinations - Optional list of hop destinations.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • hopDestinations

        Job.Builder hopDestinations​(HopDestination... hopDestinations)
        Optional list of hop destinations.
        Parameters:
        hopDestinations - Optional list of hop destinations.
        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.

      • jobPercentComplete

        Job.Builder jobPercentComplete​(Integer jobPercentComplete)
        An estimate of how far your job has progressed. This estimate is shown as a percentage of the total time from when your job leaves its queue to when your output files appear in your output Amazon S3 bucket. AWS Elemental MediaConvert provides jobPercentComplete in CloudWatch STATUS_UPDATE events and in the response to GetJob and ListJobs requests. The jobPercentComplete estimate is reliable for the following input containers: Quicktime, Transport Stream, MP4, and MXF. For some jobs, the service can't provide information about job progress. In those cases, jobPercentComplete returns a null value.
        Parameters:
        jobPercentComplete - An estimate of how far your job has progressed. This estimate is shown as a percentage of the total time from when your job leaves its queue to when your output files appear in your output Amazon S3 bucket. AWS Elemental MediaConvert provides jobPercentComplete in CloudWatch STATUS_UPDATE events and in the response to GetJob and ListJobs requests. The jobPercentComplete estimate is reliable for the following input containers: Quicktime, Transport Stream, MP4, and MXF. For some jobs, the service can't provide information about job progress. In those cases, jobPercentComplete returns a null value.
        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.

      • messages

        Job.Builder messages​(JobMessages messages)
        Provides messages from the service about jobs that you have already successfully submitted.
        Parameters:
        messages - Provides messages from the service about jobs that you have already successfully submitted.
        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.

      • priority

        Job.Builder priority​(Integer priority)
        Relative priority on the job.
        Parameters:
        priority - Relative priority on the job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • queue

        Job.Builder queue​(String queue)
        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 https://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html
        Parameters:
        queue - 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 https://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.

      • queueTransitions

        Job.Builder queueTransitions​(Collection<QueueTransition> queueTransitions)
        The job's queue hopping history.
        Parameters:
        queueTransitions - The job's queue hopping history.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • queueTransitions

        Job.Builder queueTransitions​(QueueTransition... queueTransitions)
        The job's queue hopping history.
        Parameters:
        queueTransitions - The job's queue hopping history.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • retryCount

        Job.Builder retryCount​(Integer retryCount)
        The number of times that the service automatically attempted to process your job after encountering an error.
        Parameters:
        retryCount - The number of times that the service automatically attempted to process your job after encountering an error.
        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 https://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 https://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)
        JobSettings contains all the transcode settings for a job.
        Parameters:
        settings - JobSettings contains all the transcode settings for a job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • simulateReservedQueue

        Job.Builder simulateReservedQueue​(String simulateReservedQueue)
        Enable this setting when you run a test job to estimate how many reserved transcoding slots (RTS) you need. When this is enabled, MediaConvert runs your job from an on-demand queue with similar performance to what you will see with one RTS in a reserved queue. This setting is disabled by default.
        Parameters:
        simulateReservedQueue - Enable this setting when you run a test job to estimate how many reserved transcoding slots (RTS) you need. When this is enabled, MediaConvert runs your job from an on-demand queue with similar performance to what you will see with one RTS in a reserved queue. This setting is disabled by default.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        SimulateReservedQueue, SimulateReservedQueue

      • simulateReservedQueue

        Job.Builder simulateReservedQueue​(SimulateReservedQueue simulateReservedQueue)
        Enable this setting when you run a test job to estimate how many reserved transcoding slots (RTS) you need. When this is enabled, MediaConvert runs your job from an on-demand queue with similar performance to what you will see with one RTS in a reserved queue. This setting is disabled by default.
        Parameters:
        simulateReservedQueue - Enable this setting when you run a test job to estimate how many reserved transcoding slots (RTS) you need. When this is enabled, MediaConvert runs your job from an on-demand queue with similar performance to what you will see with one RTS in a reserved queue. This setting is disabled by default.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        SimulateReservedQueue, SimulateReservedQueue

      • status

        Job.Builder status​(String status)
        A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.
        Parameters:
        status - A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.
        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)
        A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.
        Parameters:
        status - A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        JobStatus, JobStatus

      • statusUpdateInterval

        Job.Builder statusUpdateInterval​(String statusUpdateInterval)
        Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error.
        Parameters:
        statusUpdateInterval - Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        StatusUpdateInterval, StatusUpdateInterval

      • statusUpdateInterval

        Job.Builder statusUpdateInterval​(StatusUpdateInterval statusUpdateInterval)
        Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error.
        Parameters:
        statusUpdateInterval - Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        StatusUpdateInterval, StatusUpdateInterval

      • timing

        Job.Builder timing​(Timing timing)
        Information about when jobs are submitted, started, and finished is specified in Unix epoch format in seconds.
        Parameters:
        timing - Information about when jobs are submitted, started, and finished is specified in Unix epoch format in seconds.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

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

      • warnings

        Job.Builder warnings​(Collection<WarningGroup> warnings)
        Contains any warning messages for the job. Use to help identify potential issues with your input, output, or job. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/warning_codes.html
        Parameters:
        warnings - Contains any warning messages for the job. Use to help identify potential issues with your input, output, or job. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/warning_codes.html
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • warnings

        Job.Builder warnings​(WarningGroup... warnings)
        Contains any warning messages for the job. Use to help identify potential issues with your input, output, or job. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/warning_codes.html
        Parameters:
        warnings - Contains any warning messages for the job. Use to help identify potential issues with your input, output, or job. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/warning_codes.html
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • warnings

        Job.Builder warnings​(Consumer<WarningGroup.Builder>... warnings)
        Contains any warning messages for the job. Use to help identify potential issues with your input, output, or job. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/warning_codes.html This is a convenience method that creates an instance of the WarningGroup.Builder avoiding the need to create one manually via WarningGroup.builder().

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

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