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

See Also:
  • Constructor Details

    • DescribeAnalysisSchemesRequest

      public DescribeAnalysisSchemesRequest()
  • 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 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) or withAnalysisSchemeNames(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 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 DescribeAnalysisSchemesRequest 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

      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: