Class BatchLoadTaskDescription

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

Details about a batch load task.

See Also:

  • Method Details

    • taskId

      public final String taskId()

      The ID of the batch load task.

      Returns:
      The ID of the batch load task.

    • errorMessage

      public final String errorMessage()

      Returns:

    • dataSourceConfiguration

      public final DataSourceConfiguration dataSourceConfiguration()

      Configuration details about the data source for a batch load task.

      Returns:
      Configuration details about the data source for a batch load task.

    • progressReport

      public final BatchLoadProgressReport progressReport()

      Returns:

    • reportConfiguration

      public final ReportConfiguration reportConfiguration()

      Report configuration for a batch load task. This contains details about where error reports are stored.

      Returns:
      Report configuration for a batch load task. This contains details about where error reports are stored.

    • dataModelConfiguration

      public final DataModelConfiguration dataModelConfiguration()

      Data model configuration for a batch load task. This contains details about where a data model for a batch load task is stored.

      Returns:
      Data model configuration for a batch load task. This contains details about where a data model for a batch load task is stored.

    • targetDatabaseName

      public final String targetDatabaseName()

      Returns:

    • targetTableName

      public final String targetTableName()

      Returns:

    • taskStatus

      public final BatchLoadStatus taskStatus()

      Status of the batch load task.

      If the service returns an enum value that is not available in the current SDK version, taskStatus will return BatchLoadStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from taskStatusAsString().

      Returns:
      Status of the batch load task.
      See Also:

    • taskStatusAsString

      public final String taskStatusAsString()

      Status of the batch load task.

      If the service returns an enum value that is not available in the current SDK version, taskStatus will return BatchLoadStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from taskStatusAsString().

      Returns:
      Status of the batch load task.
      See Also:

    • recordVersion

      public final Long recordVersion()

      Returns:

    • creationTime

      public final Instant creationTime()

      The time when the Timestream batch load task was created.

      Returns:
      The time when the Timestream batch load task was created.

    • lastUpdatedTime

      public final Instant lastUpdatedTime()

      The time when the Timestream batch load task was last updated.

      Returns:
      The time when the Timestream batch load task was last updated.

    • resumableUntil

      public final Instant resumableUntil()

      Returns:

    • toBuilder

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

    • builder

      public static BatchLoadTaskDescription.Builder builder()

    • serializableBuilderClass

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