software.amazon.awssdk.services.cloudsearch.model.DescribeIndexFieldsRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of cloudsearch Show documentation
Show all versions of cloudsearch Show documentation
The AWS Java SDK for Amazon CloudSearch module holds the client classes that are used for communicating
with Amazon CloudSearch Service
/*
* Copyright 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 software.amazon.awssdk.services.cloudsearch.model;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Container for the parameters to the DescribeIndexFields operation. Specifies the name of the
* domain you want to describe. To restrict the response to particular index fields, specify the names of the index
* fields you want to describe. To show the active configuration and exclude any pending changes, set the
* Deployed option to true.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeIndexFieldsRequest extends CloudSearchRequest implements
ToCopyableBuilder {
private static final SdkField DOMAIN_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DomainName").getter(getter(DescribeIndexFieldsRequest::domainName)).setter(setter(Builder::domainName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DomainName").build()).build();
private static final SdkField> FIELD_NAMES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("FieldNames")
.getter(getter(DescribeIndexFieldsRequest::fieldNames))
.setter(setter(Builder::fieldNames))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("FieldNames").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField DEPLOYED_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("Deployed").getter(getter(DescribeIndexFieldsRequest::deployed)).setter(setter(Builder::deployed))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Deployed").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DOMAIN_NAME_FIELD,
FIELD_NAMES_FIELD, DEPLOYED_FIELD));
private final String domainName;
private final List fieldNames;
private final Boolean deployed;
private DescribeIndexFieldsRequest(BuilderImpl builder) {
super(builder);
this.domainName = builder.domainName;
this.fieldNames = builder.fieldNames;
this.deployed = builder.deployed;
}
/**
*
* The name of the domain you want to describe.
*
*
* @return The name of the domain you want to describe.
*/
public final String domainName() {
return domainName;
}
/**
* Returns true if the FieldNames property was specified by the sender (it may be empty), or false if the sender did
* not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
*/
public final boolean hasFieldNames() {
return fieldNames != null && !(fieldNames instanceof SdkAutoConstructList);
}
/**
*
* A list of the index fields you want to describe. If not specified, information is returned for all configured
* index fields.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasFieldNames()} to see if a value was sent in this field.
*
*
* @return A list of the index fields you want to describe. If not specified, information is returned for all
* configured index fields.
*/
public final List fieldNames() {
return fieldNames;
}
/**
*
* 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 final Boolean deployed() {
return deployed;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(domainName());
hashCode = 31 * hashCode + Objects.hashCode(hasFieldNames() ? fieldNames() : null);
hashCode = 31 * hashCode + Objects.hashCode(deployed());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof DescribeIndexFieldsRequest)) {
return false;
}
DescribeIndexFieldsRequest other = (DescribeIndexFieldsRequest) obj;
return Objects.equals(domainName(), other.domainName()) && hasFieldNames() == other.hasFieldNames()
&& Objects.equals(fieldNames(), other.fieldNames()) && Objects.equals(deployed(), other.deployed());
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*/
@Override
public final String toString() {
return ToString.builder("DescribeIndexFieldsRequest").add("DomainName", domainName())
.add("FieldNames", hasFieldNames() ? fieldNames() : null).add("Deployed", deployed()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "DomainName":
return Optional.ofNullable(clazz.cast(domainName()));
case "FieldNames":
return Optional.ofNullable(clazz.cast(fieldNames()));
case "Deployed":
return Optional.ofNullable(clazz.cast(deployed()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeIndexFieldsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends CloudSearchRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The name of the domain you want to describe.
*
*
* @param domainName
* The name of the domain you want to describe.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder domainName(String domainName);
/**
*
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder fieldNames(Collection 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder fieldNames(String... fieldNames);
/**
*
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder deployed(Boolean deployed);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends CloudSearchRequest.BuilderImpl implements Builder {
private String domainName;
private List fieldNames = DefaultSdkAutoConstructList.getInstance();
private Boolean deployed;
private BuilderImpl() {
}
private BuilderImpl(DescribeIndexFieldsRequest model) {
super(model);
domainName(model.domainName);
fieldNames(model.fieldNames);
deployed(model.deployed);
}
public final String getDomainName() {
return domainName;
}
@Override
public final Builder domainName(String domainName) {
this.domainName = domainName;
return this;
}
public final void setDomainName(String domainName) {
this.domainName = domainName;
}
public final Collection getFieldNames() {
if (fieldNames instanceof SdkAutoConstructList) {
return null;
}
return fieldNames;
}
@Override
public final Builder fieldNames(Collection fieldNames) {
this.fieldNames = DynamicFieldNameListCopier.copy(fieldNames);
return this;
}
@Override
@SafeVarargs
public final Builder fieldNames(String... fieldNames) {
fieldNames(Arrays.asList(fieldNames));
return this;
}
public final void setFieldNames(Collection fieldNames) {
this.fieldNames = DynamicFieldNameListCopier.copy(fieldNames);
}
public final Boolean getDeployed() {
return deployed;
}
@Override
public final Builder deployed(Boolean deployed) {
this.deployed = deployed;
return this;
}
public final void setDeployed(Boolean deployed) {
this.deployed = deployed;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public DescribeIndexFieldsRequest build() {
return new DescribeIndexFieldsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy