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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb

Overview

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#batch_reference_nameString

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

Returns:

  • (String)


523
524
525
526
527
528
529
530
531
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 523

class BatchCreateIndex < Struct.new(
  :ordered_indexed_attribute_list,
  :is_unique,
  :parent_reference,
  :link_name,
  :batch_reference_name)
  SENSITIVE = []
  include Aws::Structure
end

#is_uniqueBoolean

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

Returns:

  • (Boolean)


523
524
525
526
527
528
529
530
531
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 523

class BatchCreateIndex < Struct.new(
  :ordered_indexed_attribute_list,
  :is_unique,
  :parent_reference,
  :link_name,
  :batch_reference_name)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

  • (String)


523
524
525
526
527
528
529
530
531
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 523

class BatchCreateIndex < Struct.new(
  :ordered_indexed_attribute_list,
  :is_unique,
  :parent_reference,
  :link_name,
  :batch_reference_name)
  SENSITIVE = []
  include Aws::Structure
end

#ordered_indexed_attribute_listArray<Types::AttributeKey>

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

Returns:



523
524
525
526
527
528
529
530
531
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 523

class BatchCreateIndex < Struct.new(
  :ordered_indexed_attribute_list,
  :is_unique,
  :parent_reference,
  :link_name,
  :batch_reference_name)
  SENSITIVE = []
  include Aws::Structure
end

#parent_referenceTypes::ObjectReference

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



523
524
525
526
527
528
529
530
531
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 523

class BatchCreateIndex < Struct.new(
  :ordered_indexed_attribute_list,
  :is_unique,
  :parent_reference,
  :link_name,
  :batch_reference_name)
  SENSITIVE = []
  include Aws::Structure
end