Class RestoreFromDbBackupRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.timestreaminfluxdb.model.TimestreamInfluxDbRequest
software.amazon.awssdk.services.timestreaminfluxdb.model.RestoreFromDbBackupRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<RestoreFromDbBackupRequest.Builder,RestoreFromDbBackupRequest>
@Generated("software.amazon.awssdk:codegen") public final class RestoreFromDbBackupRequest extends TimestreamInfluxDbRequest implements ToCopyableBuilder<RestoreFromDbBackupRequest.Builder,RestoreFromDbBackupRequest>

  • Method Details

    • name

      public final String name()

      The name of the new resource to create from the restore. If restoring to an existing resource, the name must match the existing resource name.

      Returns:
      The name of the new resource to create from the restore. If restoring to an existing resource, the name must match the existing resource name.

    • dbBackupId

      public final String dbBackupId()

      The identifier of the backup to restore from.

      Returns:
      The identifier of the backup to restore from.

    • restoreToTime

      public final Instant restoreToTime()

      The point in time to restore to, for continuous backups. Must be within the backup's retention window.

      Returns:
      The point in time to restore to, for continuous backups. Must be within the backup's retention window.

    • restoreMode

      public final RestoreMode restoreMode()

      Specifies whether to restore to a new resource or replace the existing resource. Valid values are NEW_RESOURCE (default) and REPLACE_EXISTING.

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

      Returns:
      Specifies whether to restore to a new resource or replace the existing resource. Valid values are NEW_RESOURCE (default) and REPLACE_EXISTING.
      See Also:

    • restoreModeAsString

      public final String restoreModeAsString()

      Specifies whether to restore to a new resource or replace the existing resource. Valid values are NEW_RESOURCE (default) and REPLACE_EXISTING.

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

      Returns:
      Specifies whether to restore to a new resource or replace the existing resource. Valid values are NEW_RESOURCE (default) and REPLACE_EXISTING.
      See Also:

    • hasVpcSubnetIds

      public final boolean hasVpcSubnetIds()
      For responses, this returns true if the service returned a value for the VpcSubnetIds 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.

    • vpcSubnetIds

      public final List<String> vpcSubnetIds()

      A list of VPC subnet IDs for the restored resource. If not specified, the restored resource uses the same subnets as the backup.

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

      Returns:
      A list of VPC subnet IDs for the restored resource. If not specified, the restored resource uses the same subnets as the backup.

    • hasVpcSecurityGroupIds

      public final boolean hasVpcSecurityGroupIds()
      For responses, this returns true if the service returned a value for the VpcSecurityGroupIds 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.

    • vpcSecurityGroupIds

      public final List<String> vpcSecurityGroupIds()

      A list of VPC security group IDs for the restored resource. If not specified, the restored resource uses the same security groups as the backup.

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

      Returns:
      A list of VPC security group IDs for the restored resource. If not specified, the restored resource uses the same security groups as the backup.

    • publiclyAccessible

      public final Boolean publiclyAccessible()

      Specifies whether the restored resource is publicly accessible.

      Returns:
      Specifies whether the restored resource is publicly accessible.

    • logDeliveryConfiguration

      public final LogDeliveryConfiguration logDeliveryConfiguration()

      Configuration for sending InfluxDB engine logs to the specified S3 bucket for the restored resource.

      Returns:
      Configuration for sending InfluxDB engine logs to the specified S3 bucket for the restored resource.

    • maintenanceSchedule

      public final MaintenanceSchedule maintenanceSchedule()

      The maintenance schedule for the restored resource.

      Returns:
      The maintenance schedule for the restored resource.

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

      A list of key-value pairs to associate with the restored resource.

      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:
      A list of key-value pairs to associate with the restored resource.

    • port

      public final Integer port()

      The port number on which the restored InfluxDB resource accepts connections.

      Returns:
      The port number on which the restored InfluxDB resource accepts connections.

    • networkType

      public final NetworkType networkType()

      Specifies the network type of the restored resource. Valid values are IPV4 and DUAL.

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

      Returns:
      Specifies the network type of the restored resource. Valid values are IPV4 and DUAL.
      See Also:

    • networkTypeAsString

      public final String networkTypeAsString()

      Specifies the network type of the restored resource. Valid values are IPV4 and DUAL.

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

      Returns:
      Specifies the network type of the restored resource. Valid values are IPV4 and DUAL.
      See Also:

    • deploymentType

      public final ResourceDeploymentType deploymentType()

      Specifies the deployment type of the restored resource. Valid values are SINGLE_AZ, WITH_MULTIAZ_STANDBY, and MULTI_NODE_READ_REPLICAS.

      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:
      Specifies the deployment type of the restored resource. Valid values are SINGLE_AZ, WITH_MULTIAZ_STANDBY, and MULTI_NODE_READ_REPLICAS.
      See Also:

    • deploymentTypeAsString

      public final String deploymentTypeAsString()

      Specifies the deployment type of the restored resource. Valid values are SINGLE_AZ, WITH_MULTIAZ_STANDBY, and MULTI_NODE_READ_REPLICAS.

      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:
      Specifies the deployment type of the restored resource. Valid values are SINGLE_AZ, WITH_MULTIAZ_STANDBY, and MULTI_NODE_READ_REPLICAS.
      See Also:

    • hasDbBackupConfigurations

      public final boolean hasDbBackupConfigurations()
      For responses, this returns true if the service returned a value for the DbBackupConfigurations 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.

    • dbBackupConfigurations

      public final List<DbBackupConfiguration> dbBackupConfigurations()

      A list of backup configurations to apply to the restored resource.

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

      Returns:
      A list of backup configurations to apply to the restored resource.

    • kmsKeyId

      public final String kmsKeyId()

      The Amazon Web Services KMS key identifier to use for encryption of the restored resource. Can be a key ID, key ARN, alias name, or alias ARN.

      Returns:
      The Amazon Web Services KMS key identifier to use for encryption of the restored resource. Can be a key ID, key ARN, alias name, or alias ARN.

    • toBuilder

      public RestoreFromDbBackupRequest.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<RestoreFromDbBackupRequest.Builder,RestoreFromDbBackupRequest>
      Specified by:
      toBuilder in class TimestreamInfluxDbRequest
      Returns:
      a builder for type T

    • builder

      public static RestoreFromDbBackupRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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