com.amazonaws.services.cloudsearchv2.model

Class DescribeIndexFieldsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloudsearchv2.model.DescribeIndexFieldsRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribeIndexFieldsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

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.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeIndexFieldsRequest()

Method Summary

Modifier and Type	Method and Description
DescribeIndexFieldsRequest	clone()
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

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

DescribeIndexFieldsRequest

public DescribeIndexFieldsRequest()

Method Detail

setDomainName

public void setDomainName(String domainName)

The name of the domain you want to describe.

Parameters:

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

getDomainName

public String getDomainName()

The name of the domain you want to describe.

Returns:

The name of the domain you want to describe.

withDomainName

public DescribeIndexFieldsRequest withDomainName(String domainName)

The name of the domain you want to describe.

Parameters:

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

Returns:

Returns a reference to this 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.

NOTE: This method appends the values to the existing list (if any). Use setFieldNames(java.util.Collection) or withFieldNames(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this 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.

Parameters:

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

Returns:

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

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.

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.

withDeployed

public DescribeIndexFieldsRequest withDeployed(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.

Returns:

Returns a reference to this 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.

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()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DescribeIndexFieldsRequest clone()

Overrides:

clone in class AmazonWebServiceRequest