@Generated(value="software.amazon.awssdk:codegen") public final class DescribeArchiveResponse extends EventBridgeResponse implements ToCopyableBuilder<DescribeArchiveResponse.Builder,DescribeArchiveResponse>
Modifier and Type | Class and Description |
---|---|
static interface |
DescribeArchiveResponse.Builder |
Modifier and Type | Method and Description |
---|---|
String |
archiveArn()
The ARN of the archive.
|
String |
archiveName()
The name of the archive.
|
static DescribeArchiveResponse.Builder |
builder() |
Instant |
creationTime()
The time at which the archive was created.
|
String |
description()
The description of the archive.
|
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 |
eventPattern()
The event pattern used to filter events sent to the archive.
|
String |
eventSourceArn()
The ARN of the event source associated with the archive.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkResponse . |
int |
hashCode() |
Integer |
retentionDays()
The number of days to retain events for in the archive.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends DescribeArchiveResponse.Builder> |
serializableBuilderClass() |
Long |
sizeBytes()
The size of the archive in bytes.
|
ArchiveState |
state()
The state of the archive.
|
String |
stateAsString()
The state of the archive.
|
String |
stateReason()
The reason that the archive is in the state.
|
DescribeArchiveResponse.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.
|
responseMetadata
sdkHttpResponse
copy
public final String archiveArn()
The ARN of the archive.
public final String archiveName()
The name of the archive.
public final String eventSourceArn()
The ARN of the event source associated with the archive.
public final String description()
The description of the archive.
public final String eventPattern()
The event pattern used to filter events sent to the archive.
public final ArchiveState state()
The 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()
.
ArchiveState
public final String stateAsString()
The 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()
.
ArchiveState
public final String stateReason()
The reason that the archive is in the state.
public final Integer retentionDays()
The number of days to retain events for in the archive.
public final Long sizeBytes()
The size of the archive in bytes.
public final Long eventCount()
The number of events in the archive.
public final Instant creationTime()
The time at which the archive was created.
public DescribeArchiveResponse.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DescribeArchiveResponse.Builder,DescribeArchiveResponse>
toBuilder
in class AwsResponse
public static DescribeArchiveResponse.Builder builder()
public static Class<? extends DescribeArchiveResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsResponse
public final boolean equals(Object obj)
equals
in class AwsResponse
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponse
SdkResponse
. 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, the SdkResponse.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkResponse
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.