Package software.amazon.awssdk.services.databrew.model

Class DescribeJobResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.databrew.model.DataBrewResponse
software.amazon.awssdk.services.databrew.model.DescribeJobResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeJobResponse.Builder,DescribeJobResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeJobResponse extends DataBrewResponse implements ToCopyableBuilder<DescribeJobResponse.Builder,DescribeJobResponse>

  • Method Details

    • createDate

      public final Instant createDate()

      The date and time that the job was created.

      Returns:
      The date and time that the job was created.

    • createdBy

      public final String createdBy()

      The identifier (user name) of the user associated with the creation of the job.

      Returns:
      The identifier (user name) of the user associated with the creation of the job.

    • datasetName

      public final String datasetName()

      The dataset that the job acts upon.

      Returns:
      The dataset that the job acts 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 - 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().

      Returns:
      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.

      See Also:

    • encryptionModeAsString

      public 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().

      Returns:
      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.

      See Also:

    • name

      public final String name()

      The name of the job.

      Returns:
      The name of the job.

    • type

      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().

      Returns:
      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.

      See Also:

    • typeAsString

      public 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().

      Returns:
      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.

      See Also:

    • lastModifiedBy

      public final String lastModifiedBy()

      The identifier (user name) of the user who last modified the job.

      Returns:
      The identifier (user name) of the user who last modified the job.

    • lastModifiedDate

      public final Instant lastModifiedDate()

      The date and time that the job was last modified.

      Returns:
      The date and time that the job was last modified.

    • logSubscription

      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().

      Returns:
      Indicates whether Amazon CloudWatch logging is enabled for this job.
      See Also:

    • logSubscriptionAsString

      public 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().

      Returns:
      Indicates whether Amazon CloudWatch logging is enabled for this job.
      See Also:

    • maxCapacity

      public final Integer maxCapacity()

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

      Returns:
      The maximum number of compute nodes that DataBrew can consume 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.

    • 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 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.

    • outputs

      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.

      Returns:
      One or more artifacts that represent the output from running the job.

    • 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 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.

    • dataCatalogOutputs

      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.

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

    • databaseOutputs

      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.

      Returns:
      Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.

    • projectName

      public final String projectName()

      The DataBrew project associated with this job.

      Returns:
      The DataBrew project associated with this job.

    • profileConfiguration

      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.

      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.

    • recipeReference

      public final RecipeReference recipeReference()
      Returns the value of the RecipeReference property for this object.
      Returns:
      The value of the RecipeReference property for this object.

    • resourceArn

      public final String resourceArn()

      The Amazon Resource Name (ARN) of the job.

      Returns:
      The Amazon Resource Name (ARN) of the job.

    • roleArn

      public final String roleArn()

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

      Returns:
      The 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 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.

      Returns:
      Metadata tags associated with 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.

      Returns:
      Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed.

    • toBuilder

      public DescribeJobResponse.Builder 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 interface ToCopyableBuilder<DescribeJobResponse.Builder,DescribeJobResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeJobResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.