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

Class Job

java.lang.Object
software.amazon.awssdk.services.databrew.model.Job
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Job.Builder,Job>
@Generated("software.amazon.awssdk:codegen") public final class Job extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Job.Builder,Job>

Represents all of the attributes of a DataBrew job.

See Also:

  • Method Details

    • accountId

      public final String accountId()

      The ID of the Amazon Web Services account that owns the job.

      Returns:
      The ID of the Amazon Web Services account that owns the job.

    • createdBy

      public final String createdBy()

      The Amazon Resource Name (ARN) of the user who created the job.

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

    • createDate

      public final Instant createDate()

      The date and time that the job was created.

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

    • datasetName

      public final String datasetName()

      A dataset that the job is to process.

      Returns:
      A dataset that the job is to process.

    • encryptionKeyArn

      public final String encryptionKeyArn()

      The Amazon Resource Name (ARN) of an encryption key that is used to protect the job output. For more information, see Encrypting data written by DataBrew jobs

      Returns:
      The Amazon Resource Name (ARN) of an encryption key that is used to protect the job output. For more information, see Encrypting data written by DataBrew jobs

    • 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 unique name of the job.

      Returns:
      The unique name of the job.

    • type

      public final JobType type()

      The job type of the job, which must be one of the following:

      • PROFILE - A job to analyze a dataset, to determine its size, data types, data distribution, and more.

      • RECIPE - A job to apply 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 of the job, which must be one of the following:

      • PROFILE - A job to analyze a dataset, to determine its size, data types, data distribution, and more.

      • RECIPE - A job to apply one or more transformations to a dataset.

      See Also:

    • typeAsString

      public final String typeAsString()

      The job type of the job, which must be one of the following:

      • PROFILE - A job to analyze a dataset, to determine its size, data types, data distribution, and more.

      • RECIPE - A job to apply 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 of the job, which must be one of the following:

      • PROFILE - A job to analyze a dataset, to determine its size, data types, data distribution, and more.

      • RECIPE - A job to apply one or more transformations to a dataset.

      See Also:

    • lastModifiedBy

      public final String lastModifiedBy()

      The Amazon Resource Name (ARN) of the user who last modified the job.

      Returns:
      The Amazon Resource Name (ARN) of the user who last modified the job.

    • lastModifiedDate

      public final Instant lastModifiedDate()

      The modification date and time of the job.

      Returns:
      The modification date and time of the job.

    • logSubscription

      public final LogSubscription logSubscription()

      The current status of Amazon CloudWatch logging for the 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:
      The current status of Amazon CloudWatch logging for the job.
      See Also:

    • logSubscriptionAsString

      public final String logSubscriptionAsString()

      The current status of Amazon CloudWatch logging for the 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:
      The current status of Amazon CloudWatch logging for the job.
      See Also:

    • maxCapacity

      public final Integer maxCapacity()

      The maximum number of nodes that can be consumed when the job processes data.

      Returns:
      The maximum number of nodes that can be consumed 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 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 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 name of the project that the job is associated with.

      Returns:
      The name of the project that the job is associated with.

    • recipeReference

      public final RecipeReference recipeReference()

      A set of steps that the job runs.

      Returns:
      A set of steps that the job runs.

    • resourceArn

      public final String resourceArn()

      The unique Amazon Resource Name (ARN) for the job.

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

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of the role to be assumed for this job.

      Returns:
      The Amazon Resource Name (ARN) of the role to be assumed for 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.

    • 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 that have been applied to 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 hasTags() method.

      Returns:
      Metadata tags that have been applied to the job.

    • jobSample

      public final JobSample jobSample()

      A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run. If a JobSample value isn't provided, the default value is used. The default value is CUSTOM_ROWS for the mode parameter and 20,000 for the size parameter.

      Returns:
      A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run. If a JobSample value isn't provided, the default value is used. The default value is CUSTOM_ROWS for the mode parameter and 20,000 for the size parameter.

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

    • toBuilder

      public Job.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<Job.Builder,Job>
      Returns:
      a builder for type T

    • builder

      public static Job.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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

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