Interface CreateProfileJobRequest.Builder

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

  • Method Details

    • datasetName

      CreateProfileJobRequest.Builder datasetName(String datasetName)

      The name of the dataset that this job is to act upon.

      Parameters:
      datasetName - The name of the dataset that this job is to act upon.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • encryptionKeyArn

      CreateProfileJobRequest.Builder encryptionKeyArn(String encryptionKeyArn)

      The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.

      Parameters:
      encryptionKeyArn - The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • encryptionMode

      CreateProfileJobRequest.Builder encryptionMode(String encryptionMode)

      The encryption mode for the job, which can be one of the following:

      • SSE-KMS - SSE-KMS - Server-side encryption with KMS-managed keys.

      • SSE-S3 - Server-side encryption with keys managed by Amazon S3.

      Parameters:
      encryptionMode - The encryption mode for the job, which can be one of the following:

      • SSE-KMS - SSE-KMS - Server-side encryption with KMS-managed keys.

      • SSE-S3 - Server-side encryption with keys managed by Amazon S3.

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

    • encryptionMode

      CreateProfileJobRequest.Builder encryptionMode(EncryptionMode encryptionMode)

      The encryption mode for the job, which can be one of the following:

      • SSE-KMS - SSE-KMS - Server-side encryption with KMS-managed keys.

      • SSE-S3 - Server-side encryption with keys managed by Amazon S3.

      Parameters:
      encryptionMode - The encryption mode for the job, which can be one of the following:

      • SSE-KMS - SSE-KMS - Server-side encryption with KMS-managed keys.

      • SSE-S3 - Server-side encryption with keys managed by Amazon S3.

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

    • name

      CreateProfileJobRequest.Builder name(String name)

      The name of the job to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.

      Parameters:
      name - The name of the job to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • logSubscription

      CreateProfileJobRequest.Builder logSubscription(String logSubscription)

      Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.

      Parameters:
      logSubscription - Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • logSubscription

      CreateProfileJobRequest.Builder logSubscription(LogSubscription logSubscription)

      Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.

      Parameters:
      logSubscription - Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maxCapacity

      CreateProfileJobRequest.Builder maxCapacity(Integer maxCapacity)

      The maximum number of nodes that DataBrew can use when the job processes data.

      Parameters:
      maxCapacity - The maximum number of nodes that DataBrew can use when the job processes data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxRetries

      CreateProfileJobRequest.Builder maxRetries(Integer maxRetries)

      The maximum number of times to retry the job after a job run fails.

      Parameters:
      maxRetries - The maximum number of times to retry the job after a job run fails.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputLocation

      CreateProfileJobRequest.Builder outputLocation(S3Location outputLocation)
      Sets the value of the OutputLocation property for this object.
      Parameters:
      outputLocation - The new value for the OutputLocation property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputLocation

      default CreateProfileJobRequest.Builder outputLocation(Consumer<S3Location.Builder> outputLocation)
      Sets the value of the OutputLocation property for this object. This is a convenience method that creates an instance of the S3Location.Builder avoiding the need to create one manually via S3Location.builder().

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

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

    • configuration

      CreateProfileJobRequest.Builder configuration(ProfileConfiguration configuration)

      Configuration for profile jobs. Used to select columns, do evaluations, and override default parameters of evaluations. When configuration is null, the profile job will run with default settings.

      Parameters:
      configuration - Configuration for profile jobs. Used to select columns, do evaluations, and override default parameters of evaluations. When configuration is null, the profile job will run with default settings.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • configuration

      default CreateProfileJobRequest.Builder configuration(Consumer<ProfileConfiguration.Builder> configuration)

      Configuration for profile jobs. Used to select columns, do evaluations, and override default parameters of evaluations. When configuration is null, the profile job will run with default settings.

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

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

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

    • validationConfigurations

      CreateProfileJobRequest.Builder validationConfigurations(Collection<ValidationConfiguration> validationConfigurations)

      List of validation configurations that are applied to the profile job.

      Parameters:
      validationConfigurations - List of validation configurations that are applied to the profile job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • validationConfigurations

      CreateProfileJobRequest.Builder validationConfigurations(ValidationConfiguration... validationConfigurations)

      List of validation configurations that are applied to the profile job.

      Parameters:
      validationConfigurations - List of validation configurations that are applied to the profile job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • validationConfigurations

      CreateProfileJobRequest.Builder validationConfigurations(Consumer<ValidationConfiguration.Builder>... validationConfigurations)

      List of validation configurations that are applied to the profile job.

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

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

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

    • roleArn

      CreateProfileJobRequest.Builder roleArn(String roleArn)

      The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.

      Parameters:
      roleArn - The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateProfileJobRequest.Builder tags(Map<String,String> tags)

      Metadata tags to apply to this job.

      Parameters:
      tags - Metadata tags to apply to this job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timeout

      CreateProfileJobRequest.Builder timeout(Integer timeout)

      The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT.

      Parameters:
      timeout - The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • jobSample

      CreateProfileJobRequest.Builder jobSample(JobSample jobSample)

      Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed. If a JobSample value is not provided, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter.

      Parameters:
      jobSample - Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed. If a JobSample value is not provided, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • jobSample

      default CreateProfileJobRequest.Builder jobSample(Consumer<JobSample.Builder> jobSample)

      Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed. If a JobSample value is not provided, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter.

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

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

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

    • overrideConfiguration

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

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