com.amazonaws.services.cloudsearchv2.model.DefineIndexFieldRequest 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#defineIndexField(DefineIndexFieldRequest) DefineIndexField operation}.
*
* Configures an IndexField for the search domain. Used to
* create new fields and modify existing ones. You must specify the name
* of the domain you are configuring and an index field configuration.
* The index field configuration specifies a unique name, the index field
* type, and the options you want to configure for the field. The options
* you can specify depend on the IndexFieldType . If the
* field exists, the new configuration replaces the old one. For more
* information, see
* Configuring Index Fields
* in the Amazon CloudSearch Developer Guide .
*
*
* @see com.amazonaws.services.cloudsearchv2.AmazonCloudSearch#defineIndexField(DefineIndexFieldRequest)
*/
public class DefineIndexFieldRequest extends AmazonWebServiceRequest implements Serializable {
/**
* A string that represents the name of a domain. Domain names are unique
* across the domains owned by an account within an AWS region. Domain
* names start with a letter or number and can contain the following
* characters: a-z (lowercase), 0-9, and - (hyphen).
*
* Constraints:
* Length: 3 - 28
* Pattern: [a-z][a-z0-9\-]+
*/
private String domainName;
/**
* The index field and field options you want to configure.
*/
private IndexField indexField;
/**
* A string that represents the name of a domain. Domain names are unique
* across the domains owned by an account within an AWS region. Domain
* names start with a letter or number and can contain the following
* characters: a-z (lowercase), 0-9, and - (hyphen).
*
* Constraints:
* Length: 3 - 28
* Pattern: [a-z][a-z0-9\-]+
*
* @return A string that represents the name of a domain. Domain names are unique
* across the domains owned by an account within an AWS region. Domain
* names start with a letter or number and can contain the following
* characters: a-z (lowercase), 0-9, and - (hyphen).
*/
public String getDomainName() {
return domainName;
}
/**
* A string that represents the name of a domain. Domain names are unique
* across the domains owned by an account within an AWS region. Domain
* names start with a letter or number and can contain the following
* characters: a-z (lowercase), 0-9, and - (hyphen).
*
* Constraints:
* Length: 3 - 28
* Pattern: [a-z][a-z0-9\-]+
*
* @param domainName A string that represents the name of a domain. Domain names are unique
* across the domains owned by an account within an AWS region. Domain
* names start with a letter or number and can contain the following
* characters: a-z (lowercase), 0-9, and - (hyphen).
*/
public void setDomainName(String domainName) {
this.domainName = domainName;
}
/**
* A string that represents the name of a domain. Domain names are unique
* across the domains owned by an account within an AWS region. Domain
* names start with a letter or number and can contain the following
* characters: a-z (lowercase), 0-9, and - (hyphen).
*
* 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 are unique
* across the domains owned by an account within an AWS region. Domain
* names start with a letter or number and can contain the following
* characters: a-z (lowercase), 0-9, and - (hyphen).
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DefineIndexFieldRequest withDomainName(String domainName) {
this.domainName = domainName;
return this;
}
/**
* The index field and field options you want to configure.
*
* @return The index field and field options you want to configure.
*/
public IndexField getIndexField() {
return indexField;
}
/**
* The index field and field options you want to configure.
*
* @param indexField The index field and field options you want to configure.
*/
public void setIndexField(IndexField indexField) {
this.indexField = indexField;
}
/**
* The index field and field options you want to configure.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param indexField The index field and field options you want to configure.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DefineIndexFieldRequest withIndexField(IndexField indexField) {
this.indexField = indexField;
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 (getIndexField() != null) sb.append("IndexField: " + getIndexField() );
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 + ((getIndexField() == null) ? 0 : getIndexField().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof DefineIndexFieldRequest == false) return false;
DefineIndexFieldRequest other = (DefineIndexFieldRequest)obj;
if (other.getDomainName() == null ^ this.getDomainName() == null) return false;
if (other.getDomainName() != null && other.getDomainName().equals(this.getDomainName()) == false) return false;
if (other.getIndexField() == null ^ this.getIndexField() == null) return false;
if (other.getIndexField() != null && other.getIndexField().equals(this.getIndexField()) == false) return false;
return true;
}
}