Package org.opensearch.client.opensearch.ml

Class GetProfileRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.ml.GetProfileRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

GetProfileRequest

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

Builder for GetProfileRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

Returns:

a new builder instance.

self

@Nonnull
protected GetProfileRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<GetProfileRequest.Builder>

modelIds

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

API name: model_ids

Adds all elements of list to modelIds.

modelIds

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

API name: model_ids

Adds one or more values to modelIds.

nodeIds

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

API name: node_ids

Adds all elements of list to nodeIds.

nodeIds

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

API name: node_ids

Adds one or more values to nodeIds.

returnAllModels

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

Whether to return all models.

API name: return_all_models

returnAllTasks

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

Whether to return all tasks.

API name: return_all_tasks

taskIds

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

API name: task_ids

Adds all elements of list to taskIds.

taskIds

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

API name: task_ids

Adds one or more values to taskIds.

build

@Nonnull
public GetProfileRequest build()

Builds a GetProfileRequest.

Specified by:

build in interface ObjectBuilder<GetProfileRequest>

Throws:

NullPointerException - if some of the required fields are null.