Package co.elastic.clients.elasticsearch.indices

Class PutAliasRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.indices.PutAliasRequest

All Implemented Interfaces:

ElasticsearchCommonRequest, JsonpSerializable

@JsonpDeserializable
public final class PutAliasRequest
extends RequestBase
implements JsonpSerializable

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._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,ElasticsearchError>	ENDPOINT	Endpoint "indices.put_alias".

Constructor Summary

Constructors

Constructor	Description
PutAliasRequest(PutAliasRequest.Builder builder)
PutAliasRequest(java.util.function.Function<PutAliasRequest.Builder,PutAliasRequest.Builder> fn)

Method Summary

Modifier and Type	Method	Description
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
java.lang.String	masterTimeout()	Specify timeout for connection to master
java.lang.String	name()	Required - The name of the alias to be created or updated
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(DelegatingDeserializer<PutAliasRequest.Builder> op)
java.lang.String	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 Details

_DESERIALIZER

public static final JsonpDeserializer<PutAliasRequest> _DESERIALIZER

Json deserializer for PutAliasRequest

ENDPOINT

public static final Endpoint<PutAliasRequest,PutAliasResponse,ElasticsearchError> ENDPOINT

Endpoint "indices.put_alias".

Constructor Details

PutAliasRequest

public PutAliasRequest(PutAliasRequest.Builder builder)

PutAliasRequest

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

Method Details

index

public 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

name

public java.lang.String name()

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

API name: name

masterTimeout

@Nullable
public java.lang.String masterTimeout()

Specify timeout for connection to master

API name: master_timeout

timeout

@Nullable
public java.lang.String timeout()

Explicit timestamp for the document

API name: timeout

filter

@Nullable
public Query filter()

API name: filter

indexRouting

@Nullable
public java.lang.String indexRouting()

API name: index_routing

isWriteIndex

@Nullable
public java.lang.Boolean isWriteIndex()

API name: is_write_index

routing

@Nullable
public java.lang.String routing()

API name: routing

searchRouting

@Nullable
public java.lang.String searchRouting()

API name: search_routing

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(DelegatingDeserializer<PutAliasRequest.Builder> op)