Package org.opensearch.client.opensearch.indices

Class PutAliasRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.indices.PutAliasRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class PutAliasRequest
extends RequestBase
implements JsonpSerializable

Creates or updates an alias.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<PutAliasRequest>	_DESERIALIZER	Json deserializer for PutAliasRequest
static Endpoint<PutAliasRequest,PutAliasResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.put_alias".

Method Summary

Modifier and Type	Method	Description
Time	clusterManagerTimeout()	Specify timeout for connection to cluster-manager
Query	filter()	API name: filter
java.util.List<java.lang.String>	index()	Required - A comma-separated list of index names the alias should point to (supports wildcards); use _all to perform the operation on all indices.
java.lang.String	indexRouting()	API name: index_routing
java.lang.Boolean	isWriteIndex()	API name: is_write_index
Time	masterTimeout()	Deprecated.
java.lang.String	name()	Required - The name of the alias to be created or updated
static PutAliasRequest	of(java.util.function.Function<PutAliasRequest.Builder,ObjectBuilder<PutAliasRequest>> fn)
java.lang.String	routing()	API name: routing
java.lang.String	searchRouting()	API name: search_routing
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	setupPutAliasRequestDeserializer(ObjectDeserializer<PutAliasRequest.Builder> op)
Time	timeout()	Explicit timestamp for the document

Methods inherited from class java.lang.Object

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

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<PutAliasRequest> _DESERIALIZER

Json deserializer for PutAliasRequest

_ENDPOINT

public static final Endpoint<PutAliasRequest,PutAliasResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.put_alias".

Method Detail

of

public static PutAliasRequest of(java.util.function.Function<PutAliasRequest.Builder,ObjectBuilder<PutAliasRequest>> fn)

filter

@Nullable
public final Query filter()

API name: filter

index

public final java.util.List<java.lang.String> index()

Required - A comma-separated list of index names the alias should point to (supports wildcards); use _all to perform the operation on all indices.

API name: index

indexRouting

@Nullable
public final java.lang.String indexRouting()

API name: index_routing

isWriteIndex

@Nullable
public final java.lang.Boolean isWriteIndex()

API name: is_write_index

masterTimeout

@Deprecated
@Nullable
public final Time masterTimeout()

Deprecated.

Specify timeout for connection to master

API name: master_timeout

clusterManagerTimeout

@Nullable
public final Time clusterManagerTimeout()

Specify timeout for connection to cluster-manager

API name: cluster_manager_timeout

name

public final java.lang.String name()

Required - The name of the alias to be created or updated

API name: name

routing

@Nullable
public final java.lang.String routing()

API name: routing

searchRouting

@Nullable
public final java.lang.String searchRouting()

API name: search_routing

timeout

@Nullable
public final Time timeout()

Explicit timestamp for the document

API name: timeout

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)

setupPutAliasRequestDeserializer

protected static void setupPutAliasRequestDeserializer(ObjectDeserializer<PutAliasRequest.Builder> op)