Interface CreateJobRequest.Builder

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

  • Method Details

    • jobName

      CreateJobRequest.Builder jobName(String jobName)

      The name of the job. The name must be unique within your account and Amazon Web Services Region.

      Parameters:
      jobName - The name of the job. The name must be unique within your account and Amazon Web Services Region.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • roleArn

      CreateJobRequest.Builder roleArn(String roleArn)

      The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker assumes to perform the job. The role must have the necessary permissions to access the resources required by the job configuration.

      Parameters:
      roleArn - The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker assumes to perform the job. The role must have the necessary permissions to access the resources required by the job configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • jobCategory

      CreateJobRequest.Builder jobCategory(String jobCategory)

      The category of the job. The category determines the type of workload that the job runs.

      Parameters:
      jobCategory - The category of the job. The category determines the type of workload that the job runs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • jobCategory

      CreateJobRequest.Builder jobCategory(JobCategory jobCategory)

      The category of the job. The category determines the type of workload that the job runs.

      Parameters:
      jobCategory - The category of the job. The category determines the type of workload that the job runs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • jobConfigSchemaVersion

      CreateJobRequest.Builder jobConfigSchemaVersion(String jobConfigSchemaVersion)

      The version of the configuration schema to use for the job configuration document. Use ListJobSchemaVersions to get available schema versions for a job category.

      Parameters:
      jobConfigSchemaVersion - The version of the configuration schema to use for the job configuration document. Use ListJobSchemaVersions to get available schema versions for a job category.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • jobConfigDocument

      CreateJobRequest.Builder jobConfigDocument(String jobConfigDocument)

      The JSON configuration document for the job. The document must conform to the schema specified by JobConfigSchemaVersion. Use DescribeJobSchemaVersion to retrieve the schema for validation.

      Parameters:
      jobConfigDocument - The JSON configuration document for the job. The document must conform to the schema specified by JobConfigSchemaVersion. Use DescribeJobSchemaVersion to retrieve the schema for validation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateJobRequest.Builder tags(Collection<Tag> tags)

      An array of key-value pairs to apply to the job as tags. For more information, see Tagging Amazon Web Services Resources.

      Parameters:
      tags - An array of key-value pairs to apply to the job as tags. For more information, see Tagging Amazon Web Services Resources.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateJobRequest.Builder tags(Tag... tags)

      An array of key-value pairs to apply to the job as tags. For more information, see Tagging Amazon Web Services Resources.

      Parameters:
      tags - An array of key-value pairs to apply to the job as tags. For more information, see Tagging Amazon Web Services Resources.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateJobRequest.Builder tags(Consumer<Tag.Builder>... tags)

      An array of key-value pairs to apply to the job as tags. For more information, see Tagging Amazon Web Services Resources.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

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

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

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