com.amazonaws.services.cloudsearchv2.model

Class DescribeExpressionsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloudsearchv2.model.DescribeExpressionsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
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 the Deployed option to true.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeExpressionsRequest()

Method Summary

Modifier and Type	Method and Description
DescribeExpressionsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
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.
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

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeExpressionsRequest

public DescribeExpressionsRequest()

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

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.

Parameters:

expressionNames - Limits the DescribeExpressions 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 the DescribeExpressions 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 to false.

Parameters:

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

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.

withDeployed

public DescribeExpressionsRequest withDeployed(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.

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 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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DescribeExpressionsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()