com.amazonaws.services.cloudsearch.model.DescribeRankExpressionsRequest 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.cloudsearch.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
* Container for the parameters to the {@link com.amazonaws.services.cloudsearch.AmazonCloudSearch#describeRankExpressions(DescribeRankExpressionsRequest) DescribeRankExpressions operation}.
*
* Gets the rank expressions configured for the search domain. Can be limited to specific rank expressions by name. Shows all rank expressions by
* default.
*
*
* @see com.amazonaws.services.cloudsearch.AmazonCloudSearch#describeRankExpressions(DescribeRankExpressionsRequest)
*/
@Deprecated
public class DescribeRankExpressionsRequest extends AmazonWebServiceRequest implements Serializable {
/**
* A string that represents the name of a domain. Domain names must be
* unique across the domains owned by an account within an AWS region.
* Domain names must start with a letter or number and can contain the
* following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase
* letters and underscores are not allowed.
*
* Constraints:
* Length: 3 - 28
* Pattern: [a-z][a-z0-9\-]+
*/
private String domainName;
/**
* Limits the DescribeRankExpressions response to the
* specified fields.
*/
private com.amazonaws.internal.ListWithAutoConstructFlag rankNames;
/**
* A string that represents the name of a domain. Domain names must be
* unique across the domains owned by an account within an AWS region.
* Domain names must start with a letter or number and can contain the
* following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase
* letters and underscores are not allowed.
*
* Constraints:
* Length: 3 - 28
* Pattern: [a-z][a-z0-9\-]+
*
* @return A string that represents the name of a domain. Domain names must be
* unique across the domains owned by an account within an AWS region.
* Domain names must start with a letter or number and can contain the
* following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase
* letters and underscores are not allowed.
*/
public String getDomainName() {
return domainName;
}
/**
* A string that represents the name of a domain. Domain names must be
* unique across the domains owned by an account within an AWS region.
* Domain names must start with a letter or number and can contain the
* following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase
* letters and underscores are not allowed.
*
* Constraints:
* Length: 3 - 28
* Pattern: [a-z][a-z0-9\-]+
*
* @param domainName A string that represents the name of a domain. Domain names must be
* unique across the domains owned by an account within an AWS region.
* Domain names must start with a letter or number and can contain the
* following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase
* letters and underscores are not allowed.
*/
public void setDomainName(String domainName) {
this.domainName = domainName;
}
/**
* A string that represents the name of a domain. Domain names must be
* unique across the domains owned by an account within an AWS region.
* Domain names must start with a letter or number and can contain the
* following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase
* letters and underscores are not allowed.
*
* 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 A string that represents the name of a domain. Domain names must be
* unique across the domains owned by an account within an AWS region.
* Domain names must start with a letter or number and can contain the
* following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase
* letters and underscores are not allowed.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeRankExpressionsRequest withDomainName(String domainName) {
this.domainName = domainName;
return this;
}
/**
* Limits the DescribeRankExpressions response to the
* specified fields.
*
* @return Limits the DescribeRankExpressions response to the
* specified fields.
*/
public java.util.List getRankNames() {
if (rankNames == null) {
rankNames = new com.amazonaws.internal.ListWithAutoConstructFlag();
rankNames.setAutoConstruct(true);
}
return rankNames;
}
/**
* Limits the DescribeRankExpressions response to the
* specified fields.
*
* @param rankNames Limits the DescribeRankExpressions response to the
* specified fields.
*/
public void setRankNames(java.util.Collection rankNames) {
if (rankNames == null) {
this.rankNames = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag rankNamesCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(rankNames.size());
rankNamesCopy.addAll(rankNames);
this.rankNames = rankNamesCopy;
}
/**
* Limits the DescribeRankExpressions response to the
* specified fields.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param rankNames Limits the DescribeRankExpressions response to the
* specified fields.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeRankExpressionsRequest withRankNames(String... rankNames) {
if (getRankNames() == null) setRankNames(new java.util.ArrayList(rankNames.length));
for (String value : rankNames) {
getRankNames().add(value);
}
return this;
}
/**
* Limits the DescribeRankExpressions response to the
* specified fields.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param rankNames Limits the DescribeRankExpressions response to the
* specified fields.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeRankExpressionsRequest withRankNames(java.util.Collection rankNames) {
if (rankNames == null) {
this.rankNames = null;
} else {
com.amazonaws.internal.ListWithAutoConstructFlag rankNamesCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(rankNames.size());
rankNamesCopy.addAll(rankNames);
this.rankNames = rankNamesCopy;
}
return this;
}
/**
* 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 (getRankNames() != null) sb.append("RankNames: " + getRankNames() );
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 + ((getRankNames() == null) ? 0 : getRankNames().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof DescribeRankExpressionsRequest == false) return false;
DescribeRankExpressionsRequest other = (DescribeRankExpressionsRequest)obj;
if (other.getDomainName() == null ^ this.getDomainName() == null) return false;
if (other.getDomainName() != null && other.getDomainName().equals(this.getDomainName()) == false) return false;
if (other.getRankNames() == null ^ this.getRankNames() == null) return false;
if (other.getRankNames() != null && other.getRankNames().equals(this.getRankNames()) == false) return false;
return true;
}
}