Package org.opensearch.client.opensearch.ml

Class Credential.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.ml.Credential.Builder

All Implemented Interfaces:

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

Enclosing class:

Credential

public static class Credential.Builder
extends ObjectBuilderBase
implements CopyableBuilder<Credential.Builder,Credential>

Builder for Credential.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
Credential.Builder	accessKey(java.lang.String value)	API name: access_key
Credential	build()	Builds a Credential.
Credential.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
Credential.Builder	metadata(java.lang.String key, JsonData value)	Adds an entry to metadata.
Credential.Builder	metadata(java.util.Map<java.lang.String,JsonData> map)	Adds all elements of map to metadata.
Credential.Builder	secretKey(java.lang.String value)	API name: secret_key
Credential.Builder	sessionToken(java.lang.String value)	API name: session_token

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

_checkSingleUse, _listAdd, _listAdd, _listAddAll, _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 Detail

Builder

public Builder()

Method Detail

copy

@Nonnull
public Credential.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<Credential.Builder,Credential>

Returns:

a new builder instance.

accessKey

@Nonnull
public final Credential.Builder accessKey(@Nullable
                                          java.lang.String value)

API name: access_key

metadata

@Nonnull
public final Credential.Builder metadata(java.util.Map<java.lang.String,JsonData> map)

Adds all elements of map to metadata.

metadata

@Nonnull
public final Credential.Builder metadata(java.lang.String key,
                                         JsonData value)

Adds an entry to metadata.

secretKey

@Nonnull
public final Credential.Builder secretKey(@Nullable
                                          java.lang.String value)

API name: secret_key

sessionToken

@Nonnull
public final Credential.Builder sessionToken(@Nullable
                                             java.lang.String value)

API name: session_token

build

@Nonnull
public Credential build()

Builds a Credential.

Specified by:

build in interface ObjectBuilder<Credential>

Throws:

java.lang.NullPointerException - if some of the required fields are null.