Interface CreateCollectionDetail.Builder

  • Method Details

    • id

      The unique identifier of the collection.

      Parameters:
      id - The unique identifier of the collection.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • name

      The name of the collection.

      Parameters:
      name - The name of the collection.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • status

      The current status of the collection.

      Parameters:
      status - The current status of the collection.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • status

      The current status of the collection.

      Parameters:
      status - The current status of the collection.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • type

      The type of collection.

      Parameters:
      type - The type of collection.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • type

      The type of collection.

      Parameters:
      type - The type of collection.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • description

      CreateCollectionDetail.Builder description(String description)

      A description of the collection.

      Parameters:
      description - A description of the collection.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • arn

      The Amazon Resource Name (ARN) of the collection.

      Parameters:
      arn - The Amazon Resource Name (ARN) of the collection.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • kmsKeyArn

      CreateCollectionDetail.Builder kmsKeyArn(String kmsKeyArn)

      The Amazon Resource Name (ARN) of the KMS key with which to encrypt the collection.

      Parameters:
      kmsKeyArn - The Amazon Resource Name (ARN) of the KMS key with which to encrypt the collection.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • standbyReplicas

      CreateCollectionDetail.Builder standbyReplicas(String standbyReplicas)

      Creates details about an OpenSearch Serverless collection.

      Parameters:
      standbyReplicas - Creates details about an OpenSearch Serverless collection.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • standbyReplicas

      CreateCollectionDetail.Builder standbyReplicas(StandbyReplicas standbyReplicas)

      Creates details about an OpenSearch Serverless collection.

      Parameters:
      standbyReplicas - Creates details about an OpenSearch Serverless collection.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • vectorOptions

      CreateCollectionDetail.Builder vectorOptions(VectorOptions vectorOptions)

      Configuration options for vector search capabilities in the collection.

      Parameters:
      vectorOptions - Configuration options for vector search capabilities in the collection.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • vectorOptions

      default CreateCollectionDetail.Builder vectorOptions(Consumer<VectorOptions.Builder> vectorOptions)

      Configuration options for vector search capabilities in the collection.

      This is a convenience method that creates an instance of the VectorOptions.Builder avoiding the need to create one manually via VectorOptions.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to vectorOptions(VectorOptions).

      Parameters:
      vectorOptions - a consumer that will call methods on VectorOptions.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • createdDate

      CreateCollectionDetail.Builder createdDate(Long createdDate)

      The Epoch time when the collection was created.

      Parameters:
      createdDate - The Epoch time when the collection was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • lastModifiedDate

      CreateCollectionDetail.Builder lastModifiedDate(Long lastModifiedDate)

      The date and time when the collection was last modified.

      Parameters:
      lastModifiedDate - The date and time when the collection was last modified.
      Returns:
      Returns a reference to this object so that method calls can be chained together.