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 the Deployed option to true.

See Also:

  • Constructor Details

    • DescribeExpressionsRequest

      public DescribeExpressionsRequest()

  • Method Details

    • 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; useful for testing and debugging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object.
      See Also:

    • 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 request. Explicitly does not clone the deep structure of the request object.
      Overrides:
      clone in class AmazonWebServiceRequest
      See Also: