software.amazon.awssdk.services.opensearch.model

Class AdvancedOptionsStatus

java.lang.Object

software.amazon.awssdk.services.opensearch.model.AdvancedOptionsStatus

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AdvancedOptionsStatus.Builder,AdvancedOptionsStatus>

@Generated(value="software.amazon.awssdk:codegen")
public final class AdvancedOptionsStatus
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AdvancedOptionsStatus.Builder,AdvancedOptionsStatus>

Status of the advanced options for the specified domain. The following options are available:

• "rest.action.multi.allow_explicit_index": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true.

• "indices.fielddata.cache.size": "80" - Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded.

• "indices.query.bool.max_clause_count": "1024" - Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a TooManyClauses error.

• "override_main_response_version": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with it. Default is false when creating a domain and true when upgrading a domain.

For more information, see Advanced cluster parameters.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AdvancedOptionsStatus.Builder

Method Summary

Modifier and Type	Method and Description
static AdvancedOptionsStatus.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasOptions() For responses, this returns true if the service returned a value for the Options property.
Map<String,String>	options() The status of advanced options for the specified domain.
List<SdkField<?>>	sdkFields()
static Class<? extends AdvancedOptionsStatus.Builder>	serializableBuilderClass()
OptionStatus	status() The status of advanced options for the specified domain.
AdvancedOptionsStatus.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasOptions

public final boolean hasOptions()

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 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.

options

public final Map<String,String> options()

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 hasOptions() method.

Returns:

The status of advanced options for the specified domain.

status

public final OptionStatus status()

The status of advanced options for the specified domain.

Returns:

The status of advanced options for the specified domain.

toBuilder

public AdvancedOptionsStatus.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AdvancedOptionsStatus.Builder,AdvancedOptionsStatus>

builder

public static AdvancedOptionsStatus.Builder builder()

serializableBuilderClass

public static Class<? extends AdvancedOptionsStatus.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo