DescribeIndexFieldsRequest Class | AWS SDK for .NET Version 4

Container for the parameters to the DescribeIndexFields operation. Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. By default, shows all fields and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Getting Domain Information in the Amazon CloudSearch Developer Guide.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CloudSearch.AmazonCloudSearchRequest
      Amazon.CloudSearch.Model.DescribeIndexFieldsRequest

Namespace: Amazon.CloudSearch.Model
Assembly: AWSSDK.CloudSearch.dll
Version: 3.x.y.z

Syntax

public class DescribeIndexFieldsRequest : AmazonCloudSearchRequest
         IAmazonWebServiceRequest

The DescribeIndexFieldsRequest type exposes the following members

Constructors

	Name	Description
	DescribeIndexFieldsRequest()

Properties

Name Type Description

Name	Type	Description
Deployed	System.Nullable<System.Boolean>	Gets and sets the property Deployed. Whether to display the deployed configuration (`true`) or include any pending changes (`false`). Defaults to `false`.
DomainName	System.String	Gets and sets the property DomainName. The name of the domain you want to describe.
FieldNames	System.Collections.Generic.List<System.String>	Gets and sets the property FieldNames. A list of the index fields you want to describe. If not specified, information is returned for all configured index fields. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Deployed

System.Nullable<System.Boolean>

Gets and sets the property Deployed.

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

DomainName

System.String

Gets and sets the property DomainName.

The name of the domain you want to describe.

FieldNames

System.Collections.Generic.List<System.String>

Gets and sets the property FieldNames.

A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer