Class CollectionGroupSummary

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

Summary information about a collection group.

See Also:

  • Method Details

    • id

      public final String id()

      The unique identifier of the collection group.

      Returns:
      The unique identifier of the collection group.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the collection group.

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

    • name

      public final String name()

      The name of the collection group.

      Returns:
      The name of the collection group.

    • numberOfCollections

      public final Integer numberOfCollections()

      The number of collections within the collection group.

      Returns:
      The number of collections within the collection group.

    • createdDate

      public final Long createdDate()

      The Epoch time when the collection group was created.

      Returns:
      The Epoch time when the collection group was created.

    • capacityLimits

      public final CollectionGroupCapacityLimits capacityLimits()
      Returns the value of the CapacityLimits property for this object.
      Returns:
      The value of the CapacityLimits property for this object.

    • generation

      public final ServerlessGeneration generation()

      The generation of Amazon OpenSearch Serverless for the collection group.

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

      Returns:
      The generation of Amazon OpenSearch Serverless for the collection group.
      See Also:

    • generationAsString

      public final String generationAsString()

      The generation of Amazon OpenSearch Serverless for the collection group.

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

      Returns:
      The generation of Amazon OpenSearch Serverless for the collection group.
      See Also:

    • toBuilder

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

    • builder

      public static CollectionGroupSummary.Builder builder()

    • serializableBuilderClass

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