Class CreateCollectionRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.opensearchserverless.model.OpenSearchServerlessRequest
software.amazon.awssdk.services.opensearchserverless.model.CreateCollectionRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateCollectionRequest.Builder,CreateCollectionRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateCollectionRequest extends OpenSearchServerlessRequest implements ToCopyableBuilder<CreateCollectionRequest.Builder,CreateCollectionRequest>

  • Method Details

    • clientToken

      public final String clientToken()

      Unique, case-sensitive identifier to ensure idempotency of the request.

      Returns:
      Unique, case-sensitive identifier to ensure idempotency of the request.

    • description

      public final String description()

      Description of the collection.

      Returns:
      Description of the collection.

    • name

      public final String name()

      Name of the collection.

      Returns:
      Name of the collection.

    • standbyReplicas

      public final StandbyReplicas standbyReplicas()

      Indicates whether standby replicas should be used for a 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:
      Indicates whether standby replicas should be used for a collection.
      See Also:

    • standbyReplicasAsString

      public final String standbyReplicasAsString()

      Indicates whether standby replicas should be used for a 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:
      Indicates whether standby replicas should be used for a collection.
      See Also:

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<Tag> tags()

      An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.

    • 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:

    • toBuilder

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

    • builder

      public static CreateCollectionRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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.