Class UpdateRecoveryPointIndexSettingsRequest

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

  • Method Details

    • backupVaultName

      public final String backupVaultName()

      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created.

      Accepted characters include lowercase letters, numbers, and hyphens.

      Returns:
      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created.

      Accepted characters include lowercase letters, numbers, and hyphens.

    • recoveryPointArn

      public final String recoveryPointArn()

      An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

      Returns:
      An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

    • iamRoleArn

      public final String iamRoleArn()

      This specifies the IAM role ARN used for this operation.

      For example, arn:aws:iam::123456789012:role/S3Access

      Returns:
      This specifies the IAM role ARN used for this operation.

      For example, arn:aws:iam::123456789012:role/S3Access

    • index

      public final Index index()

      Index can have 1 of 2 possible values, either ENABLED or DISABLED.

      To create a backup index for an eligible ACTIVE recovery point that does not yet have a backup index, set value to ENABLED.

      To delete a backup index, set value to DISABLED.

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

      Returns:
      Index can have 1 of 2 possible values, either ENABLED or DISABLED.

      To create a backup index for an eligible ACTIVE recovery point that does not yet have a backup index, set value to ENABLED.

      To delete a backup index, set value to DISABLED.

      See Also:

    • indexAsString

      public final String indexAsString()

      Index can have 1 of 2 possible values, either ENABLED or DISABLED.

      To create a backup index for an eligible ACTIVE recovery point that does not yet have a backup index, set value to ENABLED.

      To delete a backup index, set value to DISABLED.

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

      Returns:
      Index can have 1 of 2 possible values, either ENABLED or DISABLED.

      To create a backup index for an eligible ACTIVE recovery point that does not yet have a backup index, set value to ENABLED.

      To delete a backup index, set value to DISABLED.

      See Also:

    • toBuilder

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

    • builder

      public static UpdateRecoveryPointIndexSettingsRequest.Builder builder()

    • serializableBuilderClass

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