Package software.amazon.awssdk.services.backup.model

Class ListBackupJobSummariesResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.backup.model.BackupResponse

software.amazon.awssdk.services.backup.model.ListBackupJobSummariesResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListBackupJobSummariesResponse.Builder,ListBackupJobSummariesResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListBackupJobSummariesResponse.Builder

Method Summary

Modifier and Type	Method	Description
String	aggregationPeriod()	This is the period that sets the boundaries for returned results.
List<BackupJobSummary>	backupJobSummaries()	This request returns a summary that contains Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.
static ListBackupJobSummariesResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasBackupJobSummaries()	For responses, this returns true if the service returned a value for the BackupJobSummaries property.
int	hashCode()
String	nextToken()	The next item following a partial list of returned resources.
List<SdkField<?>>	sdkFields()
static Class<? extends ListBackupJobSummariesResponse.Builder>	serializableBuilderClass()
ListBackupJobSummariesResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.backup.model.BackupResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

hasBackupJobSummaries

public final boolean hasBackupJobSummaries()

For responses, this returns true if the service returned a value for the BackupJobSummaries property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

backupJobSummaries

public final List<BackupJobSummary> backupJobSummaries()

This request returns a summary that contains Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasBackupJobSummaries() method.

Returns:

This request returns a summary that contains Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.

aggregationPeriod

public final String 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:

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.

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 ListBackupJobSummariesResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListBackupJobSummariesResponse.Builder,ListBackupJobSummariesResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static ListBackupJobSummariesResponse.Builder builder()

serializableBuilderClass

public static Class<? extends ListBackupJobSummariesResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo