com.amazonaws.services.backup.model

Class ListCopyJobsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.backup.model.ListCopyJobsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListCopyJobsRequest
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
ListCopyJobsRequest()

Method Summary

Modifier and Type	Method and Description
ListCopyJobsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getByAccountId() The account ID to list the jobs from.
Date	getByCompleteAfter() Returns only copy jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).
Date	getByCompleteBefore() Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).
Date	getByCreatedAfter() Returns only copy jobs that were created after the specified date.
Date	getByCreatedBefore() Returns only copy jobs that were created before the specified date.
String	getByDestinationVaultArn() An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to copy from; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
String	getByResourceArn() Returns only copy jobs that match the specified resource Amazon Resource Name (ARN).
String	getByResourceType() Returns only backup jobs for the specified resources:
String	getByState() Returns only copy jobs that are in the specified state.
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	setByAccountId(String byAccountId) The account ID to list the jobs from.
void	setByCompleteAfter(Date byCompleteAfter) Returns only copy jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).
void	setByCompleteBefore(Date byCompleteBefore) Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).
void	setByCreatedAfter(Date byCreatedAfter) Returns only copy jobs that were created after the specified date.
void	setByCreatedBefore(Date byCreatedBefore) Returns only copy jobs that were created before the specified date.
void	setByDestinationVaultArn(String byDestinationVaultArn) An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to copy from; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
void	setByResourceArn(String byResourceArn) Returns only copy jobs that match the specified resource Amazon Resource Name (ARN).
void	setByResourceType(String byResourceType) Returns only backup jobs for the specified resources:
void	setByState(String byState) Returns only copy jobs that are in the specified state.
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.
ListCopyJobsRequest	withByAccountId(String byAccountId) The account ID to list the jobs from.
ListCopyJobsRequest	withByCompleteAfter(Date byCompleteAfter) Returns only copy jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).
ListCopyJobsRequest	withByCompleteBefore(Date byCompleteBefore) Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).
ListCopyJobsRequest	withByCreatedAfter(Date byCreatedAfter) Returns only copy jobs that were created after the specified date.
ListCopyJobsRequest	withByCreatedBefore(Date byCreatedBefore) Returns only copy jobs that were created before the specified date.
ListCopyJobsRequest	withByDestinationVaultArn(String byDestinationVaultArn) An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to copy from; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
ListCopyJobsRequest	withByResourceArn(String byResourceArn) Returns only copy jobs that match the specified resource Amazon Resource Name (ARN).
ListCopyJobsRequest	withByResourceType(String byResourceType) Returns only backup jobs for the specified resources:
ListCopyJobsRequest	withByState(CopyJobState byState) Returns only copy jobs that are in the specified state.
ListCopyJobsRequest	withByState(String byState) Returns only copy jobs that are in the specified state.
ListCopyJobsRequest	withMaxResults(Integer maxResults) The maximum number of items to be returned.
ListCopyJobsRequest	withNextToken(String nextToken) The next item following a partial list of returned items.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, 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

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListCopyJobsRequest

public ListCopyJobsRequest()

Method Detail

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 ListCopyJobsRequest 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 ListCopyJobsRequest 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 copy jobs that match the specified resource Amazon Resource Name (ARN).

Parameters:

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

getByResourceArn

public String getByResourceArn()

Returns only copy jobs that match the specified resource Amazon Resource Name (ARN).

Returns:

Returns only copy jobs that match the specified resource Amazon Resource Name (ARN).

withByResourceArn

public ListCopyJobsRequest withByResourceArn(String byResourceArn)

Returns only copy jobs that match the specified resource Amazon Resource Name (ARN).

Parameters:

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

Returns:

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

setByState

public void setByState(String byState)

Returns only copy jobs that are in the specified state.

Parameters:

byState - Returns only copy jobs that are in the specified state.

See Also:

CopyJobState

getByState

public String getByState()

Returns only copy jobs that are in the specified state.

Returns:

Returns only copy jobs that are in the specified state.

See Also:

CopyJobState

withByState

public ListCopyJobsRequest withByState(String byState)

Returns only copy jobs that are in the specified state.

Parameters:

byState - Returns only copy jobs that are in the specified state.

Returns:

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

See Also:

CopyJobState

withByState

public ListCopyJobsRequest withByState(CopyJobState byState)

Returns only copy jobs that are in the specified state.

Parameters:

byState - Returns only copy jobs that are in the specified state.

Returns:

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

See Also:

CopyJobState

setByCreatedBefore

public void setByCreatedBefore(Date byCreatedBefore)

Returns only copy jobs that were created before the specified date.

Parameters:

byCreatedBefore - Returns only copy jobs that were created before the specified date.

getByCreatedBefore

public Date getByCreatedBefore()

Returns only copy jobs that were created before the specified date.

Returns:

Returns only copy jobs that were created before the specified date.

withByCreatedBefore

