Package org.opensearch.client.opensearch.ml

Class GetProfileModelsRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<GetProfileModelsRequest.Builder>

org.opensearch.client.opensearch.ml.GetProfileModelsRequest.Builder

All Implemented Interfaces:

CopyableBuilder<GetProfileModelsRequest.Builder,GetProfileModelsRequest>, MutableBuilder<GetProfileModelsRequest.Builder,GetProfileModelsRequest>, ObjectBuilder<GetProfileModelsRequest>

Enclosing class:

GetProfileModelsRequest

public static class GetProfileModelsRequest.Builder
extends RequestBase.AbstractBuilder<GetProfileModelsRequest.Builder>
implements CopyableBuilder<GetProfileModelsRequest.Builder,GetProfileModelsRequest>

Builder for GetProfileModelsRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetProfileModelsRequest	build()	Builds a GetProfileModelsRequest.
GetProfileModelsRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final GetProfileModelsRequest.Builder	modelId(String value)	API name: model_id
final GetProfileModelsRequest.Builder	modelIds(String value, String... values)	API name: model_ids
final GetProfileModelsRequest.Builder	modelIds(List<String> list)	API name: model_ids
final GetProfileModelsRequest.Builder	nodeIds(String value, String... values)	API name: node_ids
final GetProfileModelsRequest.Builder	nodeIds(List<String> list)	API name: node_ids
final GetProfileModelsRequest.Builder	returnAllModels(Boolean value)	Whether to return all models.
final GetProfileModelsRequest.Builder	returnAllTasks(Boolean value)	Whether to return all tasks.
protected GetProfileModelsRequest.Builder	self()
final GetProfileModelsRequest.Builder	taskIds(String value, String... values)	API name: task_ids
final GetProfileModelsRequest.Builder	taskIds(List<String> list)	API name: task_ids

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

errorTrace, human

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public GetProfileModelsRequest.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<GetProfileModelsRequest.Builder,GetProfileModelsRequest>

Returns:

a new builder instance.

self

@Nonnull
protected GetProfileModelsRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<GetProfileModelsRequest.Builder>

modelId

@Nonnull
public final GetProfileModelsRequest.Builder modelId(@Nullable
 String value)

API name: model_id

modelIds

@Nonnull
public final GetProfileModelsRequest.Builder modelIds(List<String> list)

API name: model_ids

Adds all elements of list to modelIds.

modelIds

@Nonnull
public final GetProfileModelsRequest.Builder modelIds(String value,
 String... values)

API name: model_ids

Adds one or more values to modelIds.

nodeIds

@Nonnull
public final GetProfileModelsRequest.Builder nodeIds(List<String> list)

API name: node_ids

Adds all elements of list to nodeIds.

nodeIds

@Nonnull
public final GetProfileModelsRequest.Builder nodeIds(String value,
 String... values)

API name: node_ids

Adds one or more values to nodeIds.

returnAllModels

@Nonnull
public final GetProfileModelsRequest.Builder returnAllModels(@Nullable
 Boolean value)

Whether to return all models.

API name: return_all_models

returnAllTasks

@Nonnull
public final GetProfileModelsRequest.Builder returnAllTasks(@Nullable
 Boolean value)

Whether to return all tasks.

API name: return_all_tasks

taskIds

@Nonnull
public final GetProfileModelsRequest.Builder taskIds(List<String> list)

API name: task_ids

Adds all elements of list to taskIds.

taskIds

@Nonnull
public final GetProfileModelsRequest.Builder taskIds(String value,
 String... values)

API name: task_ids

Adds one or more values to taskIds.

build

@Nonnull
public GetProfileModelsRequest build()

Builds a GetProfileModelsRequest.

Specified by:

build in interface ObjectBuilder<GetProfileModelsRequest>

Throws:

NullPointerException - if some of the required fields are null.