Interface ListCopyJobSummariesRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,BackupRequest.Builder
,Buildable
,CopyableBuilder<ListCopyJobSummariesRequest.Builder,
,ListCopyJobSummariesRequest> SdkBuilder<ListCopyJobSummariesRequest.Builder,
,ListCopyJobSummariesRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
ListCopyJobSummariesRequest
-
Method Summary
Modifier and TypeMethodDescriptionReturns the job count for the specified account.aggregationPeriod
(String aggregationPeriod) This is the period that sets the boundaries for returned results.aggregationPeriod
(AggregationPeriod aggregationPeriod) This is the period that sets the boundaries for returned results.maxResults
(Integer maxResults) This parameter sets the maximum number of items to be returned.messageCategory
(String messageCategory) This parameter returns the job count for the specified message category.The next item following a partial list of returned resources.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.resourceType
(String resourceType) Returns the job count for the specified resource type.This parameter returns the job count for jobs with the specified state.state
(CopyJobStatus state) This parameter returns the job count for jobs with the specified state.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.services.backup.model.BackupRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
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.- 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.
-
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:
-
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:
-
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 requestGetSupportedResourceTypes
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.
-
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.- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
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
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:
-
-
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.
-
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 returnMaxResults
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.
-
overrideConfiguration
ListCopyJobSummariesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
ListCopyJobSummariesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-