com.amazonaws.services.backup.model

Class ListCopyJobSummariesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.backup.model.ListCopyJobSummariesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
ListCopyJobSummariesRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAccountId() Returns the job count for the specified account.
String	getAggregationPeriod() This is the period that sets the boundaries for returned results.
Integer	getMaxResults() This parameter sets the maximum number of items to be returned.
String	getMessageCategory() This parameter returns the job count for the specified message category.
String	getNextToken() The next item following a partial list of returned resources.
String	getResourceType() Returns the job count for the specified resource type.
String	getState() This parameter returns the job count for jobs with the specified state.
int	hashCode()
void	setAccountId(String accountId) Returns the job count for the specified account.
void	setAggregationPeriod(String aggregationPeriod) This is the period that sets the boundaries for returned results.
void	setMaxResults(Integer maxResults) This parameter sets the maximum number of items to be returned.
void	setMessageCategory(String messageCategory) This parameter returns the job count for the specified message category.
void	setNextToken(String nextToken) The next item following a partial list of returned resources.
void	setResourceType(String resourceType) Returns the job count for the specified resource type.
void	setState(String state) This parameter returns the job count for jobs with the specified state.
String	toString() Returns a string representation of this object.
ListCopyJobSummariesRequest	withAccountId(String accountId) Returns the job count for the specified account.
ListCopyJobSummariesRequest	withAggregationPeriod(AggregationPeriod aggregationPeriod) This is the period that sets the boundaries for returned results.
ListCopyJobSummariesRequest	withAggregationPeriod(String aggregationPeriod) This is the period that sets the boundaries for returned results.
ListCopyJobSummariesRequest	withMaxResults(Integer maxResults) This parameter sets the maximum number of items to be returned.
ListCopyJobSummariesRequest	withMessageCategory(String messageCategory) This parameter returns the job count for the specified message category.
ListCopyJobSummariesRequest	withNextToken(String nextToken) The next item following a partial list of returned resources.
ListCopyJobSummariesRequest	withResourceType(String resourceType) Returns the job count for the specified resource type.
ListCopyJobSummariesRequest	withState(CopyJobStatus state) This parameter returns the job count for jobs with the specified state.
ListCopyJobSummariesRequest	withState(String state) This parameter returns the job count for jobs with the specified state.

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

ListCopyJobSummariesRequest

public ListCopyJobSummariesRequest()

Method Detail

setAccountId

public void setAccountId(String accountId)

Returns the job count for the specified account.

If the request is sent from a member account or an account not part of Amazon Web Services Organizations, jobs within requestor's account will be returned.

Root, admin, and delegated administrator accounts can use the value ANY to return job counts from every account in the organization.

AGGREGATE_ALL aggregates job counts from all accounts within the authenticated organization, then returns the sum.

Parameters:

accountId - Returns the job count for the specified account.

If the request is sent from a member account or an account not part of Amazon Web Services Organizations, jobs within requestor's account will be returned.

Root, admin, and delegated administrator accounts can use the value ANY to return job counts from every account in the organization.

AGGREGATE_ALL aggregates job counts from all accounts within the authenticated organization, then returns the sum.

getAccountId

public String getAccountId()

Returns the job count for the specified account.

If the request is sent from a member account or an account not part of Amazon Web Services Organizations, jobs within requestor's account will be returned.

Root, admin, and delegated administrator accounts can use the value ANY to return job counts from every account in the organization.

AGGREGATE_ALL aggregates job counts from all accounts within the authenticated organization, then returns the sum.

Returns:

Returns the job count for the specified account.

If the request is sent from a member account or an account not part of Amazon Web Services Organizations, jobs within requestor's account will be returned.

Root, admin, and delegated administrator accounts can use the value ANY to return job counts from every account in the organization.

AGGREGATE_ALL aggregates job counts from all accounts within the authenticated organization, then returns the sum.

withAccountId

public ListCopyJobSummariesRequest withAccountId(String accountId)

Returns the job count for the specified account.

If the request is sent from a member account or an account not part of Amazon Web Services Organizations, jobs within requestor's account will be returned.

Root, admin, and delegated administrator accounts can use the value ANY to return job counts from every account in the organization.

AGGREGATE_ALL aggregates job counts from all accounts within the authenticated organization, then returns the sum.

Parameters:

accountId - Returns the job count for the specified account.

If the request is sent from a member account or an account not part of Amazon Web Services Organizations, jobs within requestor's account will be returned.

Root, admin, and delegated administrator accounts can use the value ANY to return job counts from every account in the organization.

AGGREGATE_ALL aggregates job counts from all accounts within the authenticated organization, then returns the sum.

Returns:

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

setState

public void setState(String state)

This parameter returns the job count for jobs with the specified state.

The the value ANY returns count of all states.

AGGREGATE_ALL aggregates job counts for all states and returns the sum.

Parameters:

state - This parameter returns the job count for jobs with the specified state.

The the value ANY returns count of all states.

AGGREGATE_ALL aggregates job counts for all states and returns the sum.

See Also:

CopyJobStatus

getState

public String getState()

This parameter returns the job count for jobs with the specified state.

The the value ANY returns count of all states.

AGGREGATE_ALL aggregates job counts for all states and returns the sum.

Returns:

This parameter returns the job count for jobs with the specified state.

The the value ANY returns count of all states.

AGGREGATE_ALL aggregates job counts for all states and returns the sum.

See Also:

CopyJobStatus

withState

public ListCopyJobSummariesRequest withState(String state)

This parameter returns the job count for jobs with the specified state.

The the value ANY returns count of all states.

AGGREGATE_ALL aggregates job counts for all states and returns the sum.

Parameters:

state - This parameter returns the job count for jobs with the specified state.

The the value ANY returns count of all states.

AGGREGATE_ALL aggregates job counts for all states and returns the sum.

Returns:

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

See Also:

CopyJobStatus

withState

public ListCopyJobSummariesRequest withState(CopyJobStatus state)

This parameter returns the job count for jobs with the specified state.

The the value ANY returns count of all states.

AGGREGATE_ALL aggregates job counts for all states and returns the sum.

Parameters:

state - This parameter returns the job count for jobs with the specified state.

The the value ANY returns count of all states.

AGGREGATE_ALL aggregates job counts for all states and returns the sum.

Returns:

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

See Also:

CopyJobStatus

setResourceType

public void setResourceType(String resourceType)

Returns the job count for the specified resource type. Use request GetSupportedResourceTypes to obtain strings for supported resource types.

The the value ANY returns count of all resource types.

AGGREGATE_ALL aggregates job counts for all resource types and returns the sum.

The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

Parameters:

resourceType - Returns the job count for the specified resource type. Use request GetSupportedResourceTypes to obtain strings for supported resource types.

The the value ANY returns count of all resource types.

AGGREGATE_ALL aggregates job counts for all resource types and returns the sum.

The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

getResourceType

public String getResourceType()

Returns the job count for the specified resource type. Use request GetSupportedResourceTypes to obtain strings for supported resource types.

The the value ANY returns count of all resource types.

AGGREGATE_ALL aggregates job counts for all resource types and returns the sum.

The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

Returns:

Returns the job count for the specified resource type. Use request GetSupportedResourceTypes to obtain strings for supported resource types.

The the value ANY returns count of all resource types.

AGGREGATE_ALL aggregates job counts for all resource types and returns the sum.

The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

withResourceType

public ListCopyJobSummariesRequest withResourceType(String resourceType)

Returns the job count for the specified resource type. Use request GetSupportedResourceTypes to obtain strings for supported resource types.

The the value ANY returns count of all resource types.

AGGREGATE_ALL aggregates job counts for all resource types and returns the sum.

The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

Parameters:

resourceType - Returns the job count for the specified resource type. Use request GetSupportedResourceTypes to obtain strings for supported resource types.

The the value ANY returns count of all resource types.

AGGREGATE_ALL aggregates job counts for all resource types and returns the sum.

The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

Returns:

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

setMessageCategory

public void setMessageCategory(String messageCategory)

This parameter returns the job count for the specified message category.

Example accepted strings include AccessDenied, Success, and InvalidParameters. See Monitoring for a list of accepted MessageCategory strings.

The the value ANY returns count of all message categories.

AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.

Parameters:

messageCategory - This parameter returns the job count for the specified message category.

Example accepted strings include AccessDenied, Success, and InvalidParameters. See Monitoring for a list of accepted MessageCategory strings.

The the value ANY returns count of all message categories.

AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.

getMessageCategory

public String getMessageCategory()

This parameter returns the job count for the specified message category.

Example accepted strings include AccessDenied, Success, and InvalidParameters. See Monitoring for a list of accepted MessageCategory strings.

The the value ANY returns count of all message categories.

AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.

Returns:

This parameter returns the job count for the specified message category.

Example accepted strings include AccessDenied, Success, and InvalidParameters. See Monitoring for a list of accepted MessageCategory strings.

The the value ANY returns count of all message categories.

AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.

withMessageCategory

public ListCopyJobSummariesRequest withMessageCategory(String messageCategory)

This parameter returns the job count for the specified message category.

Example accepted strings include AccessDenied, Success, and InvalidParameters. See Monitoring for a list of accepted MessageCategory strings.

The the value ANY returns count of all message categories.

AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.

Parameters:

messageCategory - This parameter returns the job count for the specified message category.

Example accepted strings include AccessDenied, Success, and InvalidParameters. See Monitoring for a list of accepted MessageCategory strings.

The the value ANY returns count of all message categories.

AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.

Returns:

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

setAggregationPeriod

public void setAggregationPeriod(String aggregationPeriod)

This is the period that sets the boundaries for returned results.

• ONE_DAY for daily job count for the prior 14 days.

• SEVEN_DAYS for the aggregated job count for the prior 7 days.

• FOURTEEN_DAYS for aggregated job count for prior 14 days.

Parameters:

aggregationPeriod - This is the period that sets the boundaries for returned results.

• ONE_DAY for daily job count for the prior 14 days.

• SEVEN_DAYS for the aggregated job count for the prior 7 days.

• FOURTEEN_DAYS for aggregated job count for prior 14 days.

See Also:

AggregationPeriod

getAggregationPeriod

public String getAggregationPeriod()

This is the period that sets the boundaries for returned results.

• ONE_DAY for daily job count for the prior 14 days.

• SEVEN_DAYS for the aggregated job count for the prior 7 days.

• FOURTEEN_DAYS for aggregated job count for prior 14 days.

Returns:

This is the period that sets the boundaries for returned results.

• ONE_DAY for daily job count for the prior 14 days.

• SEVEN_DAYS for the aggregated job count for the prior 7 days.

• FOURTEEN_DAYS for aggregated job count for prior 14 days.

See Also:

AggregationPeriod

withAggregationPeriod

public ListCopyJobSummariesRequest withAggregationPeriod(String aggregationPeriod)

This is the period that sets the boundaries for returned results.

• ONE_DAY for daily job count for the prior 14 days.

• SEVEN_DAYS for the aggregated job count for the prior 7 days.

• FOURTEEN_DAYS for aggregated job count for prior 14 days.

Parameters:

aggregationPeriod - This is the period that sets the boundaries for returned results.

• ONE_DAY for daily job count for the prior 14 days.

• SEVEN_DAYS for the aggregated job count for the prior 7 days.

• FOURTEEN_DAYS for aggregated job count for prior 14 days.

Returns:

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

See Also:

AggregationPeriod

withAggregationPeriod

public ListCopyJobSummariesRequest withAggregationPeriod(AggregationPeriod aggregationPeriod)

This is the period that sets the boundaries for returned results.

• ONE_DAY for daily job count for the prior 14 days.

• SEVEN_DAYS for the aggregated job count for the prior 7 days.

• FOURTEEN_DAYS for aggregated job count for prior 14 days.

Parameters:

aggregationPeriod - This is the period that sets the boundaries for returned results.

• ONE_DAY for daily job count for the prior 14 days.

• SEVEN_DAYS for the aggregated job count for the prior 7 days.

• FOURTEEN_DAYS for aggregated job count for prior 14 days.

Returns:

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

See Also:

AggregationPeriod

setMaxResults

public void setMaxResults(Integer maxResults)

This parameter sets the maximum number of items to be returned.

The value is an integer. Range of accepted values is from 1 to 500.

Parameters:

maxResults - This parameter sets the maximum number of items to be returned.

The value is an integer. Range of accepted values is from 1 to 500.

getMaxResults

public Integer getMaxResults()

This parameter sets the maximum number of items to be returned.

The value is an integer. Range of accepted values is from 1 to 500.

Returns:

This parameter sets the maximum number of items to be returned.

The value is an integer. Range of accepted values is from 1 to 500.

withMaxResults

public ListCopyJobSummariesRequest withMaxResults(Integer maxResults)

This parameter sets the maximum number of items to be returned.

The value is an integer. Range of accepted values is from 1 to 500.

Parameters:

maxResults - This parameter sets the maximum number of items to be returned.

The value is an integer. Range of accepted values is from 1 to 500.

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 resources. For example, if a request is made to return MaxResults number of resources, 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 resources. For example, if a request is made to return MaxResults number of resources, 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 resources. For example, if a request is made to return MaxResults number of resources, 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 resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

withNextToken

public ListCopyJobSummariesRequest withNextToken(String nextToken)

The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, 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 resources. For example, if a request is made to return MaxResults number of resources, 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.

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