public ListCopyJobsRequest withByCreatedBefore(Date byCreatedBefore)

Returns only copy jobs that were created before the specified date.

Parameters:

byCreatedBefore - Returns only copy jobs that were created before the specified date.

Returns:

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

setByCreatedAfter

public void setByCreatedAfter(Date byCreatedAfter)

Returns only copy jobs that were created after the specified date.

Parameters:

byCreatedAfter - Returns only copy jobs that were created after the specified date.

getByCreatedAfter

public Date getByCreatedAfter()

Returns only copy jobs that were created after the specified date.

Returns:

Returns only copy jobs that were created after the specified date.

withByCreatedAfter

public ListCopyJobsRequest withByCreatedAfter(Date byCreatedAfter)

Returns only copy jobs that were created after the specified date.

Parameters:

byCreatedAfter - Returns only copy jobs that were created after the specified date.

Returns:

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

setByResourceType

public void setByResourceType(String byResourceType)

Returns only backup jobs for the specified resources:

• Aurora for Amazon Aurora

• 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

• RDS for Amazon Relational Database Service

• Storage Gateway for Storage Gateway

• S3 for Amazon S3

• VirtualMachine for virtual machines

Parameters:

byResourceType - Returns only backup jobs for the specified resources:

• Aurora for Amazon Aurora

• 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

• RDS for Amazon Relational Database Service

• Storage Gateway for Storage Gateway

• S3 for Amazon S3

• VirtualMachine for virtual machines

getByResourceType

public String getByResourceType()

Returns only backup jobs for the specified resources:

• Aurora for Amazon Aurora

• 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

• RDS for Amazon Relational Database Service

• Storage Gateway for Storage Gateway

• S3 for Amazon S3

• VirtualMachine for virtual machines

Returns:

Returns only backup jobs for the specified resources:

• Aurora for Amazon Aurora

• 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

• RDS for Amazon Relational Database Service

• Storage Gateway for Storage Gateway

• S3 for Amazon S3

• VirtualMachine for virtual machines

withByResourceType

public ListCopyJobsRequest withByResourceType(String byResourceType)

Returns only backup jobs for the specified resources:

• Aurora for Amazon Aurora

• 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

• RDS for Amazon Relational Database Service

• Storage Gateway for Storage Gateway

• S3 for Amazon S3

• VirtualMachine for virtual machines

Parameters:

byResourceType - Returns only backup jobs for the specified resources:

• Aurora for Amazon Aurora

• 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

• RDS for Amazon Relational Database Service

• Storage Gateway for Storage Gateway

• S3 for Amazon S3

• VirtualMachine for virtual machines

Returns:

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

setByDestinationVaultArn

public void setByDestinationVaultArn(String byDestinationVaultArn)

An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to copy from; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

Parameters:

byDestinationVaultArn - An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to copy from; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

getByDestinationVaultArn

public String getByDestinationVaultArn()

An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to copy from; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

Returns:

An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to copy from; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

withByDestinationVaultArn

public ListCopyJobsRequest withByDestinationVaultArn(String byDestinationVaultArn)

An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to copy from; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

Parameters:

byDestinationVaultArn - An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to copy from; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

Returns:

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

setByAccountId

public void setByAccountId(String byAccountId)

The account ID to list the jobs from. Returns only copy jobs associated with the specified account ID.

Parameters:

byAccountId - The account ID to list the jobs from. Returns only copy jobs associated with the specified account ID.

getByAccountId

public String getByAccountId()

The account ID to list the jobs from. Returns only copy jobs associated with the specified account ID.

Returns:

The account ID to list the jobs from. Returns only copy jobs associated with the specified account ID.

withByAccountId

public ListCopyJobsRequest withByAccountId(String byAccountId)

The account ID to list the jobs from. Returns only copy jobs associated with the specified account ID.

Parameters:

byAccountId - The account ID to list the jobs from. Returns only copy jobs associated with the specified account ID.

Returns:

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

setByCompleteBefore

public void setByCompleteBefore(Date byCompleteBefore)

Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).

Parameters:

byCompleteBefore - Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).

getByCompleteBefore

public Date getByCompleteBefore()

Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).

Returns:

Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).

withByCompleteBefore

public ListCopyJobsRequest withByCompleteBefore(Date byCompleteBefore)

Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).

Parameters:

byCompleteBefore - Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).

Returns:

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

setByCompleteAfter

public void setByCompleteAfter(Date byCompleteAfter)

Returns only copy jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).

Parameters:

byCompleteAfter - Returns only copy jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).

getByCompleteAfter

public Date getByCompleteAfter()

Returns only copy jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).

Returns:

Returns only copy jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).

withByCompleteAfter

public ListCopyJobsRequest withByCompleteAfter(Date byCompleteAfter)

Returns only copy jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).

Parameters:

byCompleteAfter - Returns only copy jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).

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 ListCopyJobsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()