Interface CollectionDetail.Builder

All Superinterfaces:
Buildable, CopyableBuilder<CollectionDetail.Builder,CollectionDetail>, SdkBuilder<CollectionDetail.Builder,CollectionDetail>, SdkPojo
Enclosing class:
CollectionDetail
@Mutable @NotThreadSafe public static interface CollectionDetail.Builder extends SdkPojo, CopyableBuilder<CollectionDetail.Builder,CollectionDetail>

  • Method Details

    • id

      CollectionDetail.Builder id(String id)

      A unique identifier for the collection.

      Parameters:
      id - A unique identifier for the collection.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      CollectionDetail.Builder name(String 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

      CollectionDetail.Builder status(String 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

      CollectionDetail.Builder status(CollectionStatus 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

      CollectionDetail.Builder type(String 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

      CollectionDetail.Builder type(CollectionType 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

      CollectionDetail.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

      CollectionDetail.Builder arn(String 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

      CollectionDetail.Builder kmsKeyArn(String kmsKeyArn)

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

      Parameters:
      kmsKeyArn - The ARN of the Amazon Web Services KMS key used to encrypt the collection.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • standbyReplicas

      CollectionDetail.Builder standbyReplicas(String standbyReplicas)

      Details about an OpenSearch Serverless collection.

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

    • standbyReplicas

      CollectionDetail.Builder standbyReplicas(StandbyReplicas standbyReplicas)

      Details about an OpenSearch Serverless collection.

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

    • createdDate

      CollectionDetail.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

      CollectionDetail.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.

    • collectionEndpoint

      CollectionDetail.Builder collectionEndpoint(String collectionEndpoint)

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

      Parameters:
      collectionEndpoint - Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dashboardEndpoint

      CollectionDetail.Builder dashboardEndpoint(String dashboardEndpoint)

      Collection-specific endpoint used to access OpenSearch Dashboards.

      Parameters:
      dashboardEndpoint - Collection-specific endpoint used to access OpenSearch Dashboards.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fipsEndpoints

      CollectionDetail.Builder fipsEndpoints(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • fipsEndpoints

      default CollectionDetail.Builder fipsEndpoints(Consumer<FipsEndpoints.Builder> 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.

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

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

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

    • failureCode

      CollectionDetail.Builder failureCode(String failureCode)

      A failure code associated with the request.

      Parameters:
      failureCode - A failure code associated with the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • failureMessage

      CollectionDetail.Builder failureMessage(String failureMessage)

      A message associated with the failure code.

      Parameters:
      failureMessage - A message associated with the failure code.
      Returns:
      Returns a reference to this object so that method calls can be chained together.