Package org.opensearch.client.opensearch.ml

Class UpdateConnectorRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.ml.UpdateConnectorRequest

All Implemented Interfaces:

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

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

Updates a standalone connector.

Nested Class Summary

Nested Classes

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

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<UpdateConnectorRequest>	_DESERIALIZER	Json deserializer for UpdateConnectorRequest
static final Endpoint<UpdateConnectorRequest,UpdateConnectorResponse,ErrorResponse>	_ENDPOINT	Endpoint "ml.update_connector".

Method Summary

Modifier and Type	Method	Description
final String	accessMode()	The model group access mode.
final List<Action>	actions()	API name: actions
final List<String>	backendRoles()	The backend roles.
static UpdateConnectorRequest.Builder	builder()
final String	connectorId()	Required - API name: connector_id
final Credential	credential()	API name: credential
final String	description()	The connector description.
boolean	equals(Object o)
int	hashCode()
final String	name()	API name: name
static UpdateConnectorRequest	of(Function<UpdateConnectorRequest.Builder,ObjectBuilder<UpdateConnectorRequest>> fn)
final Map<String,JsonData>	parameters()	API name: parameters
final Boolean	parametersSkipValidatingMissingParameters()	Whether to skip validating missing parameters.
final String	protocol()	The connector 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	setupUpdateConnectorRequestDeserializer(ObjectDeserializer<UpdateConnectorRequest.Builder> op)
UpdateConnectorRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final Long	version()	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<UpdateConnectorRequest> _DESERIALIZER

Json deserializer for UpdateConnectorRequest

_ENDPOINT

public static final Endpoint<UpdateConnectorRequest,UpdateConnectorResponse,ErrorResponse> _ENDPOINT

Endpoint "ml.update_connector".

Method Details

of

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

accessMode

@Nullable
public final String accessMode()

The model group access mode.

API name: access_mode

actions

@Nonnull
public final List<Action> actions()

API name: actions

backendRoles

@Nonnull
public final List<String> backendRoles()

The backend roles.

API name: backend_roles

connectorId

@Nonnull
public final String connectorId()

Required - API name: connector_id

credential

@Nullable
public final Credential credential()

API name: credential

description

@Nullable
public final String description()

The connector description.

API name: description

name

@Nullable
public final String name()

API name: name

parameters

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

API name: parameters

parametersSkipValidatingMissingParameters

@Nullable
public final Boolean parametersSkipValidatingMissingParameters()

Whether to skip validating missing parameters.

API name: parameters.skip_validating_missing_parameters

protocol

@Nullable
public final String protocol()

The connector protocol.

API name: protocol

version

@Nullable
public final Long version()

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

Returns:

a new builder instance.

builder

@Nonnull
public static UpdateConnectorRequest.Builder builder()

setupUpdateConnectorRequestDeserializer

protected static void setupUpdateConnectorRequestDeserializer(ObjectDeserializer<UpdateConnectorRequest.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object