com.amazonaws.services.cloudsearchv2.model.DescribeSuggestersRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk Show documentation
/*
* Copyright 2010-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.cloudsearchv2.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
* Container for the parameters to the {@link com.amazonaws.services.cloudsearchv2.AmazonCloudSearch#describeSuggesters(DescribeSuggestersRequest) DescribeSuggesters operation}.
*
* Gets the suggesters configured for a domain. A suggester enables you
* to display possible matches before users finish typing their queries.
* Can be limited to specific suggesters by name. By default, shows all
* suggesters 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
* Getting Search Suggestions
* in the Amazon CloudSearch Developer Guide .
*
*
* @see com.amazonaws.services.cloudsearchv2.AmazonCloudSearch#describeSuggesters(DescribeSuggestersRequest)
*/
public class DescribeSuggestersRequest extends AmazonWebServiceRequest implements Serializable {
/**
* The name of the domain you want to describe.
*
* Constraints:
* Length: 3 - 28
* Pattern: [a-z][a-z0-9\-]+
*/
private String domainName;
/**
* The suggesters you want to describe.
*/
private com.amazonaws.internal.ListWithAutoConstructFlag suggesterNames;
/**
* Whether to display the deployed configuration (true) or
* include any pending changes (false). Defaults to
* false.
*/
private Boolean deployed;
/**
* The name of the domain you want to describe.
*
* Constraints:
* Length: 3 - 28
* Pattern: [a-z][a-z0-9\-]+
*
* @return The name of the domain you want to describe.
*/
public String getDomainName() {
return domainName;
}
/**
* The name of the domain you want to describe.
*
* Constraints:
* Length: 3 - 28
* Pattern: [a-z][a-z0-9\-]+
*
* @param domainName The name of the domain you want to describe.
*/
public void setDomainName(String domainName) {
this.domainName = 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\-]+
*
* @param domainName The name of the domain you want to describe.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeSuggestersRequest withDomainName(String domainName) {
this.domainName = domainName;
return this;
}
/**
* The suggesters you want to describe.
*
* @return The suggesters you want to describe.
*/
public java.util.List getSuggesterNames() {
if (suggesterNames == null) {
suggesterNames = new com.amazonaws.internal.ListWithAutoConstructFlag();
suggesterNames.setAutoConstruct(true);
}
return suggesterNames;
}
/**
* The suggesters you want to describe.
*
* @param suggesterNames The suggesters you want to describe.
*/
public void setSuggesterNames(java.util.Collection suggesterNames) {
if (suggesterNames == null) {
this.suggesterNames = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag suggesterNamesCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(suggesterNames.size());
suggesterNamesCopy.addAll(suggesterNames);
this.suggesterNames = suggesterNamesCopy;
}
/**
* The suggesters you want to describe.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param suggesterNames The suggesters you want to describe.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeSuggestersRequest withSuggesterNames(String... suggesterNames) {
if (getSuggesterNames() == null) setSuggesterNames(new java.util.ArrayList(suggesterNames.length));
for (String value : suggesterNames) {
getSuggesterNames().add(value);
}
return this;
}
/**
* The suggesters you want to describe.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param suggesterNames The suggesters you want to describe.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeSuggestersRequest withSuggesterNames(java.util.Collection suggesterNames) {
if (suggesterNames == null) {
this.suggesterNames = null;
} else {
com.amazonaws.internal.ListWithAutoConstructFlag suggesterNamesCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(suggesterNames.size());
suggesterNamesCopy.addAll(suggesterNames);
this.suggesterNames = suggesterNamesCopy;
}
return this;
}
/**
* Whether to display the deployed configuration (true) or
* include any pending changes (false). Defaults to
* false.
*
* @return Whether to display the deployed configuration (true) or
* include any pending changes (false). Defaults to
* false.
*/
public Boolean isDeployed() {
return deployed;
}
/**
* Whether to display the deployed configuration (true) or
* include any pending changes (false). Defaults to
* false.
*
* @param deployed Whether to display the deployed configuration (true) or
* include any pending changes (false). Defaults to
* false.
*/
public void setDeployed(Boolean deployed) {
this.deployed = 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.
*
* @param deployed Whether to display the deployed configuration (true) or
* include any pending changes (false). Defaults to
* false.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeSuggestersRequest withDeployed(Boolean deployed) {
this.deployed = deployed;
return this;
}
/**
* Whether to display the deployed configuration (true) or
* include any pending changes (false). Defaults to
* false.
*
* @return Whether to display the deployed configuration (true) or
* include any pending changes (false). Defaults to
* false.
*/
public Boolean getDeployed() {
return deployed;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getDomainName() != null) sb.append("DomainName: " + getDomainName() + ",");
if (getSuggesterNames() != null) sb.append("SuggesterNames: " + getSuggesterNames() + ",");
if (isDeployed() != null) sb.append("Deployed: " + isDeployed() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getDomainName() == null) ? 0 : getDomainName().hashCode());
hashCode = prime * hashCode + ((getSuggesterNames() == null) ? 0 : getSuggesterNames().hashCode());
hashCode = prime * hashCode + ((isDeployed() == null) ? 0 : isDeployed().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof DescribeSuggestersRequest == false) return false;
DescribeSuggestersRequest other = (DescribeSuggestersRequest)obj;
if (other.getDomainName() == null ^ this.getDomainName() == null) return false;
if (other.getDomainName() != null && other.getDomainName().equals(this.getDomainName()) == false) return false;
if (other.getSuggesterNames() == null ^ this.getSuggesterNames() == null) return false;
if (other.getSuggesterNames() != null && other.getSuggesterNames().equals(this.getSuggesterNames()) == false) return false;
if (other.isDeployed() == null ^ this.isDeployed() == null) return false;
if (other.isDeployed() != null && other.isDeployed().equals(this.isDeployed()) == false) return false;
return true;
}
}