@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ListBackupJobSummariesRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP| Constructor and Description |
|---|
ListBackupJobSummariesRequest() |
| Modifier and Type | Method and Description |
|---|---|
ListBackupJobSummariesRequest |
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.
|
ListBackupJobSummariesRequest |
withAccountId(String accountId)
Returns the job count for the specified account.
|
ListBackupJobSummariesRequest |
withAggregationPeriod(AggregationPeriod aggregationPeriod)
This is the period that sets the boundaries for returned results.
|
ListBackupJobSummariesRequest |
withAggregationPeriod(String aggregationPeriod)
This is the period that sets the boundaries for returned results.
|
ListBackupJobSummariesRequest |
withMaxResults(Integer maxResults)
This parameter sets the maximum number of items to be returned.
|
ListBackupJobSummariesRequest |
withMessageCategory(String messageCategory)
This parameter returns the job count for the specified message category.
|
ListBackupJobSummariesRequest |
withNextToken(String nextToken)
The next item following a partial list of returned resources.
|
ListBackupJobSummariesRequest |
withResourceType(String resourceType)
Returns the job count for the specified resource type.
|
ListBackupJobSummariesRequest |
withState(BackupJobStatus state)
This parameter returns the job count for jobs with the specified state.
|
ListBackupJobSummariesRequest |
withState(String state)
This parameter returns the job count for jobs with the specified state.
|
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, withSdkRequestTimeoutpublic 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.
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.
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.
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.
public ListBackupJobSummariesRequest 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.
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.
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.
Completed with issues is a status found only in the Backup console. For API, this status refers to
jobs with a state of COMPLETED and a MessageCategory with a value other than
SUCCESS; that is, the status is completed but comes with a status message. To obtain the job count
for Completed with issues, run two GET requests, and subtract the second, smaller number:
GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&State=COMPLETED
GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&MessageCategory=SUCCESS&State=COMPLETED
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.
Completed with issues is a status found only in the Backup console. For API, this status
refers to jobs with a state of COMPLETED and a MessageCategory with a value
other than SUCCESS; that is, the status is completed but comes with a status message. To
obtain the job count for Completed with issues, run two GET requests, and subtract the
second, smaller number:
GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&State=COMPLETED
GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&MessageCategory=SUCCESS&State= COMPLETED
BackupJobStatuspublic 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.
Completed with issues is a status found only in the Backup console. For API, this status refers to
jobs with a state of COMPLETED and a MessageCategory with a value other than
SUCCESS; that is, the status is completed but comes with a status message. To obtain the job count
for Completed with issues, run two GET requests, and subtract the second, smaller number:
GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&State=COMPLETED
GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&MessageCategory=SUCCESS&State=COMPLETED
The the value ANY returns count of all states.
AGGREGATE_ALL aggregates job counts for all states and returns the sum.
Completed with issues is a status found only in the Backup console. For API, this status
refers to jobs with a state of COMPLETED and a MessageCategory with a value
other than SUCCESS; that is, the status is completed but comes with a status message. To
obtain the job count for Completed with issues, run two GET requests, and subtract the
second, smaller number:
GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&State=COMPLETED
GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&MessageCategory=SUCCESS&State= COMPLETED
BackupJobStatuspublic ListBackupJobSummariesRequest 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.
Completed with issues is a status found only in the Backup console. For API, this status refers to
jobs with a state of COMPLETED and a MessageCategory with a value other than
SUCCESS; that is, the status is completed but comes with a status message. To obtain the job count
for Completed with issues, run two GET requests, and subtract the second, smaller number:
GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&State=COMPLETED
GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&MessageCategory=SUCCESS&State=COMPLETED
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.
Completed with issues is a status found only in the Backup console. For API, this status
refers to jobs with a state of COMPLETED and a MessageCategory with a value
other than SUCCESS; that is, the status is completed but comes with a status message. To
obtain the job count for Completed with issues, run two GET requests, and subtract the
second, smaller number:
GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&State=COMPLETED
GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&MessageCategory=SUCCESS&State= COMPLETED
BackupJobStatuspublic ListBackupJobSummariesRequest withState(BackupJobStatus 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.
Completed with issues is a status found only in the Backup console. For API, this status refers to
jobs with a state of COMPLETED and a MessageCategory with a value other than
SUCCESS; that is, the status is completed but comes with a status message. To obtain the job count
for Completed with issues, run two GET requests, and subtract the second, smaller number:
GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&State=COMPLETED
GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&MessageCategory=SUCCESS&State=COMPLETED
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.
Completed with issues is a status found only in the Backup console. For API, this status
refers to jobs with a state of COMPLETED and a MessageCategory with a value
other than SUCCESS; that is, the status is completed but comes with a status message. To
obtain the job count for Completed with issues, run two GET requests, and subtract the
second, smaller number:
GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&State=COMPLETED
GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&MessageCategory=SUCCESS&State= COMPLETED
BackupJobStatuspublic 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.
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.
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.
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.
public ListBackupJobSummariesRequest 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.
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.
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.
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.
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.
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.
public ListBackupJobSummariesRequest 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.
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.
public void setAggregationPeriod(String aggregationPeriod)
This is the period that sets the boundaries for returned results.
Acceptable values include
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.
aggregationPeriod - This is the period that sets the boundaries for returned results.
Acceptable values include
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.
AggregationPeriodpublic String getAggregationPeriod()
This is the period that sets the boundaries for returned results.
Acceptable values include
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.
Acceptable values include
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.
AggregationPeriodpublic ListBackupJobSummariesRequest withAggregationPeriod(String aggregationPeriod)
This is the period that sets the boundaries for returned results.
Acceptable values include
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.
aggregationPeriod - This is the period that sets the boundaries for returned results.
Acceptable values include
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.
AggregationPeriodpublic ListBackupJobSummariesRequest withAggregationPeriod(AggregationPeriod aggregationPeriod)
This is the period that sets the boundaries for returned results.
Acceptable values include
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.
aggregationPeriod - This is the period that sets the boundaries for returned results.
Acceptable values include
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.
AggregationPeriodpublic 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.
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.
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.
The value is an integer. Range of accepted values is from 1 to 500.
public ListBackupJobSummariesRequest 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.
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.
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.
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.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.
MaxResults number of resources, NextToken allows you to return more items in
your list starting at the location pointed to by the next token.public ListBackupJobSummariesRequest 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.
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.public String toString()
toString in class ObjectObject.toString()public ListBackupJobSummariesRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()