Class DescribeIndexFieldsRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.cloudsearchv2.model.DescribeIndexFieldsRequest
All Implemented Interfaces:
ReadLimitInfo, Serializable, Cloneable
public class DescribeIndexFieldsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable

Container for the parameters to the DescribeIndexFields operation. Specifies the name of the domain you want to describe. To restrict the response to particular index fields, specify the names of the index fields you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

See Also:

  • Constructor Details

    • DescribeIndexFieldsRequest

      public DescribeIndexFieldsRequest()

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

    • getFieldNames

      public List<String> getFieldNames()

      A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.

      Returns:
      A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.

    • setFieldNames

      public void setFieldNames(Collection<String> fieldNames)

      A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.

      Parameters:
      fieldNames - A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.

    • withFieldNames

      public DescribeIndexFieldsRequest withFieldNames(String... fieldNames)

      A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.

      NOTE: This method appends the values to the existing list (if any). Use setFieldNames(java.util.Collection) or withFieldNames(java.util.Collection) if you want to override the existing values.

      Parameters:
      fieldNames - A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • withFieldNames

      public DescribeIndexFieldsRequest withFieldNames(Collection<String> fieldNames)

      A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.

      Parameters:
      fieldNames - A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.
      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 DescribeIndexFieldsRequest 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 DescribeIndexFieldsRequest 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: