Class DescribeAnalysisSchemesRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.cloudsearchv2.model.DescribeAnalysisSchemesRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class DescribeAnalysisSchemesRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Container for the parameters to the
DescribeAnalysisSchemes
operation. Specifies the name of the domain you want to describe. To limit the response to particular analysis schemes, specify the names of the analysis schemes 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 DescribeAnalysisSchemesRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DescribeAnalysisSchemesRequest
clone()
Creates a shallow clone of this request.boolean
equals(Object obj)
List<String>
getAnalysisSchemeNames()
The analysis schemes you want to describe.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.int
hashCode()
Boolean
isDeployed()
Whether to display the deployed configuration (true
) or include any pending changes (false
).void
setAnalysisSchemeNames(Collection<String> analysisSchemeNames)
The analysis schemes you want to describe.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.String
toString()
Returns a string representation of this object; useful for testing and debugging.DescribeAnalysisSchemesRequest
withAnalysisSchemeNames(String... analysisSchemeNames)
The analysis schemes you want to describe.DescribeAnalysisSchemesRequest
withAnalysisSchemeNames(Collection<String> analysisSchemeNames)
The analysis schemes you want to describe.DescribeAnalysisSchemesRequest
withDeployed(Boolean deployed)
Whether to display the deployed configuration (true
) or include any pending changes (false
).DescribeAnalysisSchemesRequest
withDomainName(String domainName)
The name of the domain 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
-
-
-
-
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 DescribeAnalysisSchemesRequest 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.
-
getAnalysisSchemeNames
public List<String> getAnalysisSchemeNames()
The analysis schemes you want to describe.
- Returns:
- The analysis schemes you want to describe.
-
setAnalysisSchemeNames
public void setAnalysisSchemeNames(Collection<String> analysisSchemeNames)
The analysis schemes you want to describe.
- Parameters:
analysisSchemeNames
- The analysis schemes you want to describe.
-
withAnalysisSchemeNames
public DescribeAnalysisSchemesRequest withAnalysisSchemeNames(String... analysisSchemeNames)
The analysis schemes you want to describe.
NOTE: This method appends the values to the existing list (if any). Use
setAnalysisSchemeNames(java.util.Collection)
orwithAnalysisSchemeNames(java.util.Collection)
if you want to override the existing values.- Parameters:
analysisSchemeNames
- The analysis schemes you want to describe.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withAnalysisSchemeNames
public DescribeAnalysisSchemesRequest withAnalysisSchemeNames(Collection<String> analysisSchemeNames)
The analysis schemes you want to describe.
- Parameters:
analysisSchemeNames
- The analysis schemes you want to describe.- 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 DescribeAnalysisSchemesRequest 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 DescribeAnalysisSchemesRequest 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()
-
-