Class DescribeExpressionsRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.cloudsearchv2.model.DescribeExpressionsRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class DescribeExpressionsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Container for the parameters to the
DescribeDomains
operation. Specifies the name of the domain you want to describe. To restrict the response to particular expressions, specify the names of the expressions you want to describe. To show the active configuration and exclude any pending changes, set theDeployed
option totrue
.- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description DescribeExpressionsRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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 theDescribeExpressions
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 theDescribeExpressions
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(String... expressionNames)
Limits theDescribeExpressions
response to the specified expressions.DescribeExpressionsRequest
withExpressionNames(Collection<String> expressionNames)
Limits theDescribeExpressions
response to the specified expressions.-
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
-
-
-
-
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 DescribeExpressionsRequest 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.
-
getExpressionNames
public List<String> getExpressionNames()
Limits the
DescribeExpressions
response to the specified expressions. If not specified, all expressions are shown.- Returns:
- Limits the
DescribeExpressions
response to the specified expressions. If not specified, all expressions are shown.
-
setExpressionNames
public void setExpressionNames(Collection<String> expressionNames)
Limits the
DescribeExpressions
response to the specified expressions. If not specified, all expressions are shown.- Parameters:
expressionNames
- Limits theDescribeExpressions
response to the specified expressions. If not specified, all expressions are shown.
-
withExpressionNames
public DescribeExpressionsRequest withExpressionNames(String... expressionNames)
Limits the
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)
orwithExpressionNames(java.util.Collection)
if you want to override the existing values.- Parameters:
expressionNames
- Limits theDescribeExpressions
response to the specified expressions. If not specified, all expressions are shown.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withExpressionNames
public DescribeExpressionsRequest withExpressionNames(Collection<String> expressionNames)
Limits the
DescribeExpressions
response to the specified expressions. If not specified, all expressions are shown.- Parameters:
expressionNames
- Limits theDescribeExpressions
response to the specified expressions. If not specified, all expressions are shown.- 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 tofalse
.- Parameters:
deployed
- Whether to display the deployed configuration (true
) or include any pending changes (false
). Defaults tofalse
.
-
getDeployed
public Boolean 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
public DescribeExpressionsRequest withDeployed(Boolean deployed)
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
public Boolean 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
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public DescribeExpressionsRequest 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:
Object.clone()
-
-