com.amazonaws.services.backup.model

Class ListBackupJobsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.backup.model.ListBackupJobsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
ListBackupJobsRequest	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.
String	getByBackupVaultName() Returns only backup jobs that will be stored in the specified backup vault.
Date	getByCompleteAfter() Returns only backup jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).
Date	getByCompleteBefore() Returns only backup jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).
Date	getByCreatedAfter() Returns only backup jobs that were created after the specified date.
Date	getByCreatedBefore() Returns only backup jobs that were created before the specified date.
String	getByParentJobId() This is a filter to list child (nested) jobs based on parent job ID.
String	getByResourceArn() Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).
String	getByResourceType() Returns only backup jobs for the specified resources:
String	getByState() Returns only backup 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	setByBackupVaultName(String byBackupVaultName) Returns only backup jobs that will be stored in the specified backup vault.
void	setByCompleteAfter(Date byCompleteAfter) Returns only backup jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).
void	setByCompleteBefore(Date byCompleteBefore) Returns only backup jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).
void	setByCreatedAfter(Date byCreatedAfter) Returns only backup jobs that were created after the specified date.
void	setByCreatedBefore(Date byCreatedBefore) Returns only backup jobs that were created before the specified date.
void	setByParentJobId(String byParentJobId) This is a filter to list child (nested) jobs based on parent job ID.
void	setByResourceArn(String byResourceArn) Returns only backup 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 backup 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.
ListBackupJobsRequest	withByAccountId(String byAccountId) The account ID to list the jobs from.
ListBackupJobsRequest	withByBackupVaultName(String byBackupVaultName) Returns only backup jobs that will be stored in the specified backup vault.
ListBackupJobsRequest	withByCompleteAfter(Date byCompleteAfter) Returns only backup jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).
ListBackupJobsRequest	withByCompleteBefore(Date byCompleteBefore) Returns only backup jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).
ListBackupJobsRequest	withByCreatedAfter(Date byCreatedAfter) Returns only backup jobs that were created after the specified date.
ListBackupJobsRequest	withByCreatedBefore(Date byCreatedBefore) Returns only backup jobs that were created before the specified date.
ListBackupJobsRequest	withByParentJobId(String byParentJobId) This is a filter to list child (nested) jobs based on parent job ID.
ListBackupJobsRequest	withByResourceArn(String byResourceArn) Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).
ListBackupJobsRequest	withByResourceType(String byResourceType) Returns only backup jobs for the specified resources:
ListBackupJobsRequest	withByState(BackupJobState byState) Returns only backup jobs that are in the specified state.
ListBackupJobsRequest	withByState(String byState) Returns only backup jobs that are in the specified state.
ListBackupJobsRequest	withMaxResults(Integer maxResults) The maximum number of items to be returned.
ListBackupJobsRequest	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

ListBackupJobsRequest

public ListBackupJobsRequest()

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

Parameters:

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

getByResourceArn

public String getByResourceArn()

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

Returns:

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

withByResourceArn

public ListBackupJobsRequest withByResourceArn(String byResourceArn)

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

Parameters:

byResourceArn - Returns only backup 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 backup jobs that are in the specified state.

Parameters:

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

See Also:

BackupJobState

getByState

public String getByState()

Returns only backup jobs that are in the specified state.

Returns:

Returns only backup jobs that are in the specified state.

See Also:

BackupJobState

withByState

public ListBackupJobsRequest withByState(String byState)

Returns only backup jobs that are in the specified state.

Parameters:

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

Returns:

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

See Also:

BackupJobState

withByState

public ListBackupJobsRequest withByState(BackupJobState byState)

Returns only backup jobs that are in the specified state.

Parameters:

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

Returns:

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

See Also:

BackupJobState

setByBackupVaultName

public void setByBackupVaultName(String byBackupVaultName)

Returns only backup jobs that will be stored in the specified backup vault. 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.

Parameters:

byBackupVaultName - Returns only backup jobs that will be stored in the specified backup vault. 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.

getByBackupVaultName

public String getByBackupVaultName()

Returns only backup jobs that will be stored in the specified backup vault. 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:

Returns only backup jobs that will be stored in the specified backup vault. 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.

withByBackupVaultName

public ListBackupJobsRequest withByBackupVaultName(String byBackupVaultName)

Returns only backup jobs that will be stored in the specified backup vault. 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.

Parameters:

byBackupVaultName - Returns only backup jobs that will be stored in the specified backup vault. 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:

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

setByCreatedBefore

public void setByCreatedBefore(Date byCreatedBefore)

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

Parameters:

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

getByCreatedBefore

public Date getByCreatedBefore()

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

Returns:

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

withByCreatedBefore

public ListBackupJobsRequest withByCreatedBefore(Date byCreatedBefore)

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

Parameters:

byCreatedBefore - Returns only backup 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 backup jobs that were created after the specified date.

Parameters:

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

getByCreatedAfter

public Date getByCreatedAfter()

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

Returns:

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

withByCreatedAfter

public ListBackupJobsRequest withByCreatedAfter(Date byCreatedAfter)

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

Parameters:

byCreatedAfter - Returns only backup 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 ListBackupJobsRequest 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.

setByAccountId

public void setByAccountId(String byAccountId)

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

If used from an Organizations management account, passing * returns all jobs across the organization.

Parameters:

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

If used from an Organizations management account, passing * returns all jobs across the organization.

getByAccountId

public String getByAccountId()

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

If used from an Organizations management account, passing * returns all jobs across the organization.

Returns:

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

If used from an Organizations management account, passing * returns all jobs across the organization.

withByAccountId

public ListBackupJobsRequest withByAccountId(String byAccountId)

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

If used from an Organizations management account, passing * returns all jobs across the organization.

Parameters:

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

If used from an Organizations management account, passing * returns all jobs across the organization.

Returns:

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

setByCompleteAfter

public void setByCompleteAfter(Date byCompleteAfter)

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

Parameters:

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

getByCompleteAfter

public Date getByCompleteAfter()

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

Returns:

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

withByCompleteAfter

public ListBackupJobsRequest withByCompleteAfter(Date byCompleteAfter)

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

Parameters:

byCompleteAfter - Returns only backup 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.

setByCompleteBefore

public void setByCompleteBefore(Date byCompleteBefore)

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

Parameters:

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

getByCompleteBefore

public Date getByCompleteBefore()

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

Returns:

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

withByCompleteBefore

public ListBackupJobsRequest withByCompleteBefore(Date byCompleteBefore)

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

Parameters:

byCompleteBefore - Returns only backup 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.

setByParentJobId

public void setByParentJobId(String byParentJobId)

This is a filter to list child (nested) jobs based on parent job ID.

Parameters:

byParentJobId - This is a filter to list child (nested) jobs based on parent job ID.

getByParentJobId

public String getByParentJobId()

This is a filter to list child (nested) jobs based on parent job ID.

Returns:

This is a filter to list child (nested) jobs based on parent job ID.

withByParentJobId

public ListBackupJobsRequest withByParentJobId(String byParentJobId)

This is a filter to list child (nested) jobs based on parent job ID.

Parameters:

byParentJobId - This is a filter to list child (nested) jobs based on parent job ID.

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 ListBackupJobsRequest 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()