Class: Aws::CloudSearch::Types::DescribeIndexFieldsRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::CloudSearch::Types::DescribeIndexFieldsRequest
- Defined in:
- gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb
Overview
Container for the parameters to the DescribeIndexFields
operation.
Specifies the name of the domain you want to describe. To restrict the
response to particular index fields, specify the names of the index
fields you want to describe. To show the active configuration and
exclude any pending changes, set the Deployed
option to true
.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#deployed ⇒ Boolean
Whether to display the deployed configuration (
true
) or include any pending changes (false
). -
#domain_name ⇒ String
The name of the domain you want to describe.
-
#field_names ⇒ Array<String>
A list of the index fields you want to describe.
Instance Attribute Details
#deployed ⇒ Boolean
Whether to display the deployed configuration (true
) or include
any pending changes (false
). Defaults to false
.
859 860 861 862 863 864 865 |
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 859 class DescribeIndexFieldsRequest < Struct.new( :domain_name, :field_names, :deployed) SENSITIVE = [] include Aws::Structure end |
#domain_name ⇒ String
The name of the domain you want to describe.
859 860 861 862 863 864 865 |
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 859 class DescribeIndexFieldsRequest < Struct.new( :domain_name, :field_names, :deployed) SENSITIVE = [] include Aws::Structure end |
#field_names ⇒ Array<String>
A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.
859 860 861 862 863 864 865 |
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 859 class DescribeIndexFieldsRequest < Struct.new( :domain_name, :field_names, :deployed) SENSITIVE = [] include Aws::Structure end |