All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.amazonaws.services.cloudsearchv2.model.DescribeIndexFieldsRequest Maven / Gradle / Ivy

Go to download

The Amazon Web Services SDK for Java provides Java APIs for building software on AWS' cost-effective, scalable, and reliable infrastructure products. The AWS Java SDK allows developers to code against APIs for all of Amazon's infrastructure web services (Amazon S3, Amazon EC2, Amazon SQS, Amazon Relational Database Service, Amazon AutoScaling, etc).

The newest version!
/*
 * 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#describeIndexFields(DescribeIndexFieldsRequest) DescribeIndexFields operation}.
 * 

* Gets information about the index fields configured for the search * domain. Can be limited to specific fields by name. By default, shows * all fields 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 * Getting Domain Information * in the Amazon CloudSearch Developer Guide . *

* * @see com.amazonaws.services.cloudsearchv2.AmazonCloudSearch#describeIndexFields(DescribeIndexFieldsRequest) */ public class DescribeIndexFieldsRequest extends AmazonWebServiceRequest implements Serializable { /** * The name of the domain you want to describe. *

* Constraints:
* Length: 3 - 28
* Pattern: [a-z][a-z0-9\-]+
*/ private String domainName; /** * A list of the index fields you want to describe. If not specified, * information is returned for all configured index fields. */ private com.amazonaws.internal.ListWithAutoConstructFlag fieldNames; /** * 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 DescribeIndexFieldsRequest withDomainName(String domainName) { this.domainName = domainName; return this; } /** * A list of the index fields you want to describe. If not specified, * information is returned for all configured index fields. * * @return A list of the index fields you want to describe. If not specified, * information is returned for all configured index fields. */ public java.util.List getFieldNames() { if (fieldNames == null) { fieldNames = new com.amazonaws.internal.ListWithAutoConstructFlag(); fieldNames.setAutoConstruct(true); } return fieldNames; } /** * A list of the index fields you want to describe. If not specified, * information is returned for all configured index fields. * * @param fieldNames A list of the index fields you want to describe. If not specified, * information is returned for all configured index 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; } /** * A list of the index fields you want to describe. If not specified, * information is returned for all configured index fields. *

* Returns a reference to this object so that method calls can be chained together. * * @param fieldNames A list of the index fields you want to describe. If not specified, * information is returned for all configured index 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; } /** * A list of the index fields you want to describe. If not specified, * information is returned for all configured index fields. *

* Returns a reference to this object so that method calls can be chained together. * * @param fieldNames A list of the index fields you want to describe. If not specified, * information is returned for all configured index 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; } /** * 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 DescribeIndexFieldsRequest 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 (getFieldNames() != null) sb.append("FieldNames: " + getFieldNames() + ","); 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 + ((getFieldNames() == null) ? 0 : getFieldNames().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 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; if (other.isDeployed() == null ^ this.isDeployed() == null) return false; if (other.isDeployed() != null && other.isDeployed().equals(this.isDeployed()) == false) return false; return true; } }





© 2015 - 2025 Weber Informatics LLC | Privacy Policy