Package software.amazon.awssdk.services.databrew.model

Interface DescribeJobResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<DescribeJobResponse.Builder,DescribeJobResponse>, DataBrewResponse.Builder, SdkBuilder<DescribeJobResponse.Builder,DescribeJobResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
DescribeJobResponse
public static interface DescribeJobResponse.Builder extends DataBrewResponse.Builder, SdkPojo, CopyableBuilder<DescribeJobResponse.Builder,DescribeJobResponse>

  • Method Details

    • createDate

      DescribeJobResponse.Builder createDate(Instant createDate)

      The date and time that the job was created.

      Parameters:
      createDate - The date and time that the job was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdBy

      DescribeJobResponse.Builder createdBy(String createdBy)

      The identifier (user name) of the user associated with the creation of the job.

      Parameters:
      createdBy - The identifier (user name) of the user associated with the creation of the job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • datasetName

      DescribeJobResponse.Builder datasetName(String datasetName)

      The dataset that the job acts upon.

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

    • encryptionKeyArn

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

      DescribeJobResponse.Builder encryptionMode(String encryptionMode)

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

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

      • 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 - Server-side encryption with keys managed by KMS.

      • 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

      DescribeJobResponse.Builder encryptionMode(EncryptionMode encryptionMode)

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

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

      • 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 - Server-side encryption with keys managed by KMS.

      • 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

      DescribeJobResponse.Builder name(String name)

      The name of the job.

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

    • type

      DescribeJobResponse.Builder type(String type)

      The job type, which must be one of the following:

      • PROFILE - The job analyzes the dataset to determine its size, data types, data distribution, and more.

      • RECIPE - The job applies one or more transformations to a dataset.

      Parameters:
      type - The job type, which must be one of the following:

      • PROFILE - The job analyzes the dataset to determine its size, data types, data distribution, and more.

      • RECIPE - The job applies one or more transformations to a dataset.

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

    • type

      DescribeJobResponse.Builder type(JobType type)

      The job type, which must be one of the following:

      • PROFILE - The job analyzes the dataset to determine its size, data types, data distribution, and more.

      • RECIPE - The job applies one or more transformations to a dataset.

      Parameters:
      type - The job type, which must be one of the following:

      • PROFILE - The job analyzes the dataset to determine its size, data types, data distribution, and more.

      • RECIPE - The job applies one or more transformations to a dataset.

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

    • lastModifiedBy

      DescribeJobResponse.Builder lastModifiedBy(String lastModifiedBy)

      The identifier (user name) of the user who last modified the job.

      Parameters:
      lastModifiedBy - The identifier (user name) of the user who last modified the job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastModifiedDate

      DescribeJobResponse.Builder lastModifiedDate(Instant lastModifiedDate)

      The date and time that the job was last modified.

      Parameters:
      lastModifiedDate - The date and time that the job was last modified.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • logSubscription

      DescribeJobResponse.Builder logSubscription(String logSubscription)

      Indicates whether Amazon CloudWatch logging is enabled for this job.

      Parameters:
      logSubscription - Indicates whether Amazon CloudWatch logging is enabled for this job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • logSubscription

      DescribeJobResponse.Builder logSubscription(LogSubscription logSubscription)

      Indicates whether Amazon CloudWatch logging is enabled for this job.

      Parameters:
      logSubscription - Indicates whether Amazon CloudWatch logging is enabled for this job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maxCapacity

      DescribeJobResponse.Builder maxCapacity(Integer maxCapacity)

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

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

    • maxRetries

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

    • outputs

      DescribeJobResponse.Builder outputs(Collection<Output> outputs)

      One or more artifacts that represent the output from running the job.

      Parameters:
      outputs - One or more artifacts that represent the output from running the job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputs

      DescribeJobResponse.Builder outputs(Output... outputs)

      One or more artifacts that represent the output from running the job.

      Parameters:
      outputs - One or more artifacts that represent the output from running the job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputs

      DescribeJobResponse.Builder outputs(Consumer<Output.Builder>... outputs)

      One or more artifacts that represent the output from running the job.

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

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

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

    • dataCatalogOutputs

      DescribeJobResponse.Builder dataCatalogOutputs(Collection<DataCatalogOutput> dataCatalogOutputs)

      One or more artifacts that represent the Glue Data Catalog output from running the job.

      Parameters:
      dataCatalogOutputs - One or more artifacts that represent the Glue Data Catalog output from running the job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataCatalogOutputs

      DescribeJobResponse.Builder dataCatalogOutputs(DataCatalogOutput... dataCatalogOutputs)

      One or more artifacts that represent the Glue Data Catalog output from running the job.

      Parameters:
      dataCatalogOutputs - One or more artifacts that represent the Glue Data Catalog output from running the job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataCatalogOutputs

      DescribeJobResponse.Builder dataCatalogOutputs(Consumer<DataCatalogOutput.Builder>... dataCatalogOutputs)

      One or more artifacts that represent the Glue Data Catalog output from running the job.

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

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

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

    • databaseOutputs

      DescribeJobResponse.Builder databaseOutputs(Collection<DatabaseOutput> databaseOutputs)

      Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.

      Parameters:
      databaseOutputs - Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • databaseOutputs

      DescribeJobResponse.Builder databaseOutputs(DatabaseOutput... databaseOutputs)

      Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.

      Parameters:
      databaseOutputs - Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • databaseOutputs

      DescribeJobResponse.Builder databaseOutputs(Consumer<DatabaseOutput.Builder>... databaseOutputs)

      Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.

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

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

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

    • projectName

      DescribeJobResponse.Builder projectName(String projectName)

      The DataBrew project associated with this job.

      Parameters:
      projectName - The DataBrew project associated with this job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • profileConfiguration

      DescribeJobResponse.Builder profileConfiguration(ProfileConfiguration profileConfiguration)

      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:
      profileConfiguration - 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.

    • profileConfiguration

      default DescribeJobResponse.Builder profileConfiguration(Consumer<ProfileConfiguration.Builder> profileConfiguration)

      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 profileConfiguration(ProfileConfiguration).

      Parameters:
      profileConfiguration - 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

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

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

      DescribeJobResponse.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:

    • recipeReference

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

    • recipeReference

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

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

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

    • resourceArn

      DescribeJobResponse.Builder resourceArn(String resourceArn)

      The Amazon Resource Name (ARN) of the job.

      Parameters:
      resourceArn - The Amazon Resource Name (ARN) of the job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • roleArn

      DescribeJobResponse.Builder roleArn(String roleArn)

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

      Parameters:
      roleArn - The 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

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

      Metadata tags associated with this job.

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

    • timeout

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

      DescribeJobResponse.Builder jobSample(JobSample jobSample)

      Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed.

      Parameters:
      jobSample - Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • jobSample

      default DescribeJobResponse.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.

      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: