public class DescribeIndexFieldsRequest extends AmazonWebServiceRequest implements java.io.Serializable, java.lang.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
.
Modifier and Type | Field and Description |
---|---|
private java.lang.Boolean |
deployed
Whether to display the deployed configuration (
true ) or
include any pending changes (false ). |
private java.lang.String |
domainName
The name of the domain you want to describe.
|
private SdkInternalList<java.lang.String> |
fieldNames
A list of the index fields you want to describe.
|
NOOP
Constructor and Description |
---|
DescribeIndexFieldsRequest() |
Modifier and Type | Method and Description |
---|---|
DescribeIndexFieldsRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(java.lang.Object obj) |
java.lang.Boolean |
getDeployed()
Whether to display the deployed configuration (
true ) or
include any pending changes (false ). |
java.lang.String |
getDomainName()
The name of the domain you want to describe.
|
java.util.List<java.lang.String> |
getFieldNames()
A list of the index fields you want to describe.
|
int |
hashCode() |
java.lang.Boolean |
isDeployed()
Whether to display the deployed configuration (
true ) or
include any pending changes (false ). |
void |
setDeployed(java.lang.Boolean deployed)
Whether to display the deployed configuration (
true ) or
include any pending changes (false ). |
void |
setDomainName(java.lang.String domainName)
The name of the domain you want to describe.
|
void |
setFieldNames(java.util.Collection<java.lang.String> fieldNames)
A list of the index fields you want to describe.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
DescribeIndexFieldsRequest |
withDeployed(java.lang.Boolean deployed)
Whether to display the deployed configuration (
true ) or
include any pending changes (false ). |
DescribeIndexFieldsRequest |
withDomainName(java.lang.String domainName)
The name of the domain you want to describe.
|
DescribeIndexFieldsRequest |
withFieldNames(java.util.Collection<java.lang.String> fieldNames)
A list of the index fields you want to describe.
|
DescribeIndexFieldsRequest |
withFieldNames(java.lang.String... fieldNames)
A list of the index fields you want to describe.
|
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
private java.lang.String domainName
The name of the domain you want to describe.
private SdkInternalList<java.lang.String> fieldNames
A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.
private java.lang.Boolean deployed
Whether to display the deployed configuration (true
) or
include any pending changes (false
). Defaults to
false
.
public void setDomainName(java.lang.String domainName)
The name of the domain you want to describe.
domainName
- The name of the domain you want to describe.public java.lang.String getDomainName()
The name of the domain you want to describe.
public DescribeIndexFieldsRequest withDomainName(java.lang.String domainName)
The name of the domain you want to describe.
domainName
- The name of the domain you want to describe.public java.util.List<java.lang.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(java.util.Collection<java.lang.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(java.lang.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(java.util.Collection<java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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 java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public DescribeIndexFieldsRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()