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

Class CopyJobSummary

java.lang.Object

software.amazon.awssdk.services.backup.model.CopyJobSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CopyJobSummary.Builder,CopyJobSummary>

@Generated("software.amazon.awssdk:codegen")
public final class CopyJobSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CopyJobSummary.Builder,CopyJobSummary>

This is a summary of copy 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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CopyJobSummary.Builder

Method Summary

Modifier and Type	Method	Description
String	accountId()	The account ID that owns the jobs within the summary.
static CopyJobSummary.Builder	builder()
Integer	count()	The value as a number of jobs in a job summary.
Instant	endTime()	The value of time in number format of a job end time.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	messageCategory()	This parameter is the job count for the specified message category.
String	region()	This is the Amazon Web Services Regions within the job summary.
String	resourceType()	This value is the job count for the specified resource type.
List<SdkField<?>>	sdkFields()
static Class<? extends CopyJobSummary.Builder>	serializableBuilderClass()
Instant	startTime()	The value of time in number format of a job start time.
CopyJobStatus	state()	This value is job count for jobs with the specified state.
String	stateAsString()	This value is job count for jobs with the specified state.
CopyJobSummary.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

region

public final String region()

This is the Amazon Web Services Regions within the job summary.

Returns:

This is the Amazon Web Services Regions within the job summary.

accountId

public final String accountId()

The account ID that owns the jobs within the summary.

Returns:

The account ID that owns the jobs within the summary.

state

public final CopyJobStatus 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 return CopyJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

This value is job count for jobs with the specified state.

See Also:

CopyJobStatus

stateAsString

public final String 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 return CopyJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

This value is job count for jobs with the specified state.

See Also:

CopyJobStatus

resourceType

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

public final String messageCategory()

This parameter is the job count for the specified message category.

Example strings include AccessDenied, Success, and InvalidParameters. 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, and InvalidParameters. 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

public final Integer 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

public final Instant 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

public final Instant 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

public CopyJobSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CopyJobSummary.Builder,CopyJobSummary>

builder

public static CopyJobSummary.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo