Package org.opensearch.client.opensearch.ml

Class CreateConnectorRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.ml.CreateConnectorRequest

All Implemented Interfaces:

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

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

Creates a standalone connector.

Nested Class Summary

Nested Classes

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

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<CreateConnectorRequest>	_DESERIALIZER	Json deserializer for CreateConnectorRequest
static final Endpoint<CreateConnectorRequest,CreateConnectorResponse,ErrorResponse>	_ENDPOINT	Endpoint "ml.create_connector".

Method Summary

Modifier and Type	Method	Description
final List<Action>	actions()	Required - API name: actions
static CreateConnectorRequest.Builder	builder()
final ClientConfig	clientConfig()	API name: client_config
final Credential	credential()	Required - API name: credential
final String	description()	Required - API name: description
boolean	equals(Object o)
int	hashCode()
final String	name()	Required - API name: name
static CreateConnectorRequest	of(Function<CreateConnectorRequest.Builder,ObjectBuilder<CreateConnectorRequest>> fn)
final Map<String,JsonData>	parameters()	Required - API name: parameters
final String	protocol()	Required - API name: protocol
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	setupCreateConnectorRequestDeserializer(ObjectDeserializer<CreateConnectorRequest.Builder> op)
CreateConnectorRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final int	version()	Required - API name: version

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

Json deserializer for CreateConnectorRequest

_ENDPOINT

public static final Endpoint<CreateConnectorRequest,CreateConnectorResponse,ErrorResponse> _ENDPOINT

Endpoint "ml.create_connector".

Method Details

of

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

actions

@Nonnull
public final List<Action> actions()

Required - API name: actions

clientConfig

@Nullable
public final ClientConfig clientConfig()

API name: client_config

credential

@Nonnull
public final Credential credential()

Required - API name: credential

description

@Nonnull
public final String description()

Required - API name: description

name

@Nonnull
public final String name()

Required - API name: name

parameters

@Nonnull
public final Map<String,JsonData> parameters()

Required - API name: parameters

protocol

@Nonnull
public final String protocol()

Required - API name: protocol

version

public final int version()

Required - API name: version

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

Returns:

a new builder instance.

builder

@Nonnull
public static CreateConnectorRequest.Builder builder()

setupCreateConnectorRequestDeserializer

protected static void setupCreateConnectorRequestDeserializer(ObjectDeserializer<CreateConnectorRequest.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object