com.amazonaws.services.cloudsearchv2.model.DescribeSuggestersRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-cloudsearch Show documentation
/*
* Copyright 2019-2024 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 javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* Container for the parameters to the DescribeSuggester operation. Specifies the name of the domain
* you want to describe. To restrict the response to particular suggesters, specify the names of the suggesters you want
* to describe. To show the active configuration and exclude any pending changes, set the Deployed option
* to true.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeSuggestersRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name of the domain you want to describe.
*
*/
private String domainName;
/**
*
* The suggesters you want to describe.
*
*/
private com.amazonaws.internal.SdkInternalList 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.
*
*
* @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.
*
*
* @return The name of the domain you want to describe.
*/
public String getDomainName() {
return this.domainName;
}
/**
*
* The name of the domain you want to describe.
*
*
* @param domainName
* The name of the domain you want to describe.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeSuggestersRequest withDomainName(String domainName) {
setDomainName(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.SdkInternalList();
}
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;
}
this.suggesterNames = new com.amazonaws.internal.SdkInternalList(suggesterNames);
}
/**
*
* The suggesters you want to describe.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setSuggesterNames(java.util.Collection)} or {@link #withSuggesterNames(java.util.Collection)} if you want
* to override the existing values.
*
*
* @param suggesterNames
* The suggesters you want to describe.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeSuggestersRequest withSuggesterNames(String... suggesterNames) {
if (this.suggesterNames == null) {
setSuggesterNames(new com.amazonaws.internal.SdkInternalList(suggesterNames.length));
}
for (String ele : suggesterNames) {
this.suggesterNames.add(ele);
}
return this;
}
/**
*
* The suggesters you want to describe.
*
*
* @param suggesterNames
* The suggesters you want to describe.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeSuggestersRequest withSuggesterNames(java.util.Collection suggesterNames) {
setSuggesterNames(suggesterNames);
return this;
}
/**
*
* 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.
*
*
* @return Whether to display the deployed configuration (true) or include any pending changes (
* false). Defaults to false.
*/
public Boolean getDeployed() {
return this.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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeSuggestersRequest withDeployed(Boolean deployed) {
setDeployed(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 isDeployed() {
return this.deployed;
}
/**
* 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.
*
* @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: ").append(getDomainName()).append(",");
if (getSuggesterNames() != null)
sb.append("SuggesterNames: ").append(getSuggesterNames()).append(",");
if (getDeployed() != null)
sb.append("Deployed: ").append(getDeployed());
sb.append("}");
return sb.toString();
}
@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.getDeployed() == null ^ this.getDeployed() == null)
return false;
if (other.getDeployed() != null && other.getDeployed().equals(this.getDeployed()) == false)
return false;
return true;
}
@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 + ((getDeployed() == null) ? 0 : getDeployed().hashCode());
return hashCode;
}
@Override
public DescribeSuggestersRequest clone() {
return (DescribeSuggestersRequest) super.clone();
}
}