com.amazonaws.services.cloudsearchv2.model

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.

Gets the analysis schemes configured for a domain. An analysis scheme defines language-specific text processing options for a text field. Can be limited to specific analysis schemes by name. By default, shows all analysis schemes 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 Analysis Schemes in the Amazon CloudSearch Developer Guide .

See Also:

AmazonCloudSearch.describeAnalysisSchemes(DescribeAnalysisSchemesRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeAnalysisSchemesRequest()

Method Summary

Methods

Modifier and Type	Method and 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(Collection<String> analysisSchemeNames) The analysis schemes you want to describe.
DescribeAnalysisSchemesRequest	withAnalysisSchemeNames(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

getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeAnalysisSchemesRequest

public DescribeAnalysisSchemesRequest()

Method Detail

getDomainName

public String getDomainName()

The name of the domain you want to describe.

Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+

Returns:

The name of the domain you want to describe.

setDomainName

public void setDomainName(String domainName)

The name of the domain you want to describe.

Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+

Parameters:

domainName - The name of the domain you want to describe.

withDomainName

public DescribeAnalysisSchemesRequest withDomainName(String domainName)

The name of the domain you want to describe.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+

Parameters:

domainName - The name of the domain you want to describe.

Returns:

A reference to this updated 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) or withAnalysisSchemeNames(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.

Parameters:

analysisSchemeNames - The analysis schemes you want to describe.

Returns:

A reference to this updated object so that method calls can be chained together.

withAnalysisSchemeNames

public DescribeAnalysisSchemesRequest withAnalysisSchemeNames(Collection<String> analysisSchemeNames)

The analysis schemes you want to describe.

Returns a reference to this object so that method calls can be chained together.

Parameters:

analysisSchemeNames - The analysis schemes you want to describe.

Returns:

A reference to this updated 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 to false.

Returns:

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

setDeployed

public void setDeployed(Boolean deployed)

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

Parameters:

deployed - Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

withDeployed

public DescribeAnalysisSchemesRequest withDeployed(Boolean deployed)

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

Returns a reference to this object so that method calls can be chained together.

Parameters:

deployed - Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

Returns:

A reference to this updated object so that method calls can be chained together.

getDeployed

public Boolean getDeployed()

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

Returns:

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

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 class AmazonWebServiceRequest

See Also:

Object.clone()