@Generated(value="software.amazon.awssdk:codegen") public final class DescribeJobResponse extends DataBrewResponse implements ToCopyableBuilder<DescribeJobResponse.Builder,DescribeJobResponse>
| Modifier and Type | Class and Description |
|---|---|
static interface |
DescribeJobResponse.Builder |
| Modifier and Type | Method and Description |
|---|---|
static DescribeJobResponse.Builder |
builder() |
Instant |
createDate()
The date and time that the job was created.
|
String |
createdBy()
The identifier (user name) of the user associated with the creation of the job.
|
List<DatabaseOutput> |
databaseOutputs()
Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job
to write into.
|
List<DataCatalogOutput> |
dataCatalogOutputs()
One or more artifacts that represent the Glue Data Catalog output from running the job.
|
String |
datasetName()
The dataset that the job acts 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) |
boolean |
hasDatabaseOutputs()
For responses, this returns true if the service returned a value for the DatabaseOutputs property.
|
boolean |
hasDataCatalogOutputs()
For responses, this returns true if the service returned a value for the DataCatalogOutputs property.
|
int |
hashCode() |
boolean |
hasOutputs()
For responses, this returns true if the service returned a value for the Outputs property.
|
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.
|
String |
lastModifiedBy()
The identifier (user name) of the user who last modified the job.
|
Instant |
lastModifiedDate()
The date and time that the job was last modified.
|
LogSubscription |
logSubscription()
Indicates whether Amazon CloudWatch logging is enabled for this job.
|
String |
logSubscriptionAsString()
Indicates whether Amazon CloudWatch logging is enabled for this job.
|
Integer |
maxCapacity()
The maximum number of compute nodes that DataBrew can consume 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.
|
List<Output> |
outputs()
One or more artifacts that represent the output from running the job.
|
ProfileConfiguration |
profileConfiguration()
Configuration for profile jobs.
|
String |
projectName()
The DataBrew project associated with this job.
|
RecipeReference |
recipeReference()
Returns the value of the RecipeReference property for this object.
|
String |
resourceArn()
The Amazon Resource Name (ARN) of the job.
|
String |
roleArn()
The ARN of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends DescribeJobResponse.Builder> |
serializableBuilderClass() |
Map<String,String> |
tags()
Metadata tags associated with this job.
|
Integer |
timeout()
The job's timeout in minutes.
|
DescribeJobResponse.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
JobType |
type()
The job type, which must be one of the following:
|
String |
typeAsString()
The job type, which must be one of the following:
|
List<ValidationConfiguration> |
validationConfigurations()
List of validation configurations that are applied to the profile job.
|
responseMetadatasdkHttpResponseclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final Instant createDate()
The date and time that the job was created.
public final String createdBy()
The identifier (user name) of the user associated with the creation of the job.
public final String datasetName()
The dataset that the job acts upon.
public final String encryptionKeyArn()
The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.
public final 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.
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().
SSE-KMS - Server-side encryption with keys managed by KMS.
SSE-S3 - Server-side encryption with keys managed by Amazon S3.
EncryptionModepublic final String encryptionModeAsString()
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.
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().
SSE-KMS - Server-side encryption with keys managed by KMS.
SSE-S3 - Server-side encryption with keys managed by Amazon S3.
EncryptionModepublic final String name()
The name of the job.
public final 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.
If the service returns an enum value that is not available in the current SDK version, type will return
JobType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
typeAsString().
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.
JobTypepublic final String typeAsString()
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.
If the service returns an enum value that is not available in the current SDK version, type will return
JobType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
typeAsString().
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.
JobTypepublic final String lastModifiedBy()
The identifier (user name) of the user who last modified the job.
public final Instant lastModifiedDate()
The date and time that the job was last modified.
public final LogSubscription logSubscription()
Indicates whether Amazon CloudWatch logging is enabled for this job.
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().
LogSubscriptionpublic final String logSubscriptionAsString()
Indicates whether Amazon CloudWatch logging is enabled for this job.
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().
LogSubscriptionpublic final Integer maxCapacity()
The maximum number of compute nodes that DataBrew can consume when the job processes data.
public final Integer maxRetries()
The maximum number of times to retry the job after a job run fails.
public final boolean hasOutputs()
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.public final List<Output> outputs()
One or more artifacts that represent the output from running the 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 hasOutputs() method.
public final boolean hasDataCatalogOutputs()
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.public final List<DataCatalogOutput> dataCatalogOutputs()
One or more artifacts that represent the Glue Data Catalog output from running the 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 hasDataCatalogOutputs() method.
public final boolean hasDatabaseOutputs()
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.public final List<DatabaseOutput> databaseOutputs()
Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
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 hasDatabaseOutputs() method.
public final String projectName()
The DataBrew project associated with this job.
public final 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.
public final boolean hasValidationConfigurations()
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.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.
public final RecipeReference recipeReference()
public final String resourceArn()
The Amazon Resource Name (ARN) of the job.
public final String roleArn()
The ARN of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.
public final boolean hasTags()
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.public final Map<String,String> tags()
Metadata tags associated with 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.
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.
TIMEOUT.public final JobSample jobSample()
Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed.
public DescribeJobResponse.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<DescribeJobResponse.Builder,DescribeJobResponse>toBuilder in class AwsResponsepublic static DescribeJobResponse.Builder builder()
public static Class<? extends DescribeJobResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsResponsepublic final boolean equals(Object obj)
equals in class AwsResponsepublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkResponseCopyright © 2023. All rights reserved.