Class JobRun

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

Represents one run of a DataBrew job.

See Also:

  • Method Details

    • attempt

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

      public final Instant completedOn()

      The date and time when the job completed processing.

      Returns:
      The date and time when the job completed processing.

    • datasetName

      public final String datasetName()

      The name of the dataset for the job to process.

      Returns:
      The name of the dataset for the job to process.

    • errorMessage

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

      public final Integer executionTime()

      The amount of time, in seconds, during which a job run consumed resources.

      Returns:
      The amount of time, in seconds, during which a job run consumed resources.

    • jobName

      public final String jobName()

      The name of the job being processed during this run.

      Returns:
      The name of the job being processed during this run.

    • runId

      public final String runId()

      The unique identifier of the job run.

      Returns:
      The unique identifier of the job run.

    • state

      public final JobRunState 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 return JobRunState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The current state of the job run entity itself.
      See Also:

    • stateAsString

      public final String 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 return JobRunState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The current state of the job run entity itself.
      See Also:

    • logSubscription

      public final LogSubscription 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 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 run.
      See Also:

    • logSubscriptionAsString

      public final String 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 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 run.
      See Also:

    • logGroupName

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

    • recipeReference

      public final RecipeReference recipeReference()

      The set of steps processed by the job.

      Returns:
      The set of steps processed by the job.

    • startedBy

      public final String startedBy()

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

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

    • startedOn

      public final Instant startedOn()

      The date and time when the job run began.

      Returns:
      The date and time when the job run began.

    • 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 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 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 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 hasValidationConfigurations() method.

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

    • toBuilder

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

    • builder

      public static JobRun.Builder builder()

    • serializableBuilderClass

      public static Class<? extends JobRun.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.