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

Interface CreateJobRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateJobRequest.Builder,CreateJobRequest>, MediaConvertRequest.Builder, SdkBuilder<CreateJobRequest.Builder,CreateJobRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateJobRequest
public static interface CreateJobRequest.Builder extends MediaConvertRequest.Builder, SdkPojo, CopyableBuilder<CreateJobRequest.Builder,CreateJobRequest>

  • Method Details

    • accelerationSettings

      CreateJobRequest.Builder accelerationSettings(AccelerationSettings accelerationSettings)
      Optional. Accelerated transcoding can significantly speed up jobs with long, visually complex content. Outputs that use this feature incur pro-tier pricing. For information about feature limitations, see the AWS Elemental MediaConvert User Guide.
      Parameters:
      accelerationSettings - Optional. Accelerated transcoding can significantly speed up jobs with long, visually complex content. Outputs that use this feature incur pro-tier pricing. For information about feature limitations, see the AWS Elemental MediaConvert User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • accelerationSettings

      default CreateJobRequest.Builder accelerationSettings(Consumer<AccelerationSettings.Builder> accelerationSettings)
      Optional. Accelerated transcoding can significantly speed up jobs with long, visually complex content. Outputs that use this feature incur pro-tier pricing. For information about feature limitations, see the AWS Elemental MediaConvert User Guide. This is a convenience method that creates an instance of the AccelerationSettings.Builder avoiding the need to create one manually via AccelerationSettings.builder().

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

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

    • billingTagsSource

      CreateJobRequest.Builder billingTagsSource(String billingTagsSource)
      Optional. Choose a 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. Any transcoding outputs that don't have an associated tag will appear in your billing report unsorted. If you don't choose a valid value for this field, your job outputs will appear on the billing report unsorted.
      Parameters:
      billingTagsSource - Optional. Choose a 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. Any transcoding outputs that don't have an associated tag will appear in your billing report unsorted. If you don't choose a valid value for this field, your job outputs will appear on the billing report unsorted.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • billingTagsSource

      CreateJobRequest.Builder billingTagsSource(BillingTagsSource billingTagsSource)
      Optional. Choose a 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. Any transcoding outputs that don't have an associated tag will appear in your billing report unsorted. If you don't choose a valid value for this field, your job outputs will appear on the billing report unsorted.
      Parameters:
      billingTagsSource - Optional. Choose a 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. Any transcoding outputs that don't have an associated tag will appear in your billing report unsorted. If you don't choose a valid value for this field, your job outputs will appear on the billing report unsorted.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clientRequestToken

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

    • hopDestinations

      CreateJobRequest.Builder hopDestinations(Collection<HopDestination> hopDestinations)
      Optional. Use queue hopping to avoid overly long waits in the backlog of the queue that you submit your job to. Specify an alternate queue and the maximum time that your job will wait in the initial queue before hopping. For more information about this feature, see the AWS Elemental MediaConvert User Guide.
      Parameters:
      hopDestinations - Optional. Use queue hopping to avoid overly long waits in the backlog of the queue that you submit your job to. Specify an alternate queue and the maximum time that your job will wait in the initial queue before hopping. For more information about this feature, see the AWS Elemental MediaConvert User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • hopDestinations

      CreateJobRequest.Builder hopDestinations(HopDestination... hopDestinations)
      Optional. Use queue hopping to avoid overly long waits in the backlog of the queue that you submit your job to. Specify an alternate queue and the maximum time that your job will wait in the initial queue before hopping. For more information about this feature, see the AWS Elemental MediaConvert User Guide.
      Parameters:
      hopDestinations - Optional. Use queue hopping to avoid overly long waits in the backlog of the queue that you submit your job to. Specify an alternate queue and the maximum time that your job will wait in the initial queue before hopping. For more information about this feature, see the AWS Elemental MediaConvert User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • hopDestinations

      CreateJobRequest.Builder hopDestinations(Consumer<HopDestination.Builder>... hopDestinations)
      Optional. Use queue hopping to avoid overly long waits in the backlog of the queue that you submit your job to. Specify an alternate queue and the maximum time that your job will wait in the initial queue before hopping. For more information about this feature, see the AWS Elemental MediaConvert User Guide. This is a convenience method that creates an instance of the HopDestination.Builder avoiding the need to create one manually via HopDestination.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to hopDestinations(List<HopDestination>).

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

    • jobTemplate

      CreateJobRequest.Builder jobTemplate(String jobTemplate)
      Optional. When you create a job, you can either specify a job template or specify the transcoding settings individually.
      Parameters:
      jobTemplate - Optional. When you create a job, you can either specify a job template or specify the transcoding settings individually.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • priority

      CreateJobRequest.Builder priority(Integer priority)
      Optional. Specify the relative priority for this job. In any given queue, the service begins processing the job with the highest value first. When more than one job has the same priority, the service begins processing the job that you submitted first. If you don't specify a priority, the service uses the default value 0.
      Parameters:
      priority - Optional. Specify the relative priority for this job. In any given queue, the service begins processing the job with the highest value first. When more than one job has the same priority, the service begins processing the job that you submitted first. If you don't specify a priority, the service uses the default value 0.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • queue

      CreateJobRequest.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 https://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 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.

    • role

      CreateJobRequest.Builder role(String role)
      Required. 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 - Required. 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

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

    • settings

      default CreateJobRequest.Builder settings(Consumer<JobSettings.Builder> settings)
      JobSettings contains all the transcode settings for a job. This is a convenience method 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:

    • simulateReservedQueue

      CreateJobRequest.Builder simulateReservedQueue(String simulateReservedQueue)
      Optional. 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 - Optional. 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

      CreateJobRequest.Builder simulateReservedQueue(SimulateReservedQueue simulateReservedQueue)
      Optional. 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 - Optional. 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:

    • statusUpdateInterval

      CreateJobRequest.Builder statusUpdateInterval(String statusUpdateInterval)
      Optional. 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 - Optional. 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

      CreateJobRequest.Builder statusUpdateInterval(StatusUpdateInterval statusUpdateInterval)
      Optional. 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 - Optional. 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:

    • tags

      CreateJobRequest.Builder tags(Map<String,String> tags)
      Optional. The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key. Use standard AWS tags on your job for automatic integration with AWS services and for custom integrations and workflows.
      Parameters:
      tags - Optional. The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key. Use standard AWS tags on your job for automatic integration with AWS services and for custom integrations and workflows.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userMetadata

      CreateJobRequest.Builder userMetadata(Map<String,String> userMetadata)
      Optional. User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs. Use only for existing integrations or workflows that rely on job metadata tags. Otherwise, we recommend that you use standard AWS tags.
      Parameters:
      userMetadata - Optional. User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs. Use only for existing integrations or workflows that rely on job metadata tags. Otherwise, we recommend that you use standard AWS tags.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.