You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CloudDirectory::Types::BatchCreateIndex

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing BatchCreateIndex as input to an Aws::Client method, you can use a vanilla Hash:

{
  ordered_indexed_attribute_list: [ # required
    {
      schema_arn: "Arn", # required
      facet_name: "FacetName", # required
      name: "AttributeName", # required
    },
  ],
  is_unique: false, # required
  parent_reference: {
    selector: "SelectorObjectReference",
  },
  link_name: "LinkName",
  batch_reference_name: "BatchReferenceName",
}

Creates an index object inside of a BatchRead operation. For more information, see CreateIndex and BatchReadRequest$Operations.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#batch_reference_name ⇒ String

The batch reference name. See Transaction Support for more information.

Returns:

  • (String) —

    The batch reference name.

#is_unique ⇒ Boolean

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

Returns:

  • (Boolean) —

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

#link_name ⇒ String

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

Returns:

  • (String) —

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

#ordered_indexed_attribute_list ⇒ Array<Types::AttributeKey>

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

Returns:

#parent_reference ⇒ Types::ObjectReference

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

Returns: