Class DescribeArchiveResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.eventbridge.model.EventBridgeResponse
software.amazon.awssdk.services.eventbridge.model.DescribeArchiveResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeArchiveResponse.Builder,DescribeArchiveResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeArchiveResponse extends EventBridgeResponse implements ToCopyableBuilder<DescribeArchiveResponse.Builder,DescribeArchiveResponse>

  • Method Details

    • archiveArn

      public final String archiveArn()

      The ARN of the archive.

      Returns:
      The ARN of the archive.

    • 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 source associated with the archive.

      Returns:
      The ARN of the event source associated with the archive.

    • description

      public final String description()

      The description of the archive.

      Returns:
      The description of the archive.

    • eventPattern

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

      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().

      Returns:
      The state of the archive.
      See Also:

    • stateAsString

      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().

      Returns:
      The state of the archive.
      See Also:

    • stateReason

      public final String stateReason()

      The reason that the archive is in the state.

      Returns:
      The reason that the archive is in the state.

    • kmsKeyIdentifier

      public final String kmsKeyIdentifier()

      The identifier of the KMS customer managed key for EventBridge to use to encrypt this archive, if one has been specified.

      For more information, see Encrypting archives in the Amazon EventBridge User Guide.

      Returns:
      The identifier of the KMS customer managed key for EventBridge to use to encrypt this archive, if one has been specified.

      For more information, see Encrypting archives in the Amazon EventBridge User Guide.

    • retentionDays

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

      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 at which the archive was created.

      Returns:
      The time at which the archive was created.

    • toBuilder

      public DescribeArchiveResponse.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<DescribeArchiveResponse.Builder,DescribeArchiveResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeArchiveResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends 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.
      Overrides:
      getValueForField in class SdkResponse
      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

      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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.