com.amazonaws.services.cloudsearchv2.model
Class DescribeExpressionsRequest

java.lang.Object
  com.amazonaws.AmazonWebServiceRequest
      com.amazonaws.services.cloudsearchv2.model.DescribeExpressionsRequest

All Implemented Interfaces:

Serializable

public class DescribeExpressionsRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the 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 .

See Also:

AmazonCloudSearch.describeExpressions(DescribeExpressionsRequest), Serialized Form

Constructor Summary

DescribeExpressionsRequest()

Method Summary

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.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeExpressionsRequest

public DescribeExpressionsRequest()

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 DescribeExpressionsRequest 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.

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 the DescribeExpressions 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.

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

Parameters:

expressionNames - Limits the DescribeExpressions response to the specified expressions. If not specified, all expressions are shown.

Returns:

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

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

Parameters:

expressionNames - Limits the DescribeExpressions response to the specified expressions. If not specified, all expressions are shown.

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 DescribeExpressionsRequest 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