Interface CreateProfileJobRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<CreateProfileJobRequest.Builder,CreateProfileJobRequest>,DataBrewRequest.Builder,SdkBuilder<CreateProfileJobRequest.Builder,CreateProfileJobRequest>,SdkPojo,SdkRequest.Builder
- Enclosing class:
- CreateProfileJobRequest
public static interface CreateProfileJobRequest.Builder extends DataBrewRequest.Builder, SdkPojo, CopyableBuilder<CreateProfileJobRequest.Builder,CreateProfileJobRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default CreateProfileJobRequest.Builderconfiguration(Consumer<ProfileConfiguration.Builder> configuration)Configuration for profile jobs.CreateProfileJobRequest.Builderconfiguration(ProfileConfiguration configuration)Configuration for profile jobs.CreateProfileJobRequest.BuilderdatasetName(String datasetName)The name of the dataset that this job is to act upon.CreateProfileJobRequest.BuilderencryptionKeyArn(String encryptionKeyArn)The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.CreateProfileJobRequest.BuilderencryptionMode(String encryptionMode)The encryption mode for the job, which can be one of the following:CreateProfileJobRequest.BuilderencryptionMode(EncryptionMode encryptionMode)The encryption mode for the job, which can be one of the following:default CreateProfileJobRequest.BuilderjobSample(Consumer<JobSample.Builder> jobSample)Sample configuration for profile jobs only.CreateProfileJobRequest.BuilderjobSample(JobSample jobSample)Sample configuration for profile jobs only.CreateProfileJobRequest.BuilderlogSubscription(String logSubscription)Enables or disables Amazon CloudWatch logging for the job.CreateProfileJobRequest.BuilderlogSubscription(LogSubscription logSubscription)Enables or disables Amazon CloudWatch logging for the job.CreateProfileJobRequest.BuildermaxCapacity(Integer maxCapacity)The maximum number of nodes that DataBrew can use when the job processes data.CreateProfileJobRequest.BuildermaxRetries(Integer maxRetries)The maximum number of times to retry the job after a job run fails.CreateProfileJobRequest.Buildername(String name)The name of the job to be created.default CreateProfileJobRequest.BuilderoutputLocation(Consumer<S3Location.Builder> outputLocation)Sets the value of the OutputLocation property for this object.CreateProfileJobRequest.BuilderoutputLocation(S3Location outputLocation)Sets the value of the OutputLocation property for this object.CreateProfileJobRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)CreateProfileJobRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)CreateProfileJobRequest.BuilderroleArn(String roleArn)The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.CreateProfileJobRequest.Buildertags(Map<String,String> tags)Metadata tags to apply to this job.CreateProfileJobRequest.Buildertimeout(Integer timeout)The job's timeout in minutes.CreateProfileJobRequest.BuildervalidationConfigurations(Collection<ValidationConfiguration> validationConfigurations)List of validation configurations that are applied to the profile job.CreateProfileJobRequest.BuildervalidationConfigurations(Consumer<ValidationConfiguration.Builder>... validationConfigurations)List of validation configurations that are applied to the profile job.CreateProfileJobRequest.BuildervalidationConfigurations(ValidationConfiguration... validationConfigurations)List of validation configurations that are applied to the profile job.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.databrew.model.DataBrewRequest.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
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,EncryptionMode
-
-
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:
EncryptionMode,EncryptionMode
-
-
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,LogSubscription
-
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:
LogSubscription,LogSubscription
-
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 theS3Location.Builderavoiding the need to create one manually viaS3Location.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tooutputLocation(S3Location).- Parameters:
outputLocation- a consumer that will call methods onS3Location.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
outputLocation(S3Location)
-
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 theProfileConfiguration.Builderavoiding the need to create one manually viaProfileConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toconfiguration(ProfileConfiguration).- Parameters:
configuration- 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:
configuration(ProfileConfiguration)
-
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 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)
-
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 ofTIMEOUT.- 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 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)
-
overrideConfiguration
CreateProfileJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
CreateProfileJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-