com.amazonaws.services.cloudsearchv2.model.DescribeExpressionsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-cloudsearch Show documentation
/*
* Copyright 2010-2015 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#describeExpressions(DescribeExpressionsRequest) DescribeExpressions operation}.
*
* Gets the expressions configured for the search domain. Can be limited
* to specific expressions by name. By default, shows all expressions 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
* Configuring Expressions
* in the Amazon CloudSearch Developer Guide .
*
*
* @see com.amazonaws.services.cloudsearchv2.AmazonCloudSearch#describeExpressions(DescribeExpressionsRequest)
*/
public class DescribeExpressionsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable {
/**
* The name of the domain you want to describe.
*
* Constraints:
* Length: 3 - 28
* Pattern: [a-z][a-z0-9\-]+
*/
private String domainName;
/**
* Limits the DescribeExpressions response to the
* specified expressions. If not specified, all expressions are shown.
*/
private com.amazonaws.internal.ListWithAutoConstructFlag expressionNames;
/**
* 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 DescribeExpressionsRequest withDomainName(String domainName) {
this.domainName = domainName;
return this;
}
/**
* Limits the DescribeExpressions response to the
* specified expressions. If not specified, all expressions are shown.
*
* @return Limits the DescribeExpressions response to the
* specified expressions. If not specified, all expressions are shown.
*/
public java.util.List getExpressionNames() {
if (expressionNames == null) {
expressionNames = new com.amazonaws.internal.ListWithAutoConstructFlag();
expressionNames.setAutoConstruct(true);
}
return expressionNames;
}
/**
* Limits the DescribeExpressions response to the
* specified expressions. If not specified, all expressions are shown.
*
* @param expressionNames Limits the DescribeExpressions response to the
* specified expressions. If not specified, all expressions are shown.
*/
public void setExpressionNames(java.util.Collection expressionNames) {
if (expressionNames == null) {
this.expressionNames = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag expressionNamesCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(expressionNames.size());
expressionNamesCopy.addAll(expressionNames);
this.expressionNames = expressionNamesCopy;
}
/**
* 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 {@link #setExpressionNames(java.util.Collection)} or {@link
* #withExpressionNames(java.util.Collection)} if you want to override
* the existing values.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param expressionNames Limits the DescribeExpressions response to the
* specified expressions. If not specified, all expressions are shown.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeExpressionsRequest withExpressionNames(String... expressionNames) {
if (getExpressionNames() == null) setExpressionNames(new java.util.ArrayList(expressionNames.length));
for (String value : expressionNames) {
getExpressionNames().add(value);
}
return this;
}
/**
* Limits the DescribeExpressions response to the
* specified expressions. If not specified, all expressions are shown.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param expressionNames Limits the DescribeExpressions response to the
* specified expressions. If not specified, all expressions are shown.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeExpressionsRequest withExpressionNames(java.util.Collection expressionNames) {
if (expressionNames == null) {
this.expressionNames = null;
} else {
com.amazonaws.internal.ListWithAutoConstructFlag expressionNamesCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(expressionNames.size());
expressionNamesCopy.addAll(expressionNames);
this.expressionNames = expressionNamesCopy;
}
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 DescribeExpressionsRequest 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 (getExpressionNames() != null) sb.append("ExpressionNames: " + getExpressionNames() + ",");
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 + ((getExpressionNames() == null) ? 0 : getExpressionNames().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 DescribeExpressionsRequest == false) return false;
DescribeExpressionsRequest other = (DescribeExpressionsRequest)obj;
if (other.getDomainName() == null ^ this.getDomainName() == null) return false;
if (other.getDomainName() != null && other.getDomainName().equals(this.getDomainName()) == false) return false;
if (other.getExpressionNames() == null ^ this.getExpressionNames() == null) return false;
if (other.getExpressionNames() != null && other.getExpressionNames().equals(this.getExpressionNames()) == 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;
}
@Override
public DescribeExpressionsRequest clone() {
return (DescribeExpressionsRequest) super.clone();
}
}