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

Class ListRecoveryPointsByBackupVaultRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListRecoveryPointsByBackupVaultRequest.Builder,ListRecoveryPointsByBackupVaultRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListRecoveryPointsByBackupVaultRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	backupVaultAccountId()	This parameter will sort the list of recovery points by account ID.
String	backupVaultName()	The name of a logical container where backups are stored.
static ListRecoveryPointsByBackupVaultRequest.Builder	builder()
String	byBackupPlanId()	Returns only recovery points that match the specified backup plan ID.
Instant	byCreatedAfter()	Returns only recovery points that were created after the specified timestamp.
Instant	byCreatedBefore()	Returns only recovery points that were created before the specified timestamp.
String	byParentRecoveryPointArn()	This returns only recovery points that match the specified parent (composite) recovery point Amazon Resource Name (ARN).
String	byResourceArn()	Returns only recovery points that match the specified resource Amazon Resource Name (ARN).
String	byResourceType()	Returns only recovery points that match the specified resource type(s):
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults()	The maximum number of items to be returned.
String	nextToken()	The next item following a partial list of returned items.
List<SdkField<?>>	sdkFields()
static Class<? extends ListRecoveryPointsByBackupVaultRequest.Builder>	serializableBuilderClass()
ListRecoveryPointsByBackupVaultRequest.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.

Backup vault name might not be available when a supported service creates the backup.

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.

Backup vault name might not be available when a supported service creates the backup.

backupVaultAccountId

public final String backupVaultAccountId()

This parameter will sort the list of recovery points by account ID.

Returns:

This parameter will sort the list of recovery points by account ID.

nextToken

public final String nextToken()

The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Returns:

The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

maxResults

public final Integer maxResults()

The maximum number of items to be returned.

Returns:

The maximum number of items to be returned.

byResourceArn

public final String byResourceArn()

Returns only recovery points that match the specified resource Amazon Resource Name (ARN).

Returns:

Returns only recovery points that match the specified resource Amazon Resource Name (ARN).

byResourceType

public final String byResourceType()

Returns only recovery points that match the specified resource type(s):

• Aurora for Amazon Aurora

• CloudFormation for CloudFormation

• DocumentDB for Amazon DocumentDB (with MongoDB compatibility)

• DynamoDB for Amazon DynamoDB

• EBS for Amazon Elastic Block Store

• EC2 for Amazon Elastic Compute Cloud

• EFS for Amazon Elastic File System

• FSx for Amazon FSx

• Neptune for Amazon Neptune

• Redshift for Amazon Redshift

• RDS for Amazon Relational Database Service

• SAP HANA on Amazon EC2 for SAP HANA databases

• Storage Gateway for Storage Gateway

• S3 for Amazon S3

• Timestream for Amazon Timestream

• VirtualMachine for virtual machines

Returns:

Returns only recovery points that match the specified resource type(s):

• Aurora for Amazon Aurora

• CloudFormation for CloudFormation

• DocumentDB for Amazon DocumentDB (with MongoDB compatibility)

• DynamoDB for Amazon DynamoDB

• EBS for Amazon Elastic Block Store

• EC2 for Amazon Elastic Compute Cloud

• EFS for Amazon Elastic File System

• FSx for Amazon FSx

• Neptune for Amazon Neptune

• Redshift for Amazon Redshift

• RDS for Amazon Relational Database Service

• SAP HANA on Amazon EC2 for SAP HANA databases

• Storage Gateway for Storage Gateway

• S3 for Amazon S3

• Timestream for Amazon Timestream

• VirtualMachine for virtual machines

byBackupPlanId

public final String byBackupPlanId()

Returns only recovery points that match the specified backup plan ID.

Returns:

Returns only recovery points that match the specified backup plan ID.

byCreatedBefore

public final Instant byCreatedBefore()

Returns only recovery points that were created before the specified timestamp.

Returns:

Returns only recovery points that were created before the specified timestamp.

byCreatedAfter

public final Instant byCreatedAfter()

Returns only recovery points that were created after the specified timestamp.

Returns:

Returns only recovery points that were created after the specified timestamp.

byParentRecoveryPointArn

public final String byParentRecoveryPointArn()

This returns only recovery points that match the specified parent (composite) recovery point Amazon Resource Name (ARN).

Returns:

This returns only recovery points that match the specified parent (composite) recovery point Amazon Resource Name (ARN).

toBuilder

public ListRecoveryPointsByBackupVaultRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListRecoveryPointsByBackupVaultRequest.Builder,ListRecoveryPointsByBackupVaultRequest>

Specified by:

toBuilder in class BackupRequest

builder

public static ListRecoveryPointsByBackupVaultRequest.Builder builder()

serializableBuilderClass

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