software.amazon.awssdk.services.opensearch.model.AdvancedOptionsStatus Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of opensearch Show documentation
Show all versions of opensearch Show documentation
The AWS Java SDK for Open Search module holds the client classes that are used for
communicating with Open Search.
/*
* 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.opensearch.model;
import java.beans.Transient;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Map;
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.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.LocationTrait;
import software.amazon.awssdk.core.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Status of the advanced options for the specified domain. Currently, the following advanced options are available:
*
*
* - Option to allow references to indices in an HTTP request body. Must be
false when configuring access
* to individual sub-resources. By default, the value is true. See Advanced cluster parameters for more information.
* - Option to specify the percentage of heap space allocated to field data. By default, this setting is unbounded.
*
*
* For more information, see Advanced cluster parameters.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class AdvancedOptionsStatus implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField> OPTIONS_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("Options")
.getter(getter(AdvancedOptionsStatus::options))
.setter(setter(Builder::options))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Options").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final SdkField STATUS_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("Status").getter(getter(AdvancedOptionsStatus::status)).setter(setter(Builder::status))
.constructor(OptionStatus::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Status").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(OPTIONS_FIELD, STATUS_FIELD));
private static final long serialVersionUID = 1L;
private final Map options;
private final OptionStatus status;
private AdvancedOptionsStatus(BuilderImpl builder) {
this.options = builder.options;
this.status = builder.status;
}
/**
* For responses, this returns true if the service returned a value for the Options property. This DOES NOT check
* that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property). This is
* useful because the SDK will never return a null collection or map, but you may need to differentiate between the
* service returning nothing (or null) and the service returning an empty collection or map. For requests, this
* returns true if a value for the property was specified in the request builder, and false if a value was not
* specified.
*/
public final boolean hasOptions() {
return options != null && !(options instanceof SdkAutoConstructMap);
}
/**
*
* The status of advanced options for the specified domain.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasOptions} method.
*
*
* @return The status of advanced options for the specified domain.
*/
public final Map options() {
return options;
}
/**
*
* The OptionStatus for advanced options for the specified domain.
*
*
* @return The OptionStatus for advanced options for the specified domain.
*/
public final OptionStatus status() {
return status;
}
@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 + Objects.hashCode(hasOptions() ? options() : null);
hashCode = 31 * hashCode + Objects.hashCode(status());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof AdvancedOptionsStatus)) {
return false;
}
AdvancedOptionsStatus other = (AdvancedOptionsStatus) obj;
return hasOptions() == other.hasOptions() && Objects.equals(options(), other.options())
&& Objects.equals(status(), other.status());
}
/**
* 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("AdvancedOptionsStatus").add("Options", hasOptions() ? options() : null).add("Status", status())
.build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Options":
return Optional.ofNullable(clazz.cast(options()));
case "Status":
return Optional.ofNullable(clazz.cast(status()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((AdvancedOptionsStatus) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The status of advanced options for the specified domain.
*
*
* @param options
* The status of advanced options for the specified domain.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder options(Map options);
/**
*
* The OptionStatus for advanced options for the specified domain.
*
*
* @param status
* The OptionStatus for advanced options for the specified domain.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder status(OptionStatus status);
/**
*
* The OptionStatus for advanced options for the specified domain.
*
* This is a convenience that creates an instance of the {@link OptionStatus.Builder} avoiding the need to
* create one manually via {@link OptionStatus#builder()}.
*
* When the {@link Consumer} completes, {@link OptionStatus.Builder#build()} is called immediately and its
* result is passed to {@link #status(OptionStatus)}.
*
* @param status
* a consumer that will call methods on {@link OptionStatus.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #status(OptionStatus)
*/
default Builder status(Consumer status) {
return status(OptionStatus.builder().applyMutation(status).build());
}
}
static final class BuilderImpl implements Builder {
private Map options = DefaultSdkAutoConstructMap.getInstance();
private OptionStatus status;
private BuilderImpl() {
}
private BuilderImpl(AdvancedOptionsStatus model) {
options(model.options);
status(model.status);
}
public final Map getOptions() {
if (options instanceof SdkAutoConstructMap) {
return null;
}
return options;
}
public final void setOptions(Map options) {
this.options = AdvancedOptionsCopier.copy(options);
}
@Override
@Transient
public final Builder options(Map options) {
this.options = AdvancedOptionsCopier.copy(options);
return this;
}
public final OptionStatus.Builder getStatus() {
return status != null ? status.toBuilder() : null;
}
public final void setStatus(OptionStatus.BuilderImpl status) {
this.status = status != null ? status.build() : null;
}
@Override
@Transient
public final Builder status(OptionStatus status) {
this.status = status;
return this;
}
@Override
public AdvancedOptionsStatus build() {
return new AdvancedOptionsStatus(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy