Class ListBackupJobSummariesRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListBackupJobSummariesRequest.Builder,
ListBackupJobSummariesRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
Returns the job count for the specified account.final AggregationPeriod
This is the period that sets the boundaries for returned results.final String
This is the period that sets the boundaries for returned results.builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final Integer
This parameter sets the maximum number of items to be returned.final String
This parameter returns the job count for the specified message category.final String
The next item following a partial list of returned resources.final String
Returns the job count for the specified resource type.static Class
<? extends ListBackupJobSummariesRequest.Builder> final BackupJobStatus
state()
This parameter returns the job count for jobs with the specified state.final String
This parameter returns the job count for jobs with the specified state.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 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.
-
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 ofCOMPLETED
and aMessageCategory
with a value other thanSUCCESS
; that is, the status is completed but comes with a status message. To obtain the job count forCompleted 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
If the service returns an enum value that is not available in the current SDK version,
state
will returnBackupJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- 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.Completed with issues
is a status found only in the Backup console. For API, this status refers to jobs with a state ofCOMPLETED
and aMessageCategory
with a value other thanSUCCESS
; that is, the status is completed but comes with a status message. To obtain the job count forCompleted 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
- See Also:
-
stateAsString
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 ofCOMPLETED
and aMessageCategory
with a value other thanSUCCESS
; that is, the status is completed but comes with a status message. To obtain the job count forCompleted 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
If the service returns an enum value that is not available in the current SDK version,
state
will returnBackupJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- 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.Completed with issues
is a status found only in the Backup console. For API, this status refers to jobs with a state ofCOMPLETED
and aMessageCategory
with a value other thanSUCCESS
; that is, the status is completed but comes with a status message. To obtain the job count forCompleted 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
- See Also:
-
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 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.
-
messageCategory
This parameter returns the job count for the specified message category.
Example accepted strings include
AccessDenied
,Success
, andInvalidParameters
. 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
, andInvalidParameters
. 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.
-
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.
If the service returns an enum value that is not available in the current SDK version,
aggregationPeriod
will returnAggregationPeriod.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromaggregationPeriodAsString()
.- Returns:
- 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.
-
- See Also:
-
-
aggregationPeriodAsString
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.
If the service returns an enum value that is not available in the current SDK version,
aggregationPeriod
will returnAggregationPeriod.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromaggregationPeriodAsString()
.- Returns:
- 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.
-
- See Also:
-
-
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:
- 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.
-
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:
- 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.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ListBackupJobSummariesRequest.Builder,
ListBackupJobSummariesRequest> - Specified by:
toBuilder
in classBackupRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-