software.amazon.awssdk.services.backup.model

Class PutBackupVaultNotificationsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutBackupVaultNotificationsRequest.Builder,PutBackupVaultNotificationsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class PutBackupVaultNotificationsRequest
extends BackupRequest
implements ToCopyableBuilder<PutBackupVaultNotificationsRequest.Builder,PutBackupVaultNotificationsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PutBackupVaultNotificationsRequest.Builder

Method Summary

Modifier and Type	Method and Description
List<BackupVaultEvent>	backupVaultEvents() An array of events that indicate the status of jobs to back up resources to the backup vault.
List<String>	backupVaultEventsAsStrings() An array of events that indicate the status of jobs to back up resources to the backup vault.
String	backupVaultName() The name of a logical container where backups are stored.
static PutBackupVaultNotificationsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasBackupVaultEvents() For responses, this returns true if the service returned a value for the BackupVaultEvents property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends PutBackupVaultNotificationsRequest.Builder>	serializableBuilderClass()
String	snsTopicArn() The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events; for example, arn:aws:sns:us-west-2:111122223333:MyVaultTopic.
PutBackupVaultNotificationsRequest.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 Amazon Web Services Region where they are created. They consist of 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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

snsTopicArn

public final String snsTopicArn()

The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events; for example, arn:aws:sns:us-west-2:111122223333:MyVaultTopic.

Returns:

The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events; for example, arn:aws:sns:us-west-2:111122223333:MyVaultTopic.

backupVaultEvents

public final List<BackupVaultEvent> backupVaultEvents()

An array of events that indicate the status of jobs to back up resources to the backup vault.

For common use cases and code samples, see Using Amazon SNS to track Backup events.

The following events are supported:

• BACKUP_JOB_STARTED | BACKUP_JOB_COMPLETED

• COPY_JOB_STARTED | COPY_JOB_SUCCESSFUL | COPY_JOB_FAILED

• RESTORE_JOB_STARTED | RESTORE_JOB_COMPLETED | RECOVERY_POINT_MODIFIED

• S3_BACKUP_OBJECT_FAILED | S3_RESTORE_OBJECT_FAILED

The list below shows items that are deprecated events (for reference) and are no longer in use. They are no longer supported and will not return statuses or notifications. Refer to the list above for current supported events.

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

Returns:

An array of events that indicate the status of jobs to back up resources to the backup vault.

For common use cases and code samples, see Using Amazon SNS to track Backup events.

The following events are supported:

• BACKUP_JOB_STARTED | BACKUP_JOB_COMPLETED

• COPY_JOB_STARTED | COPY_JOB_SUCCESSFUL | COPY_JOB_FAILED

• RESTORE_JOB_STARTED | RESTORE_JOB_COMPLETED | RECOVERY_POINT_MODIFIED

• S3_BACKUP_OBJECT_FAILED | S3_RESTORE_OBJECT_FAILED

The list below shows items that are deprecated events (for reference) and are no longer in use. They are no longer supported and will not return statuses or notifications. Refer to the list above for current supported events.

hasBackupVaultEvents

public final boolean hasBackupVaultEvents()

For responses, this returns true if the service returned a value for the BackupVaultEvents 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.

backupVaultEventsAsStrings

public final List<String> backupVaultEventsAsStrings()

An array of events that indicate the status of jobs to back up resources to the backup vault.

For common use cases and code samples, see Using Amazon SNS to track Backup events.

The following events are supported:

• BACKUP_JOB_STARTED | BACKUP_JOB_COMPLETED

• COPY_JOB_STARTED | COPY_JOB_SUCCESSFUL | COPY_JOB_FAILED

• RESTORE_JOB_STARTED | RESTORE_JOB_COMPLETED | RECOVERY_POINT_MODIFIED

• S3_BACKUP_OBJECT_FAILED | S3_RESTORE_OBJECT_FAILED

The list below shows items that are deprecated events (for reference) and are no longer in use. They are no longer supported and will not return statuses or notifications. Refer to the list above for current supported events.

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

Returns:

An array of events that indicate the status of jobs to back up resources to the backup vault.

For common use cases and code samples, see Using Amazon SNS to track Backup events.

The following events are supported:

• BACKUP_JOB_STARTED | BACKUP_JOB_COMPLETED

• COPY_JOB_STARTED | COPY_JOB_SUCCESSFUL | COPY_JOB_FAILED

• RESTORE_JOB_STARTED | RESTORE_JOB_COMPLETED | RECOVERY_POINT_MODIFIED

• S3_BACKUP_OBJECT_FAILED | S3_RESTORE_OBJECT_FAILED

The list below shows items that are deprecated events (for reference) and are no longer in use. They are no longer supported and will not return statuses or notifications. Refer to the list above for current supported events.

toBuilder

public PutBackupVaultNotificationsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutBackupVaultNotificationsRequest.Builder,PutBackupVaultNotificationsRequest>

Specified by:

toBuilder in class BackupRequest

builder

public static PutBackupVaultNotificationsRequest.Builder builder()

serializableBuilderClass

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