Package org.opensearch.client.opensearch.indices.update_aliases

Class RemoveAction

java.lang.Object

org.opensearch.client.opensearch.indices.update_aliases.RemoveAction

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ActionVariant, ToCopyableBuilder<RemoveAction.Builder,RemoveAction>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class RemoveAction
extends Object
implements ActionVariant, PlainJsonSerializable, ToCopyableBuilder<RemoveAction.Builder,RemoveAction>

The configuration for removing an alias.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RemoveAction.Builder	Builder for RemoveAction.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<RemoveAction>	_DESERIALIZER	Json deserializer for RemoveAction

Method Summary

Modifier and Type	Method	Description
Action.Kind	_actionKind()	Action variant kind.
final String	alias()	API name: alias
final List<String>	aliases()	The list of aliases to remove.
static RemoveAction.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final String	index()	API name: index
final List<String>	indices()	API name: indices
final Boolean	mustExist()	Whether the alias must exist to perform the action.
static RemoveAction	of(Function<RemoveAction.Builder,ObjectBuilder<RemoveAction>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupRemoveActionDeserializer(ObjectDeserializer<RemoveAction.Builder> op)
RemoveAction.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.opensearch.indices.update_aliases.ActionVariant

toAction

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<RemoveAction> _DESERIALIZER

Json deserializer for RemoveAction

Method Details

of

public static RemoveAction of(Function<RemoveAction.Builder,ObjectBuilder<RemoveAction>> fn)

_actionKind

public Action.Kind _actionKind()

Action variant kind.

Specified by:

_actionKind in interface ActionVariant

alias

@Nullable
public final String alias()

API name: alias

aliases

@Nonnull
public final List<String> aliases()

The list of aliases to remove. Index alias names support date math.

API name: aliases

index

@Nullable
public final String index()

API name: index

indices

@Nonnull
public final List<String> indices()

API name: indices

mustExist

@Nullable
public final Boolean mustExist()

Whether the alias must exist to perform the action.

API name: must_exist

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

toBuilder

@Nonnull
public RemoveAction.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<RemoveAction.Builder,RemoveAction>

Returns:

a new builder instance.

builder

@Nonnull
public static RemoveAction.Builder builder()

setupRemoveActionDeserializer

protected static void setupRemoveActionDeserializer(ObjectDeserializer<RemoveAction.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object