Package software.amazon.awssdk.services.clouddirectory.model

Interface CreateIndexRequest.Builder

    • Method Detail

      • directoryArn

        CreateIndexRequest.Builder directoryArn​(String directoryArn)

        The ARN of the directory where the index should be created.

        Parameters:
        directoryArn - The ARN of the directory where the index should be created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • orderedIndexedAttributeList

        CreateIndexRequest.Builder orderedIndexedAttributeList​(Collection<AttributeKey> orderedIndexedAttributeList)

        Specifies the attributes that should be indexed on. Currently only a single attribute is supported.

        Parameters:
        orderedIndexedAttributeList - Specifies the attributes that should be indexed on. Currently only a single attribute is supported.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • orderedIndexedAttributeList

        CreateIndexRequest.Builder orderedIndexedAttributeList​(AttributeKey... orderedIndexedAttributeList)

        Specifies the attributes that should be indexed on. Currently only a single attribute is supported.

        Parameters:
        orderedIndexedAttributeList - Specifies the attributes that should be indexed on. Currently only a single attribute is supported.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • orderedIndexedAttributeList

        CreateIndexRequest.Builder orderedIndexedAttributeList​(Consumer<AttributeKey.Builder>... orderedIndexedAttributeList)

        Specifies the attributes that should be indexed on. Currently only a single attribute is supported.

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

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #orderedIndexedAttributeList(List).

        Parameters:
        orderedIndexedAttributeList - a consumer that will call methods on AttributeKey.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #orderedIndexedAttributeList(java.util.Collection)

      • isUnique

        CreateIndexRequest.Builder isUnique​(Boolean isUnique)

        Indicates whether the attribute that is being indexed has unique values or not.

        Parameters:
        isUnique - Indicates whether the attribute that is being indexed has unique values or not.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • parentReference

        CreateIndexRequest.Builder parentReference​(ObjectReference parentReference)

        A reference to the parent object that contains the index object.

        Parameters:
        parentReference - A reference to the parent object that contains the index object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • linkName

        CreateIndexRequest.Builder linkName​(String linkName)

        The name of the link between the parent object and the index object.

        Parameters:
        linkName - The name of the link between the parent object and the index object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.