Class DatabaseSnapshotInfo

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

The structure that describes the snapshot information of a table in source database endpoint that Firehose reads.

Amazon Data Firehose is in preview release and is subject to change.

See Also:

  • Method Details

    • id

      public final String id()

      The identifier of the current snapshot of the table in source database endpoint.

      Amazon Data Firehose is in preview release and is subject to change.

      Returns:
      The identifier of the current snapshot of the table in source database endpoint.

      Amazon Data Firehose is in preview release and is subject to change.

    • table

      public final String table()

      The fully qualified name of the table in source database endpoint that Firehose reads.

      Amazon Data Firehose is in preview release and is subject to change.

      Returns:
      The fully qualified name of the table in source database endpoint that Firehose reads.

      Amazon Data Firehose is in preview release and is subject to change.

    • requestTimestamp

      public final Instant requestTimestamp()

      The timestamp when the current snapshot is taken on the table.

      Amazon Data Firehose is in preview release and is subject to change.

      Returns:
      The timestamp when the current snapshot is taken on the table.

      Amazon Data Firehose is in preview release and is subject to change.

    • requestedBy

      public final SnapshotRequestedBy requestedBy()

      The principal that sent the request to take the current snapshot on the table.

      Amazon Data Firehose is in preview release and is subject to change.

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

      Returns:
      The principal that sent the request to take the current snapshot on the table.

      Amazon Data Firehose is in preview release and is subject to change.

      See Also:

    • requestedByAsString

      public final String requestedByAsString()

      The principal that sent the request to take the current snapshot on the table.

      Amazon Data Firehose is in preview release and is subject to change.

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

      Returns:
      The principal that sent the request to take the current snapshot on the table.

      Amazon Data Firehose is in preview release and is subject to change.

      See Also:

    • status

      public final SnapshotStatus status()

      The status of the current snapshot of the table.

      Amazon Data Firehose is in preview release and is subject to change.

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

      Returns:
      The status of the current snapshot of the table.

      Amazon Data Firehose is in preview release and is subject to change.

      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the current snapshot of the table.

      Amazon Data Firehose is in preview release and is subject to change.

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

      Returns:
      The status of the current snapshot of the table.

      Amazon Data Firehose is in preview release and is subject to change.

      See Also:

    • failureDescription

      public final FailureDescription failureDescription()
      Returns the value of the FailureDescription property for this object.
      Returns:
      The value of the FailureDescription property for this object.

    • toBuilder

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

    • builder

      public static DatabaseSnapshotInfo.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.