software.amazon.awssdk.services.databrew.model

Class CreateProfileJobRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.databrew.model.DataBrewRequest

software.amazon.awssdk.services.databrew.model.CreateProfileJobRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateProfileJobRequest.Builder,CreateProfileJobRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateProfileJobRequest
extends DataBrewRequest
implements ToCopyableBuilder<CreateProfileJobRequest.Builder,CreateProfileJobRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateProfileJobRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateProfileJobRequest.Builder	builder()
ProfileConfiguration	configuration() Configuration for profile jobs.
String	datasetName() The name of the dataset that this job is to act upon.
String	encryptionKeyArn() The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.
EncryptionMode	encryptionMode() The encryption mode for the job, which can be one of the following:
String	encryptionModeAsString() The encryption mode for the job, which can be one of the following:
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
boolean	hasValidationConfigurations() For responses, this returns true if the service returned a value for the ValidationConfigurations property.
JobSample	jobSample() Sample configuration for profile jobs only.
LogSubscription	logSubscription() Enables or disables Amazon CloudWatch logging for the job.
String	logSubscriptionAsString() Enables or disables Amazon CloudWatch logging for the job.
Integer	maxCapacity() The maximum number of nodes that DataBrew can use when the job processes data.
Integer	maxRetries() The maximum number of times to retry the job after a job run fails.
String	name() The name of the job to be created.
S3Location	outputLocation() Returns the value of the OutputLocation property for this object.
String	roleArn() The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateProfileJobRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags() Metadata tags to apply to this job.
Integer	timeout() The job's timeout in minutes.
CreateProfileJobRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<ValidationConfiguration>	validationConfigurations() List of validation configurations that are applied to the profile job.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

datasetName

public final String datasetName()

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

Returns:

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

encryptionKeyArn

public final String encryptionKeyArn()

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

Returns:

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

encryptionMode

public final 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.

If the service returns an enum value that is not available in the current SDK version, encryptionMode will return EncryptionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from encryptionModeAsString().

Returns:

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.

See Also:

EncryptionMode

encryptionModeAsString

public final String encryptionModeAsString()

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.

If the service returns an enum value that is not available in the current SDK version, encryptionMode will return EncryptionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from encryptionModeAsString().

Returns:

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.

See Also:

EncryptionMode

name

public final String name()

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

Returns:

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

logSubscription

public final LogSubscription logSubscription()

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

If the service returns an enum value that is not available in the current SDK version, logSubscription will return LogSubscription.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from logSubscriptionAsString().

Returns:

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

See Also:

LogSubscription

logSubscriptionAsString

public final String logSubscriptionAsString()

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

If the service returns an enum value that is not available in the current SDK version, logSubscription will return LogSubscription.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from logSubscriptionAsString().

Returns:

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

See Also:

LogSubscription

maxCapacity

public final Integer maxCapacity()

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

Returns:

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

maxRetries

public final Integer maxRetries()

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

Returns:

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

outputLocation

public final S3Location outputLocation()

Returns the value of the OutputLocation property for this object.

Returns:

The value of the OutputLocation property for this object.

configuration

public final 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.

Returns:

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.

hasValidationConfigurations

public final boolean hasValidationConfigurations()

For responses, this returns true if the service returned a value for the ValidationConfigurations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

validationConfigurations

public final List<ValidationConfiguration> validationConfigurations()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasValidationConfigurations() method.

Returns:

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

roleArn

public final String roleArn()

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

Returns:

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

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final Map<String,String> tags()

Metadata tags to apply to this job.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

Metadata tags to apply to this job.

timeout

public final 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.

Returns:

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

jobSample

public final 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.

Returns:

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.

toBuilder

public CreateProfileJobRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateProfileJobRequest.Builder,CreateProfileJobRequest>

Specified by:

toBuilder in class DataBrewRequest

builder

public static CreateProfileJobRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateProfileJobRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo