com.amazonaws.services.backup.model

Class ListRecoveryPointsByBackupVaultRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.backup.model.ListRecoveryPointsByBackupVaultRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListRecoveryPointsByBackupVaultRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListRecoveryPointsByBackupVaultRequest()

Method Summary

Modifier and Type	Method and Description
ListRecoveryPointsByBackupVaultRequest	clone()
boolean	equals(Object obj)
String	getBackupVaultAccountId() This parameter will sort the list of recovery points by account ID.
String	getBackupVaultName() The name of a logical container where backups are stored.
String	getByBackupPlanId() Returns only recovery points that match the specified backup plan ID.
Date	getByCreatedAfter() Returns only recovery points that were created after the specified timestamp.
Date	getByCreatedBefore() Returns only recovery points that were created before the specified timestamp.
String	getByParentRecoveryPointArn() This returns only recovery points that match the specified parent (composite) recovery point Amazon Resource Name (ARN).
String	getByResourceArn() Returns only recovery points that match the specified resource Amazon Resource Name (ARN).
String	getByResourceType() Returns only recovery points that match the specified resource type(s):
Integer	getMaxResults() The maximum number of items to be returned.
String	getNextToken() The next item following a partial list of returned items.
int	hashCode()
void	setBackupVaultAccountId(String backupVaultAccountId) This parameter will sort the list of recovery points by account ID.
void	setBackupVaultName(String backupVaultName) The name of a logical container where backups are stored.
void	setByBackupPlanId(String byBackupPlanId) Returns only recovery points that match the specified backup plan ID.
void	setByCreatedAfter(Date byCreatedAfter) Returns only recovery points that were created after the specified timestamp.
void	setByCreatedBefore(Date byCreatedBefore) Returns only recovery points that were created before the specified timestamp.
void	setByParentRecoveryPointArn(String byParentRecoveryPointArn) This returns only recovery points that match the specified parent (composite) recovery point Amazon Resource Name (ARN).
void	setByResourceArn(String byResourceArn) Returns only recovery points that match the specified resource Amazon Resource Name (ARN).
void	setByResourceType(String byResourceType) Returns only recovery points that match the specified resource type(s):
void	setMaxResults(Integer maxResults) The maximum number of items to be returned.
void	setNextToken(String nextToken) The next item following a partial list of returned items.
String	toString() Returns a string representation of this object.
ListRecoveryPointsByBackupVaultRequest	withBackupVaultAccountId(String backupVaultAccountId) This parameter will sort the list of recovery points by account ID.
ListRecoveryPointsByBackupVaultRequest	withBackupVaultName(String backupVaultName) The name of a logical container where backups are stored.
ListRecoveryPointsByBackupVaultRequest	withByBackupPlanId(String byBackupPlanId) Returns only recovery points that match the specified backup plan ID.
ListRecoveryPointsByBackupVaultRequest	withByCreatedAfter(Date byCreatedAfter) Returns only recovery points that were created after the specified timestamp.
ListRecoveryPointsByBackupVaultRequest	withByCreatedBefore(Date byCreatedBefore) Returns only recovery points that were created before the specified timestamp.
ListRecoveryPointsByBackupVaultRequest	withByParentRecoveryPointArn(String byParentRecoveryPointArn) This returns only recovery points that match the specified parent (composite) recovery point Amazon Resource Name (ARN).
ListRecoveryPointsByBackupVaultRequest	withByResourceArn(String byResourceArn) Returns only recovery points that match the specified resource Amazon Resource Name (ARN).
ListRecoveryPointsByBackupVaultRequest	withByResourceType(String byResourceType) Returns only recovery points that match the specified resource type(s):
ListRecoveryPointsByBackupVaultRequest	withMaxResults(Integer maxResults) The maximum number of items to be returned.
ListRecoveryPointsByBackupVaultRequest	withNextToken(String nextToken) The next item following a partial list of returned items.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

ListRecoveryPointsByBackupVaultRequest

public ListRecoveryPointsByBackupVaultRequest()

Method Detail

setBackupVaultName

public void setBackupVaultName(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.

Parameters:

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.

getBackupVaultName

public String getBackupVaultName()

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.

withBackupVaultName

public ListRecoveryPointsByBackupVaultRequest withBackupVaultName(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setBackupVaultAccountId

public void setBackupVaultAccountId(String backupVaultAccountId)

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

Parameters:

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

getBackupVaultAccountId

public String getBackupVaultAccountId()

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.

withBackupVaultAccountId

public ListRecoveryPointsByBackupVaultRequest withBackupVaultAccountId(String backupVaultAccountId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setNextToken

public void setNextToken(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.

Parameters:

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.

getNextToken

public String getNextToken()

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.

withNextToken

public ListRecoveryPointsByBackupVaultRequest withNextToken(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setMaxResults

public void setMaxResults(Integer maxResults)

The maximum number of items to be returned.

Parameters:

maxResults - The maximum number of items to be returned.

getMaxResults

public Integer getMaxResults()

The maximum number of items to be returned.

Returns:

The maximum number of items to be returned.

withMaxResults

public ListRecoveryPointsByBackupVaultRequest withMaxResults(Integer maxResults)

The maximum number of items to be returned.

Parameters:

maxResults - The maximum number of items to be returned.

Returns:

Returns a reference to this object so that method calls can be chained together.

setByResourceArn

public void setByResourceArn(String byResourceArn)

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

Parameters:

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

getByResourceArn

public String getByResourceArn()

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

withByResourceArn

public ListRecoveryPointsByBackupVaultRequest withByResourceArn(String byResourceArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setByResourceType

public void setByResourceType(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

Parameters:

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

getByResourceType

public String getByResourceType()

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

withByResourceType

public ListRecoveryPointsByBackupVaultRequest withByResourceType(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

Parameters:

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 a reference to this object so that method calls can be chained together.

setByBackupPlanId

public void setByBackupPlanId(String byBackupPlanId)

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

Parameters:

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

getByBackupPlanId

public String getByBackupPlanId()

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

Returns:

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

withByBackupPlanId

public ListRecoveryPointsByBackupVaultRequest withByBackupPlanId(String byBackupPlanId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setByCreatedBefore

public void setByCreatedBefore(Date byCreatedBefore)

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

Parameters:

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

getByCreatedBefore

public Date getByCreatedBefore()

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

Returns:

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

withByCreatedBefore

public ListRecoveryPointsByBackupVaultRequest withByCreatedBefore(Date byCreatedBefore)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setByCreatedAfter

public void setByCreatedAfter(Date byCreatedAfter)

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

Parameters:

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

getByCreatedAfter

public Date getByCreatedAfter()

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

Returns:

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

withByCreatedAfter

public ListRecoveryPointsByBackupVaultRequest withByCreatedAfter(Date byCreatedAfter)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setByParentRecoveryPointArn

public void setByParentRecoveryPointArn(String byParentRecoveryPointArn)

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

Parameters:

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

getByParentRecoveryPointArn

public String getByParentRecoveryPointArn()

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

withByParentRecoveryPointArn

public ListRecoveryPointsByBackupVaultRequest withByParentRecoveryPointArn(String byParentRecoveryPointArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ListRecoveryPointsByBackupVaultRequest clone()

Overrides:

clone in class AmazonWebServiceRequest