java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.backup.model.BackupRequest
    - - software.amazon.awssdk.services.backup.model.ListBackupJobSummariesRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<ListBackupJobSummariesRequest.Builder,ListBackupJobSummariesRequest>

@Generated("software.amazon.awssdk:codegen")
public final class ListBackupJobSummariesRequest
extends BackupRequest
implements ToCopyableBuilder<ListBackupJobSummariesRequest.Builder,ListBackupJobSummariesRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ListBackupJobSummariesRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`accountId()`	Returns the job count for the specified account.
`AggregationPeriod`	`aggregationPeriod()`	This is the period that sets the boundaries for returned results.
`String`	`aggregationPeriodAsString()`	This is the period that sets the boundaries for returned results.
`static ListBackupJobSummariesRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Integer`	`maxResults()`	This parameter sets the maximum number of items to be returned.
`String`	`messageCategory()`	This parameter returns the job count for the specified message category.
`String`	`nextToken()`	The next item following a partial list of returned resources.
`String`	`resourceType()`	Returns the job count for the specified resource type.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ListBackupJobSummariesRequest.Builder>`	`serializableBuilderClass()`
`BackupJobStatus`	`state()`	This parameter returns the job count for jobs with the specified state.
`String`	`stateAsString()`	This parameter returns the job count for jobs with the specified state.
`ListBackupJobSummariesRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - accountId
```
public final 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.
    
    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
```
public final 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
    
    If the service returns an enum value that is not available in the current SDK version, state will return BackupJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    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 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
    
    See Also:
    
    BackupJobStatus
  - stateAsString
```
public final String 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 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
    
    If the service returns an enum value that is not available in the current SDK version, state will return BackupJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    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 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
    
    See Also:
    
    BackupJobStatus
  - resourceType
```
public final 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.
    
    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
```
public final 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.
    
    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.
  - aggregationPeriod
```
public final 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.
    
    If the service returns an enum value that is not available in the current SDK version, aggregationPeriod will return AggregationPeriod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from aggregationPeriodAsString().
    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:
    
    AggregationPeriod
  - aggregationPeriodAsString
```
public final String 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 return AggregationPeriod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from aggregationPeriodAsString().
    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:
    
    AggregationPeriod
  - maxResults
```
public final 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.
    
    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
```
public final 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.
    
    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
```
public ListBackupJobSummariesRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ListBackupJobSummariesRequest.Builder,ListBackupJobSummariesRequest>
    
    Specified by:
    
    toBuilder in class BackupRequest
  - builder
```
public static ListBackupJobSummariesRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ListBackupJobSummariesRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class ListBackupJobSummariesRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

accountId

state

stateAsString

resourceType

messageCategory

aggregationPeriod

aggregationPeriodAsString

maxResults

nextToken

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields