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

Interface CreateRecipeJobRequest.Builder

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

  • Method Details

    • datasetName

      CreateRecipeJobRequest.Builder datasetName(String datasetName)

      The name of the dataset that this job processes.

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

    • encryptionKeyArn

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

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

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

      CreateRecipeJobRequest.Builder name(String name)

      A unique name for the job. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.

      Parameters:
      name - A unique name for the job. 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

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

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

      CreateRecipeJobRequest.Builder maxCapacity(Integer maxCapacity)

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

      Parameters:
      maxCapacity - The maximum number of 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

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

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

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

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

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

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

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

      CreateRecipeJobRequest.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 to.

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

    • databaseOutputs

      CreateRecipeJobRequest.Builder databaseOutputs(DatabaseOutput... databaseOutputs)

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

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

    • databaseOutputs

      CreateRecipeJobRequest.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 to.

      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

      CreateRecipeJobRequest.Builder projectName(String projectName)

      Either the name of an existing project, or a combination of a recipe and a dataset to associate with the recipe.

      Parameters:
      projectName - Either the name of an existing project, or a combination of a recipe and a dataset to associate with the recipe.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • recipeReference

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

    • roleArn

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

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

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

    • overrideConfiguration

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

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