software.amazon.awssdk.services.cloudwatchevents.model

Class Archive

java.lang.Object

software.amazon.awssdk.services.cloudwatchevents.model.Archive

All Implemented Interfaces:

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

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

An Archive object that contains details about an archive.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Archive.Builder

Method Summary

Modifier and Type	Method and Description
String	archiveName() The name of the archive.
static Archive.Builder	builder()
Instant	creationTime() The time stamp for the time that the archive was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
Long	eventCount() The number of events in the archive.
String	eventSourceArn() The ARN of the event bus associated with the archive.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	retentionDays() The number of days to retain events in the archive before they are deleted.
List<SdkField<?>>	sdkFields()
static Class<? extends Archive.Builder>	serializableBuilderClass()
Long	sizeBytes() The size of the archive, in bytes.
ArchiveState	state() The current state of the archive.
String	stateAsString() The current state of the archive.
String	stateReason() A description for the reason that the archive is in the current state.
Archive.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

archiveName

public final String archiveName()

The name of the archive.

Returns:

The name of the archive.

eventSourceArn

public final String eventSourceArn()

The ARN of the event bus associated with the archive. Only events from this event bus are sent to the archive.

Returns:

The ARN of the event bus associated with the archive. Only events from this event bus are sent to the archive.

state

public final ArchiveState state()

The current state of the archive.

If the service returns an enum value that is not available in the current SDK version, state will return ArchiveState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

The current state of the archive.

See Also:

ArchiveState

stateAsString

public final String stateAsString()

The current state of the archive.

If the service returns an enum value that is not available in the current SDK version, state will return ArchiveState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

The current state of the archive.

See Also:

ArchiveState

stateReason

public final String stateReason()

A description for the reason that the archive is in the current state.

Returns:

A description for the reason that the archive is in the current state.

retentionDays

public final Integer retentionDays()

The number of days to retain events in the archive before they are deleted.

Returns:

The number of days to retain events in the archive before they are deleted.

sizeBytes

public final Long sizeBytes()

The size of the archive, in bytes.

Returns:

The size of the archive, in bytes.

eventCount

public final Long eventCount()

The number of events in the archive.

Returns:

The number of events in the archive.

creationTime

public final Instant creationTime()

The time stamp for the time that the archive was created.

Returns:

The time stamp for the time that the archive was created.

toBuilder

public Archive.Builder 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 interface ToCopyableBuilder<Archive.Builder,Archive>

Returns:

a builder for type T

builder

public static Archive.Builder builder()

serializableBuilderClass

public static Class<? extends Archive.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)

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 an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.