Package org.opensearch.client.opensearch.security

Class CreateAllowlistRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.security.CreateAllowlistRequest

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<CreateAllowlistRequest.Builder,CreateAllowlistRequest>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class CreateAllowlistRequest
extends RequestBase
implements PlainJsonSerializable, ToCopyableBuilder<CreateAllowlistRequest.Builder,CreateAllowlistRequest>

Creates or replaces APIs permitted for users on the allow list. Requires a super admin certificate or REST API permissions.

Nested Class Summary

Nested Classes

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

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 final JsonpDeserializer<CreateAllowlistRequest>	_DESERIALIZER	Json deserializer for CreateAllowlistRequest
static final Endpoint<CreateAllowlistRequest,CreateAllowlistResponse,ErrorResponse>	_ENDPOINT	Endpoint "security.create_allowlist".

Method Summary

Modifier and Type	Method	Description
static CreateAllowlistRequest.Builder	builder()
final Boolean	enabled()	API name: enabled
boolean	equals(Object o)
int	hashCode()
static CreateAllowlistRequest	of(Function<CreateAllowlistRequest.Builder,ObjectBuilder<CreateAllowlistRequest>> fn)
final Map<String,List<String>>	requests()	An object with APIs as key and array of HTTP methods as values.
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	setupCreateAllowlistRequestDeserializer(ObjectDeserializer<CreateAllowlistRequest.Builder> op)
CreateAllowlistRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase

applyQueryParameters, errorTrace, human

Methods inherited from class java.lang.Object

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

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<CreateAllowlistRequest> _DESERIALIZER

Json deserializer for CreateAllowlistRequest

_ENDPOINT

public static final Endpoint<CreateAllowlistRequest,CreateAllowlistResponse,ErrorResponse> _ENDPOINT

Endpoint "security.create_allowlist".

Method Details

of

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

enabled

@Nullable
public final Boolean enabled()

API name: enabled

requests

@Nonnull
public final Map<String,List<String>> requests()

An object with APIs as key and array of HTTP methods as values.

API name: requests

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 CreateAllowlistRequest.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<CreateAllowlistRequest.Builder,CreateAllowlistRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static CreateAllowlistRequest.Builder builder()

setupCreateAllowlistRequestDeserializer

protected static void setupCreateAllowlistRequestDeserializer(ObjectDeserializer<CreateAllowlistRequest.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object