Class DescribeJobRunResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeJobRunResponse.Builder,
DescribeJobRunResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Integer
attempt()
The number of times that DataBrew has attempted to run the job.builder()
final Instant
The date and time when the job completed processing.final List
<DatabaseOutput> Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.final List
<DataCatalogOutput> One or more artifacts that represent the Glue Data Catalog output from running the job.final String
The name of the dataset for the job to process.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
A message indicating an error (if any) that was encountered when the job ran.final Integer
The amount of time, in seconds, during which the job run consumed resources.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final boolean
For responses, this returns true if the service returned a value for the DatabaseOutputs property.final boolean
For responses, this returns true if the service returned a value for the DataCatalogOutputs property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Outputs property.final boolean
For responses, this returns true if the service returned a value for the ValidationConfigurations property.final String
jobName()
The name of the job being processed during this run.final JobSample
Sample configuration for profile jobs only.final String
The name of an Amazon CloudWatch log group, where the job writes diagnostic messages when it runs.final LogSubscription
The current status of Amazon CloudWatch logging for the job run.final String
The current status of Amazon CloudWatch logging for the job run.outputs()
One or more output artifacts from a job run.final ProfileConfiguration
Configuration for profile jobs.final RecipeReference
Returns the value of the RecipeReference property for this object.final String
runId()
The unique identifier of the job run.static Class
<? extends DescribeJobRunResponse.Builder> final String
The Amazon Resource Name (ARN) of the user who started the job run.final Instant
The date and time when the job run began.final JobRunState
state()
The current state of the job run entity itself.final String
The current state of the job run entity itself.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final List
<ValidationConfiguration> List of validation configurations that are applied to the profile job.Methods inherited from class software.amazon.awssdk.services.databrew.model.DataBrewResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
attempt
The number of times that DataBrew has attempted to run the job.
- Returns:
- The number of times that DataBrew has attempted to run the job.
-
completedOn
The date and time when the job completed processing.
- Returns:
- The date and time when the job completed processing.
-
datasetName
The name of the dataset for the job to process.
- Returns:
- The name of the dataset for the job to process.
-
errorMessage
A message indicating an error (if any) that was encountered when the job ran.
- Returns:
- A message indicating an error (if any) that was encountered when the job ran.
-
executionTime
The amount of time, in seconds, during which the job run consumed resources.
- Returns:
- The amount of time, in seconds, during which the job run consumed resources.
-
jobName
The name of the job being processed during this run.
- Returns:
- The name of the job being processed during this run.
-
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:
- 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 theisEmpty()
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
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.
-
runId
The unique identifier of the job run.
- Returns:
- The unique identifier of the job run.
-
state
The current state of the job run entity itself.
If the service returns an enum value that is not available in the current SDK version,
state
will returnJobRunState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The current state of the job run entity itself.
- See Also:
-
stateAsString
The current state of the job run entity itself.
If the service returns an enum value that is not available in the current SDK version,
state
will returnJobRunState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The current state of the job run entity itself.
- See Also:
-
logSubscription
The current status of Amazon CloudWatch logging for the job run.
If the service returns an enum value that is not available in the current SDK version,
logSubscription
will returnLogSubscription.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlogSubscriptionAsString()
.- Returns:
- The current status of Amazon CloudWatch logging for the job run.
- See Also:
-
logSubscriptionAsString
The current status of Amazon CloudWatch logging for the job run.
If the service returns an enum value that is not available in the current SDK version,
logSubscription
will returnLogSubscription.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlogSubscriptionAsString()
.- Returns:
- The current status of Amazon CloudWatch logging for the job run.
- See Also:
-
logGroupName
The name of an Amazon CloudWatch log group, where the job writes diagnostic messages when it runs.
- Returns:
- The name of an Amazon CloudWatch log group, where the job writes diagnostic messages when it runs.
-
hasOutputs
public final boolean hasOutputs()For responses, this returns true if the service returned a value for the Outputs property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
outputs
One or more output artifacts from a job run.
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.- Returns:
- One or more output artifacts from a job run.
-
hasDataCatalogOutputs
public final boolean hasDataCatalogOutputs()For responses, this returns true if the service returned a value for the DataCatalogOutputs property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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.- Returns:
- One or more artifacts that represent the Glue Data Catalog output from running the job.
-
hasDatabaseOutputs
public final boolean hasDatabaseOutputs()For responses, this returns true if the service returned a value for the DatabaseOutputs property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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.- Returns:
- Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
-
recipeReference
Returns the value of the RecipeReference property for this object.- Returns:
- The value of the RecipeReference property for this object.
-
startedBy
The Amazon Resource Name (ARN) of the user who started the job run.
- Returns:
- The Amazon Resource Name (ARN) of the user who started the job run.
-
startedOn
The date and time when the job run began.
- Returns:
- The date and time when the job run began.
-
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<DescribeJobRunResponse.Builder,
DescribeJobRunResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-