com.amazonaws.services.cloudsearch.model.DefineRankExpressionRequest 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.cloudsearch.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
* Container for the parameters to the {@link com.amazonaws.services.cloudsearch.AmazonCloudSearch#defineRankExpression(DefineRankExpressionRequest) DefineRankExpression operation}.
*
* Configures a RankExpression for the search domain. Used to create new rank expressions and modify existing ones. If the expression
* exists, the new configuration replaces the old one. You can configure a maximum of 50 rank expressions.
*
*
* @see com.amazonaws.services.cloudsearch.AmazonCloudSearch#defineRankExpression(DefineRankExpressionRequest)
*/
@Deprecated
public class DefineRankExpressionRequest 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;
/**
* A named expression that can be evaluated at search time and used for
* ranking or thresholding in a search query.
*/
private NamedRankExpression rankExpression;
/**
* 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 DefineRankExpressionRequest withDomainName(String domainName) {
this.domainName = domainName;
return this;
}
/**
* A named expression that can be evaluated at search time and used for
* ranking or thresholding in a search query.
*
* @return A named expression that can be evaluated at search time and used for
* ranking or thresholding in a search query.
*/
public NamedRankExpression getRankExpression() {
return rankExpression;
}
/**
* A named expression that can be evaluated at search time and used for
* ranking or thresholding in a search query.
*
* @param rankExpression A named expression that can be evaluated at search time and used for
* ranking or thresholding in a search query.
*/
public void setRankExpression(NamedRankExpression rankExpression) {
this.rankExpression = rankExpression;
}
/**
* A named expression that can be evaluated at search time and used for
* ranking or thresholding in a search query.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param rankExpression A named expression that can be evaluated at search time and used for
* ranking or thresholding in a search query.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DefineRankExpressionRequest withRankExpression(NamedRankExpression rankExpression) {
this.rankExpression = rankExpression;
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 (getRankExpression() != null) sb.append("RankExpression: " + getRankExpression() );
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 + ((getRankExpression() == null) ? 0 : getRankExpression().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof DefineRankExpressionRequest == false) return false;
DefineRankExpressionRequest other = (DefineRankExpressionRequest)obj;
if (other.getDomainName() == null ^ this.getDomainName() == null) return false;
if (other.getDomainName() != null && other.getDomainName().equals(this.getDomainName()) == false) return false;
if (other.getRankExpression() == null ^ this.getRankExpression() == null) return false;
if (other.getRankExpression() != null && other.getRankExpression().equals(this.getRankExpression()) == false) return false;
return true;
}
}