Package software.amazon.awssdk.services.backup.model

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>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateRecoveryPointIndexSettingsRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	backupVaultName()	The name of a logical container where backups are stored.
static UpdateRecoveryPointIndexSettingsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	iamRoleArn()	This specifies the IAM role ARN used for this operation.
Index	index()	Index can have 1 of 2 possible values, either ENABLED or DISABLED.
String	indexAsString()	Index can have 1 of 2 possible values, either ENABLED or DISABLED.
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.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateRecoveryPointIndexSettingsRequest.Builder>	serializableBuilderClass()
UpdateRecoveryPointIndexSettingsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

Index

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:

Index

toBuilder

public UpdateRecoveryPointIndexSettingsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateRecoveryPointIndexSettingsRequest.Builder,UpdateRecoveryPointIndexSettingsRequest>

Specified by:

toBuilder in class BackupRequest

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo