Package org.opensearch.client.opensearch.ml

Class GetProfileRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.ml.GetProfileRequest

All Implemented Interfaces:

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

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

Get a profile.

Nested Class Summary

Nested Classes

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

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 JsonpDeserializer<GetProfileRequest>	_DESERIALIZER	Json deserializer for GetProfileRequest
static Endpoint<GetProfileRequest,GetProfileResponse,ErrorResponse>	_ENDPOINT	Endpoint "ml.get_profile".

Method Summary

Modifier and Type	Method	Description
static GetProfileRequest.Builder	builder()
boolean	equals(java.lang.Object o)
int	hashCode()
java.util.List<java.lang.String>	modelIds()	API name: model_ids
java.util.List<java.lang.String>	nodeIds()	API name: node_ids
static GetProfileRequest	of(java.util.function.Function<GetProfileRequest.Builder,ObjectBuilder<GetProfileRequest>> fn)
java.lang.Boolean	returnAllModels()	Whether to return all models.
java.lang.Boolean	returnAllTasks()	Whether to return all tasks.
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	setupGetProfileRequestDeserializer(ObjectDeserializer<GetProfileRequest.Builder> op)
java.util.List<java.lang.String>	taskIds()	API name: task_ids
GetProfileRequest.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 Detail

_DESERIALIZER

public static final JsonpDeserializer<GetProfileRequest> _DESERIALIZER

Json deserializer for GetProfileRequest

_ENDPOINT

public static final Endpoint<GetProfileRequest,GetProfileResponse,ErrorResponse> _ENDPOINT

Endpoint "ml.get_profile".

Method Detail

of

public static GetProfileRequest of(java.util.function.Function<GetProfileRequest.Builder,ObjectBuilder<GetProfileRequest>> fn)

modelIds

@Nonnull
public final java.util.List<java.lang.String> modelIds()

API name: model_ids

nodeIds

@Nonnull
public final java.util.List<java.lang.String> nodeIds()

API name: node_ids

returnAllModels

@Nullable
public final java.lang.Boolean returnAllModels()

Whether to return all models.

API name: return_all_models

returnAllTasks

@Nullable
public final java.lang.Boolean returnAllTasks()

Whether to return all tasks.

API name: return_all_tasks

taskIds

@Nonnull
public final java.util.List<java.lang.String> taskIds()

API name: task_ids

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

Returns:

a new builder instance.

builder

@Nonnull
public static GetProfileRequest.Builder builder()

setupGetProfileRequestDeserializer

protected static void setupGetProfileRequestDeserializer(ObjectDeserializer<GetProfileRequest.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object