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 Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description DescribeJobResponse.BuildercreateDate(Instant createDate)The date and time that the job was created.DescribeJobResponse.BuildercreatedBy(String createdBy)The identifier (user name) of the user associated with the creation of the job.DescribeJobResponse.BuilderdatabaseOutputs(Collection<DatabaseOutput> databaseOutputs)Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.DescribeJobResponse.BuilderdatabaseOutputs(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.DescribeJobResponse.BuilderdatabaseOutputs(DatabaseOutput... databaseOutputs)Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.DescribeJobResponse.BuilderdataCatalogOutputs(Collection<DataCatalogOutput> dataCatalogOutputs)One or more artifacts that represent the Glue Data Catalog output from running the job.DescribeJobResponse.BuilderdataCatalogOutputs(Consumer<DataCatalogOutput.Builder>... dataCatalogOutputs)One or more artifacts that represent the Glue Data Catalog output from running the job.DescribeJobResponse.BuilderdataCatalogOutputs(DataCatalogOutput... dataCatalogOutputs)One or more artifacts that represent the Glue Data Catalog output from running the job.DescribeJobResponse.BuilderdatasetName(String datasetName)The dataset that the job acts upon.DescribeJobResponse.BuilderencryptionKeyArn(String encryptionKeyArn)The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.DescribeJobResponse.BuilderencryptionMode(String encryptionMode)The encryption mode for the job, which can be one of the following:DescribeJobResponse.BuilderencryptionMode(EncryptionMode encryptionMode)The encryption mode for the job, which can be one of the following:default DescribeJobResponse.BuilderjobSample(Consumer<JobSample.Builder> jobSample)Sample configuration for profile jobs only.DescribeJobResponse.BuilderjobSample(JobSample jobSample)Sample configuration for profile jobs only.DescribeJobResponse.BuilderlastModifiedBy(String lastModifiedBy)The identifier (user name) of the user who last modified the job.DescribeJobResponse.BuilderlastModifiedDate(Instant lastModifiedDate)The date and time that the job was last modified.DescribeJobResponse.BuilderlogSubscription(String logSubscription)Indicates whether Amazon CloudWatch logging is enabled for this job.DescribeJobResponse.BuilderlogSubscription(LogSubscription logSubscription)Indicates whether Amazon CloudWatch logging is enabled for this job.DescribeJobResponse.BuildermaxCapacity(Integer maxCapacity)The maximum number of compute nodes that DataBrew can consume when the job processes data.DescribeJobResponse.BuildermaxRetries(Integer maxRetries)The maximum number of times to retry the job after a job run fails.DescribeJobResponse.Buildername(String name)The name of the job.DescribeJobResponse.Builderoutputs(Collection<Output> outputs)One or more artifacts that represent the output from running the job.DescribeJobResponse.Builderoutputs(Consumer<Output.Builder>... outputs)One or more artifacts that represent the output from running the job.DescribeJobResponse.Builderoutputs(Output... outputs)One or more artifacts that represent the output from running the job.default DescribeJobResponse.BuilderprofileConfiguration(Consumer<ProfileConfiguration.Builder> profileConfiguration)Configuration for profile jobs.DescribeJobResponse.BuilderprofileConfiguration(ProfileConfiguration profileConfiguration)Configuration for profile jobs.DescribeJobResponse.BuilderprojectName(String projectName)The DataBrew project associated with this job.default DescribeJobResponse.BuilderrecipeReference(Consumer<RecipeReference.Builder> recipeReference)Sets the value of the RecipeReference property for this object.DescribeJobResponse.BuilderrecipeReference(RecipeReference recipeReference)Sets the value of the RecipeReference property for this object.DescribeJobResponse.BuilderresourceArn(String resourceArn)The Amazon Resource Name (ARN) of the job.DescribeJobResponse.BuilderroleArn(String roleArn)The ARN of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.DescribeJobResponse.Buildertags(Map<String,String> tags)Metadata tags associated with this job.DescribeJobResponse.Buildertimeout(Integer timeout)The job's timeout in minutes.DescribeJobResponse.Buildertype(String type)The job type, which must be one of the following:DescribeJobResponse.Buildertype(JobType type)The job type, which must be one of the following:DescribeJobResponse.BuildervalidationConfigurations(Collection<ValidationConfiguration> validationConfigurations)List of validation configurations that are applied to the profile job.DescribeJobResponse.BuildervalidationConfigurations(Consumer<ValidationConfiguration.Builder>... validationConfigurations)List of validation configurations that are applied to the profile job.DescribeJobResponse.BuildervalidationConfigurations(ValidationConfiguration... validationConfigurations)List of validation configurations that are applied to the profile job.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.databrew.model.DataBrewResponse.Builder
build, responseMetadata, responseMetadata
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
-
-
-
Method Detail
-
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,EncryptionMode
-
-
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:
EncryptionMode,EncryptionMode
-
-
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:
JobType,JobType
-
-
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:
JobType,JobType
-
-
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,LogSubscription
-
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:
LogSubscription,LogSubscription
-
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 theOutput.Builderavoiding the need to create one manually viaOutput.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#outputs(List.- Parameters:
outputs- a consumer that will call methods onOutput.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#outputs(java.util.Collection
-
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 theDataCatalogOutput.Builderavoiding the need to create one manually viaDataCatalogOutput.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#dataCatalogOutputs(List.) - Parameters:
dataCatalogOutputs- a consumer that will call methods onDataCatalogOutput.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#dataCatalogOutputs(java.util.Collection)
-
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 theDatabaseOutput.Builderavoiding the need to create one manually viaDatabaseOutput.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#databaseOutputs(List.) - Parameters:
databaseOutputs- a consumer that will call methods onDatabaseOutput.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#databaseOutputs(java.util.Collection)
-
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 theProfileConfiguration.Builderavoiding the need to create one manually viaProfileConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toprofileConfiguration(ProfileConfiguration).- Parameters:
profileConfiguration- a consumer that will call methods onProfileConfiguration.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
profileConfiguration(ProfileConfiguration)
-
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 theValidationConfiguration.Builderavoiding the need to create one manually viaValidationConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#validationConfigurations(List.) - Parameters:
validationConfigurations- a consumer that will call methods onValidationConfiguration.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#validationConfigurations(java.util.Collection)
-
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 theRecipeReference.Builderavoiding the need to create one manually viaRecipeReference.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed torecipeReference(RecipeReference).- Parameters:
recipeReference- a consumer that will call methods onRecipeReference.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
recipeReference(RecipeReference)
-
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 ofTIMEOUT.- 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 theJobSample.Builderavoiding the need to create one manually viaJobSample.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tojobSample(JobSample).- Parameters:
jobSample- a consumer that will call methods onJobSample.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
jobSample(JobSample)
-
-