Class DbBackupSummary

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

Contains a summary of a Timestream for InfluxDB backup.

See Also:

  • Method Details

    • id

      public final String id()

      Service-generated unique identifier of the backup.

      Returns:
      Service-generated unique identifier of the backup.

    • name

      public final String name()

      The customer-provided name of the backup.

      Returns:
      The customer-provided name of the backup.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the backup.

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

    • status

      public final DbBackupStatus status()

      The status of the backup. Valid values are IN_PROGRESS, COMPLETED, FAILED, DELETING, and DELETED.

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

      Returns:
      The status of the backup. Valid values are IN_PROGRESS, COMPLETED, FAILED, DELETING, and DELETED.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the backup. Valid values are IN_PROGRESS, COMPLETED, FAILED, DELETING, and DELETED.

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

      Returns:
      The status of the backup. Valid values are IN_PROGRESS, COMPLETED, FAILED, DELETING, and DELETED.
      See Also:

    • createdAt

      public final Instant createdAt()

      The time when the backup was created.

      Returns:
      The time when the backup was created.

    • expiresAfter

      public final String expiresAfter()

      The date after which the backup will be automatically deleted.

      Returns:
      The date after which the backup will be automatically deleted.

    • dbResourceId

      public final String dbResourceId()

      The identifier of the DB resource that the backup was created from.

      Returns:
      The identifier of the DB resource that the backup was created from.

    • type

      public final DbBackupType type()

      The type of backup. Valid values are HOURLY, DAILY, WEEKLY, MONTHLY, CUSTOM_SCHEDULE, ON_DEMAND, and CONTINUOUS.

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

      Returns:
      The type of backup. Valid values are HOURLY, DAILY, WEEKLY, MONTHLY, CUSTOM_SCHEDULE, ON_DEMAND, and CONTINUOUS.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of backup. Valid values are HOURLY, DAILY, WEEKLY, MONTHLY, CUSTOM_SCHEDULE, ON_DEMAND, and CONTINUOUS.

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

      Returns:
      The type of backup. Valid values are HOURLY, DAILY, WEEKLY, MONTHLY, CUSTOM_SCHEDULE, ON_DEMAND, and CONTINUOUS.
      See Also:

    • engineType

      public final EngineType engineType()

      The engine type of the resource that the backup was created from.

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

      Returns:
      The engine type of the resource that the backup was created from.
      See Also:

    • engineTypeAsString

      public final String engineTypeAsString()

      The engine type of the resource that the backup was created from.

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

      Returns:
      The engine type of the resource that the backup was created from.
      See Also:

    • deploymentType

      public final ResourceDeploymentType deploymentType()

      The deployment type of the resource that the backup was created from.

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

      Returns:
      The deployment type of the resource that the backup was created from.
      See Also:

    • deploymentTypeAsString

      public final String deploymentTypeAsString()

      The deployment type of the resource that the backup was created from.

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

      Returns:
      The deployment type of the resource that the backup was created from.
      See Also:

    • kmsKeyId

      public final String kmsKeyId()

      The Amazon Web Services KMS key ARN used for encryption of the resource at the time of backup.

      Returns:
      The Amazon Web Services KMS key ARN used for encryption of the resource at the time of backup.

    • toBuilder

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

    • builder

      public static DbBackupSummary.Builder builder()

    • serializableBuilderClass

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