Class BackupJobSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<BackupJobSummary.Builder,
BackupJobSummary>
This is a summary of jobs created or running within the most recent 30 days.
The returned summary may contain the following: Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The account ID that owns the jobs within the summary.static BackupJobSummary.Builder
builder()
final Integer
count()
The value as a number of jobs in a job summary.final Instant
endTime()
The value of time in number format of a job end time.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) final int
hashCode()
final String
This parameter is the job count for the specified message category.final String
region()
The Amazon Web Services Regions within the job summary.final String
This value is the job count for the specified resource type.static Class
<? extends BackupJobSummary.Builder> final Instant
The value of time in number format of a job start time.final BackupJobStatus
state()
This value is job count for jobs with the specified state.final String
This value is 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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
region
The Amazon Web Services Regions within the job summary.
- Returns:
- The Amazon Web Services Regions within the job summary.
-
accountId
The account ID that owns the jobs within the summary.
- Returns:
- The account ID that owns the jobs within the summary.
-
state
This value is job count for jobs with the specified state.
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 value is job count for jobs with the specified state.
- See Also:
-
stateAsString
This value is job count for jobs with the specified state.
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 value is job count for jobs with the specified state.
- See Also:
-
resourceType
This value is the job count for the specified resource type. The request
GetSupportedResourceTypes
returns strings for supported resource types.- Returns:
- This value is the job count for the specified resource type. The request
GetSupportedResourceTypes
returns strings for supported resource types.
-
messageCategory
This parameter is the job count for the specified message category.
Example strings include
AccessDenied
,Success
, andInvalidParameters
. See Monitoring for a list of 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 is the job count for the specified message category.
Example strings include
AccessDenied
,Success
, andInvalidParameters
. See Monitoring for a list of 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.
-
count
The value as a number of jobs in a job summary.
- Returns:
- The value as a number of jobs in a job summary.
-
startTime
The value of time in number format of a job start time.
This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
- Returns:
- The value of time in number format of a job start time.
This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
-
endTime
The value of time in number format of a job end time.
This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
- Returns:
- The value of time in number format of a job end time.
This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
-
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<BackupJobSummary.Builder,
BackupJobSummary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
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
-
sdkFields
-