Class DescribeIndexFieldsRequest
- All Implemented Interfaces:
ReadLimitInfo
,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:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
Whether to display the deployed configuration (true
) or include any pending changes (false
).The name of the domain you want to describe.A list of the index fields you want to describe.int
hashCode()
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.toString()
Returns a string representation of this object; useful for testing and debugging.withDeployed
(Boolean deployed) Whether to display the deployed configuration (true
) or include any pending changes (false
).withDomainName
(String domainName) The name of the domain you want to describe.withFieldNames
(String... fieldNames) A list of the index fields you want to describe.withFieldNames
(Collection<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
-
Constructor Details
-
DescribeIndexFieldsRequest
public DescribeIndexFieldsRequest()
-
-
Method Details
-
setDomainName
The name of the domain you want to describe.
- Parameters:
domainName
- The name of the domain you want to describe.
-
getDomainName
The name of the domain you want to describe.
- Returns:
- The name of the domain you want to describe.
-
withDomainName
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
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
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
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)
orwithFieldNames(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
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
Whether to display the deployed configuration (
true
) or include any pending changes (false
). Defaults tofalse
.- Parameters:
deployed
- Whether to display the deployed configuration (true
) or include any pending changes (false
). Defaults tofalse
.
-
getDeployed
Whether to display the deployed configuration (
true
) or include any pending changes (false
). Defaults tofalse
.- Returns:
- Whether to display the deployed configuration (
true
) or include any pending changes (false
). Defaults tofalse
.
-
withDeployed
Whether to display the deployed configuration (
true
) or include any pending changes (false
). Defaults tofalse
.- Parameters:
deployed
- Whether to display the deployed configuration (true
) or include any pending changes (false
). Defaults tofalse
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isDeployed
Whether to display the deployed configuration (
true
) or include any pending changes (false
). Defaults tofalse
.- Returns:
- Whether to display the deployed configuration (
true
) or include any pending changes (false
). Defaults tofalse
.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-