Class: Aws::CloudDirectory::Types::ListIndexRequest

Inherits:

Struct

• Object
• Struct
• Aws::CloudDirectory::Types::ListIndexRequest

Defined in:

gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #consistency_level ⇒ String

  The consistency level to execute the request at.

• #directory_arn ⇒ String

  The ARN of the directory that the index exists in.

• #index_reference ⇒ Types::ObjectReference

  The reference to the index to list.

• #max_results ⇒ Integer

  The maximum number of objects in a single page to retrieve from the index during a request.

• #next_token ⇒ String

  The pagination token.

• #ranges_on_indexed_values ⇒ Array<Types::ObjectAttributeRange>

  Specifies the ranges of indexed values that you want to query.

Instance Attribute Details

#consistency_level ⇒ String

The consistency level to execute the request at.

Returns:

• (String)

# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 3781

class ListIndexRequest < Struct.new(
  :directory_arn,
  :ranges_on_indexed_values,
  :index_reference,
  :max_results,
  :next_token,
  :consistency_level)
  SENSITIVE = []
  include Aws::Structure
end

#directory_arn ⇒ String

The ARN of the directory that the index exists in.

Returns:

• (String)

# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 3781

class ListIndexRequest < Struct.new(
  :directory_arn,
  :ranges_on_indexed_values,
  :index_reference,
  :max_results,
  :next_token,
  :consistency_level)
  SENSITIVE = []
  include Aws::Structure
end

#index_reference ⇒ Types::ObjectReference

The reference to the index to list.

Returns:

• (Types::ObjectReference)

# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 3781

class ListIndexRequest < Struct.new(
  :directory_arn,
  :ranges_on_indexed_values,
  :index_reference,
  :max_results,
  :next_token,
  :consistency_level)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of objects in a single page to retrieve from the index during a request. For more information, see Amazon Cloud Directory Limits.

Returns:

• (Integer)

# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 3781

class ListIndexRequest < Struct.new(
  :directory_arn,
  :ranges_on_indexed_values,
  :index_reference,
  :max_results,
  :next_token,
  :consistency_level)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

The pagination token.

Returns:

• (String)

# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 3781

class ListIndexRequest < Struct.new(
  :directory_arn,
  :ranges_on_indexed_values,
  :index_reference,
  :max_results,
  :next_token,
  :consistency_level)
  SENSITIVE = []
  include Aws::Structure
end

#ranges_on_indexed_values ⇒ Array<Types::ObjectAttributeRange>

Specifies the ranges of indexed values that you want to query.

Returns:

• (Array<Types::ObjectAttributeRange>)

# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 3781

class ListIndexRequest < Struct.new(
  :directory_arn,
  :ranges_on_indexed_values,
  :index_reference,
  :max_results,
  :next_token,
  :consistency_level)
  SENSITIVE = []
  include Aws::Structure
end