@Generated(value="com.amazonaws:aws-java-sdk-code-generator") 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
.
NOOP
Constructor and Description |
---|
DescribeIndexFieldsRequest() |
Modifier and Type | Method and Description |
---|---|
DescribeIndexFieldsRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
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.
|
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.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setDomainName(String domainName)
The name of the domain you want to describe.
domainName
- The name of the domain you want to describe.public String getDomainName()
The name of the domain you want to describe.
public DescribeIndexFieldsRequest withDomainName(String domainName)
The name of the domain you want to describe.
domainName
- The name of the domain you want to describe.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.
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.
fieldNames
- A list of the index fields you want to describe. If not specified, information is returned for all
configured index fields.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.
fieldNames
- A list of the index fields you want to describe. If not specified, information is returned for all
configured index fields.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.
fieldNames
- A list of the index fields you want to describe. If not specified, information is returned for all
configured index fields.public void setDeployed(Boolean deployed)
Whether to display the deployed configuration (true
) or include any pending changes (
false
). Defaults to false
.
deployed
- Whether to display the deployed configuration (true
) or include any pending changes (
false
). Defaults to false
.public Boolean getDeployed()
Whether to display the deployed configuration (true
) or include any pending changes (
false
). Defaults to false
.
true
) or include any pending changes (
false
). Defaults to false
.public DescribeIndexFieldsRequest withDeployed(Boolean deployed)
Whether to display the deployed configuration (true
) or include any pending changes (
false
). Defaults to false
.
deployed
- Whether to display the deployed configuration (true
) or include any pending changes (
false
). Defaults to false
.public Boolean isDeployed()
Whether to display the deployed configuration (true
) or include any pending changes (
false
). Defaults to false
.
true
) or include any pending changes (
false
). Defaults to false
.public String toString()
toString
in class Object
Object.toString()
public DescribeIndexFieldsRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()