Class CollectionDetail

java.lang.Object
software.amazon.awssdk.services.opensearchserverless.model.CollectionDetail
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CollectionDetail.Builder,CollectionDetail>
@Generated("software.amazon.awssdk:codegen") public final class CollectionDetail extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CollectionDetail.Builder,CollectionDetail>

Details about each OpenSearch Serverless collection, including the collection endpoint, the OpenSearch Dashboards endpoint, and FIPS-compliant endpoints for federal government workloads.

See Also:

  • Method Details

    • id

      public final String id()

      A unique identifier for the collection.

      Returns:
      A unique identifier for the collection.

    • name

      public final String name()

      The name of the collection.

      Returns:
      The name of the collection.

    • status

      public final CollectionStatus status()

      The current status of the collection.

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

      Returns:
      The current status of the collection.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the collection.

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

      Returns:
      The current status of the collection.
      See Also:

    • type

      public final CollectionType type()

      The type of collection.

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

      Returns:
      The type of collection.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of collection.

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

      Returns:
      The type of collection.
      See Also:

    • description

      public final String description()

      A description of the collection.

      Returns:
      A description of the collection.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the collection.

      Returns:
      The Amazon Resource Name (ARN) of the collection.

    • kmsKeyArn

      public final String kmsKeyArn()

      The ARN of the Amazon Web Services KMS key used to encrypt the collection.

      Returns:
      The ARN of the Amazon Web Services KMS key used to encrypt the collection.

    • standbyReplicas

      public final StandbyReplicas standbyReplicas()

      Details about an OpenSearch Serverless collection.

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

      Returns:
      Details about an OpenSearch Serverless collection.
      See Also:

    • standbyReplicasAsString

      public final String standbyReplicasAsString()

      Details about an OpenSearch Serverless collection.

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

      Returns:
      Details about an OpenSearch Serverless collection.
      See Also:

    • createdDate

      public final Long createdDate()

      The Epoch time when the collection was created.

      Returns:
      The Epoch time when the collection was created.

    • lastModifiedDate

      public final Long lastModifiedDate()

      The date and time when the collection was last modified.

      Returns:
      The date and time when the collection was last modified.

    • collectionEndpoint

      public final String collectionEndpoint()

      Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.

      Returns:
      Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.

    • dashboardEndpoint

      public final String dashboardEndpoint()

      Collection-specific endpoint used to access OpenSearch Dashboards.

      Returns:
      Collection-specific endpoint used to access OpenSearch Dashboards.

    • fipsEndpoints

      public final FipsEndpoints fipsEndpoints()

      FIPS-compliant endpoints for the collection. These endpoints use FIPS 140-3 validated cryptographic modules and are required for federal government workloads that must comply with FedRAMP security standards.

      Returns:
      FIPS-compliant endpoints for the collection. These endpoints use FIPS 140-3 validated cryptographic modules and are required for federal government workloads that must comply with FedRAMP security standards.

    • failureCode

      public final String failureCode()

      A failure code associated with the request.

      Returns:
      A failure code associated with the request.

    • failureMessage

      public final String failureMessage()

      A message associated with the failure code.

      Returns:
      A message associated with the failure code.

    • toBuilder

      public CollectionDetail.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<CollectionDetail.Builder,CollectionDetail>
      Returns:
      a builder for type T

    • builder

      public static CollectionDetail.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

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