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:

ObjectBuilder<Credential>

Enclosing class:

Credential

public static class Credential.Builder
extends ObjectBuilderBase
implements ObjectBuilder<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	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, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

accessKey

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

API name: access_key

secretKey

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

API name: secret_key

sessionToken

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

API name: session_token

metadata

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

Adds all elements of map to metadata.

metadata

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

Adds an entry to metadata.

build

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.