com.amazonaws.services.cloudsearch.model.DescribeIndexFieldsRequest 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#describeIndexFields(DescribeIndexFieldsRequest) DescribeIndexFields operation}.
*
* Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. Shows all fields by default.
*
*
* @see com.amazonaws.services.cloudsearch.AmazonCloudSearch#describeIndexFields(DescribeIndexFieldsRequest)
* @deprecated Use {@link com.amazonaws.services.cloudsearchv2.model.DescribeIndexFieldsRequest} instead.
*/
@Deprecated
public class DescribeIndexFieldsRequest 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 DescribeIndexFields response to the specified
* fields.
*/
private com.amazonaws.internal.ListWithAutoConstructFlag fieldNames;
/**
* 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 DescribeIndexFieldsRequest withDomainName(String domainName) {
this.domainName = domainName;
return this;
}
/**
* Limits the DescribeIndexFields response to the specified
* fields.
*
* @return Limits the DescribeIndexFields response to the specified
* fields.
*/
public java.util.List getFieldNames() {
if (fieldNames == null) {
fieldNames = new com.amazonaws.internal.ListWithAutoConstructFlag();
fieldNames.setAutoConstruct(true);
}
return fieldNames;
}
/**
* Limits the DescribeIndexFields response to the specified
* fields.
*
* @param fieldNames Limits the DescribeIndexFields response to the specified
* fields.
*/
public void setFieldNames(java.util.Collection fieldNames) {
if (fieldNames == null) {
this.fieldNames = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag fieldNamesCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(fieldNames.size());
fieldNamesCopy.addAll(fieldNames);
this.fieldNames = fieldNamesCopy;
}
/**
* Limits the DescribeIndexFields response to the specified
* fields.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param fieldNames Limits the DescribeIndexFields response to the specified
* fields.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeIndexFieldsRequest withFieldNames(String... fieldNames) {
if (getFieldNames() == null) setFieldNames(new java.util.ArrayList(fieldNames.length));
for (String value : fieldNames) {
getFieldNames().add(value);
}
return this;
}
/**
* Limits the DescribeIndexFields response to the specified
* fields.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param fieldNames Limits the DescribeIndexFields response to the specified
* fields.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeIndexFieldsRequest withFieldNames(java.util.Collection fieldNames) {
if (fieldNames == null) {
this.fieldNames = null;
} else {
com.amazonaws.internal.ListWithAutoConstructFlag fieldNamesCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(fieldNames.size());
fieldNamesCopy.addAll(fieldNames);
this.fieldNames = fieldNamesCopy;
}
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 (getFieldNames() != null) sb.append("FieldNames: " + getFieldNames() );
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 + ((getFieldNames() == null) ? 0 : getFieldNames().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof DescribeIndexFieldsRequest == false) return false;
DescribeIndexFieldsRequest other = (DescribeIndexFieldsRequest)obj;
if (other.getDomainName() == null ^ this.getDomainName() == null) return false;
if (other.getDomainName() != null && other.getDomainName().equals(this.getDomainName()) == false) return false;
if (other.getFieldNames() == null ^ this.getFieldNames() == null) return false;
if (other.getFieldNames() != null && other.getFieldNames().equals(this.getFieldNames()) == false) return false;
return true;
}
}