Class DescribeArchiveResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeArchiveResponse.Builder,
DescribeArchiveResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The ARN of the archive.final String
The name of the archive.builder()
final Instant
The time at which the archive was created.final String
The description of the archive.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 event pattern used to filter events sent to the archive.final String
The ARN of the event source associated with the archive.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final Integer
The number of days to retain events for in the archive.static Class
<? extends DescribeArchiveResponse.Builder> final Long
The size of the archive in bytes.final ArchiveState
state()
The state of the archive.final String
The state of the archive.final String
The reason that the archive is in the 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 class software.amazon.awssdk.services.cloudwatchevents.model.CloudWatchEventsResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
archiveArn
The ARN of the archive.
- Returns:
- The ARN of the archive.
-
archiveName
The name of the archive.
- Returns:
- The name of the archive.
-
eventSourceArn
The ARN of the event source associated with the archive.
- Returns:
- The ARN of the event source associated with the archive.
-
description
The description of the archive.
- Returns:
- The description of the archive.
-
eventPattern
The event pattern used to filter events sent to the archive.
- Returns:
- The event pattern used to filter events sent to the archive.
-
state
The 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 state of the archive.
- See Also:
-
stateAsString
The 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 state of the archive.
- See Also:
-
stateReason
The reason that the archive is in the state.
- Returns:
- The reason that the archive is in the state.
-
retentionDays
The number of days to retain events for in the archive.
- Returns:
- The number of days to retain events for in the archive.
-
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 at which the archive was created.
- Returns:
- The time at which 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<DescribeArchiveResponse.Builder,
DescribeArchiveResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
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
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-