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:

ToJsonp

public final class PutAliasRequest
extends RequestBase
implements ToJsonp

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<PutAliasRequest>	DESERIALIZER	Json deserializer for PutAliasRequest
static Endpoint<PutAliasRequest,PutAliasResponse,OpenSearchError>	ENDPOINT	Endpoint "indices.put_alias".

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PutAliasRequest(PutAliasRequest.Builder builder)

Method Summary

Modifier and Type	Method	Description
QueryContainer	filter()	API name: filter
java.util.List<java.lang.String>	index()	API name: index
jakarta.json.JsonValue	indexRouting()	API name: index_routing
java.lang.Boolean	isWriteIndex()	API name: is_write_index
jakarta.json.JsonValue	masterTimeout()	API name: master_timeout
java.lang.String	name()	API name: name
jakarta.json.JsonValue	routing()	API name: routing
jakarta.json.JsonValue	searchRouting()	API name: search_routing
protected static void	setupPutAliasRequestDeserializer(DelegatingDeserializer<PutAliasRequest.Builder> op)
jakarta.json.JsonValue	timeout()	API name: timeout
void	toJsonp(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	toJsonpInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

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,OpenSearchError> ENDPOINT

Endpoint "indices.put_alias".

Constructor Details

PutAliasRequest

protected PutAliasRequest(PutAliasRequest.Builder builder)

Method Details

index

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

API name: index

name

public java.lang.String name()

API name: name

masterTimeout

@Nullable public jakarta.json.JsonValue masterTimeout()

API name: master_timeout

timeout

@Nullable public jakarta.json.JsonValue timeout()

API name: timeout

filter

@Nullable public QueryContainer filter()

API name: filter

indexRouting

@Nullable public jakarta.json.JsonValue indexRouting()

API name: index_routing

isWriteIndex

@Nullable public java.lang.Boolean isWriteIndex()

API name: is_write_index

routing

@Nullable public jakarta.json.JsonValue routing()

API name: routing

searchRouting

@Nullable public jakarta.json.JsonValue searchRouting()

API name: search_routing

toJsonp

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

Serialize this object to JSON.

Specified by:

toJsonp in interface ToJsonp

toJsonpInternal

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

setupPutAliasRequestDeserializer

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