Class Archive
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Archive.Builder,
Archive>
An Archive
object that contains details about an archive.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The name of the archive.static Archive.Builder
builder()
final Instant
The time stamp for the time that the archive was created.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Long
The number of events in the archive.final String
The ARN of the event bus associated with the archive.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Integer
The number of days to retain events in the archive before they are deleted.static Class
<? extends Archive.Builder> final Long
The size of the archive, in bytes.final ArchiveState
state()
The current state of the archive.final String
The current state of the archive.final String
A description for the reason that the archive is in the current 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
-
archiveName
The name of the archive.
- Returns:
- The name of the archive.
-
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
The current state of the archive.
If the service returns an enum value that is not available in the current SDK version,
state
will returnArchiveState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The current state of the archive.
- See Also:
-
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 returnArchiveState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The current state of the archive.
- See Also:
-
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
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
The size of the archive, in bytes.
- Returns:
- The size of the archive, in bytes.
-
eventCount
The number of events in the archive.
- Returns:
- The number of events in the archive.
-
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
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<Archive.Builder,
Archive> - 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
-