public class DescribeExpressionsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
DescribeExpressions operation.
Gets the expressions configured for the search domain. Can be limited
to specific expressions by name. By default, shows all expressions 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
Configuring Expressions
in the Amazon CloudSearch Developer Guide .
NOOP| Constructor and Description |
|---|
DescribeExpressionsRequest() |
| Modifier and Type | Method and Description |
|---|---|
DescribeExpressionsRequest |
clone()
Creates a shallow clone of this request.
|
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> |
getExpressionNames()
Limits the
DescribeExpressions response to the
specified expressions. |
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 |
setExpressionNames(Collection<String> expressionNames)
Limits the
DescribeExpressions response to the
specified expressions. |
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
DescribeExpressionsRequest |
withDeployed(Boolean deployed)
Whether to display the deployed configuration (
true) or
include any pending changes (false). |
DescribeExpressionsRequest |
withDomainName(String domainName)
The name of the domain you want to describe.
|
DescribeExpressionsRequest |
withExpressionNames(Collection<String> expressionNames)
Limits the
DescribeExpressions response to the
specified expressions. |
DescribeExpressionsRequest |
withExpressionNames(String... expressionNames)
Limits the
DescribeExpressions response to the
specified expressions. |
getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeoutpublic String getDomainName()
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
public void setDomainName(String domainName)
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
domainName - The name of the domain you want to describe.public DescribeExpressionsRequest withDomainName(String domainName)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
domainName - The name of the domain you want to describe.public List<String> getExpressionNames()
DescribeExpressions response to the
specified expressions. If not specified, all expressions are shown.DescribeExpressions response to the
specified expressions. If not specified, all expressions are shown.public void setExpressionNames(Collection<String> expressionNames)
DescribeExpressions response to the
specified expressions. If not specified, all expressions are shown.expressionNames - Limits the DescribeExpressions response to the
specified expressions. If not specified, all expressions are shown.public DescribeExpressionsRequest withExpressionNames(String... expressionNames)
DescribeExpressions response to the
specified expressions. If not specified, all expressions are shown.
NOTE: This method appends the values to the existing list (if
any). Use setExpressionNames(java.util.Collection) or withExpressionNames(java.util.Collection) if you want to override
the existing values.
Returns a reference to this object so that method calls can be chained together.
expressionNames - Limits the DescribeExpressions response to the
specified expressions. If not specified, all expressions are shown.public DescribeExpressionsRequest withExpressionNames(Collection<String> expressionNames)
DescribeExpressions response to the
specified expressions. If not specified, all expressions are shown.
Returns a reference to this object so that method calls can be chained together.
expressionNames - Limits the DescribeExpressions response to the
specified expressions. If not specified, all expressions are shown.public Boolean isDeployed()
true) or
include any pending changes (false). Defaults to
false.true) or
include any pending changes (false). Defaults to
false.public void setDeployed(Boolean deployed)
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 DescribeExpressionsRequest withDeployed(Boolean deployed)
true) or
include any pending changes (false). Defaults to
false.
Returns a reference to this object so that method calls can be chained together.
deployed - Whether to display the deployed configuration (true) or
include any pending changes (false). Defaults to
false.public Boolean getDeployed()
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 ObjectObject.toString()public DescribeExpressionsRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.