com.amazonaws.services.cloudsearchv2.model

Class DescribeIndexFieldsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloudsearchv2.model.DescribeIndexFieldsRequest

All Implemented Interfaces:

Serializable

public class DescribeIndexFieldsRequest
extends AmazonWebServiceRequest
implements Serializable

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 .

See Also:

AmazonCloudSearch.describeIndexFields(DescribeIndexFieldsRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeIndexFieldsRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
Boolean	getDeployed() Whether to display the deployed configuration (true) or include any pending changes (false).
String	getDomainName() The name of the domain you want to describe.
List<String>	getFieldNames() A list of the index fields you want to describe.
int	hashCode()
Boolean	isDeployed() Whether to display the deployed configuration (true) or include any pending changes (false).
void	setDeployed(Boolean deployed) Whether to display the deployed configuration (true) or include any pending changes (false).
void	setDomainName(String domainName) The name of the domain you want to describe.
void	setFieldNames(Collection<String> fieldNames) A list of the index fields you want to describe.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeIndexFieldsRequest	withDeployed(Boolean deployed) Whether to display the deployed configuration (true) or include any pending changes (false).
DescribeIndexFieldsRequest	withDomainName(String domainName) The name of the domain you want to describe.
DescribeIndexFieldsRequest	withFieldNames(Collection<String> fieldNames) A list of the index fields you want to describe.
DescribeIndexFieldsRequest	withFieldNames(String... fieldNames) A list of the index fields you want to describe.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeIndexFieldsRequest

public DescribeIndexFieldsRequest()

Method Detail

getDomainName

public String getDomainName()

The name of the domain you want to describe.

Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+

Returns:

The name of the domain you want to describe.

setDomainName

public void setDomainName(String domainName)

The name of the domain you want to describe.

Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+

Parameters:

domainName - The name of the domain you want to describe.

withDomainName

public DescribeIndexFieldsRequest withDomainName(String domainName)

The name of the domain you want to describe.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+

Parameters:

domainName - The name of the domain you want to describe.

Returns:

A reference to this updated object so that method calls can be chained together.

getFieldNames

public List<String> getFieldNames()

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

Returns:

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

setFieldNames

public void setFieldNames(Collection<String> fieldNames)

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

Parameters:

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

withFieldNames

public DescribeIndexFieldsRequest withFieldNames(String... fieldNames)

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

withFieldNames

public DescribeIndexFieldsRequest withFieldNames(Collection<String> fieldNames)

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

isDeployed

public Boolean isDeployed()

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

Returns:

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

setDeployed

public void setDeployed(Boolean deployed)

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

Parameters:

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

withDeployed

public DescribeIndexFieldsRequest withDeployed(Boolean deployed)

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getDeployed

public Boolean getDeployed()

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

Returns:

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

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object