Package org.opensearch.client.opensearch.security

Class PostDashboardsInfoResponse.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.security.PostDashboardsInfoResponse.Builder

All Implemented Interfaces:

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

Enclosing class:

PostDashboardsInfoResponse

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

Builder for PostDashboardsInfoResponse.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PostDashboardsInfoResponse	build()	Builds a PostDashboardsInfoResponse.
PostDashboardsInfoResponse.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final PostDashboardsInfoResponse.Builder	defaultTenant(String value)	The default tenant setting for the dashboard.
final PostDashboardsInfoResponse.Builder	multitenancyEnabled(Boolean value)	Indicates whether multi-tenancy is enabled.
final PostDashboardsInfoResponse.Builder	notFailOnForbiddenEnabled(Boolean value)	Indicates whether DNFOF is enabled.
final PostDashboardsInfoResponse.Builder	opensearchDashboardsIndex(String value)	The name of the dashboard's index.
final PostDashboardsInfoResponse.Builder	opensearchDashboardsMtEnabled(Boolean value)	Indicates whether multi-tenancy is enabled.
final PostDashboardsInfoResponse.Builder	opensearchDashboardsServerUser(String value)	The name of the user used to connect dashboard's to the server.
final PostDashboardsInfoResponse.Builder	passwordValidationErrorMessage(String value)	The error message when a password validation fails.
final PostDashboardsInfoResponse.Builder	passwordValidationRegex(String value)	The regular expression used perform password validation.
final PostDashboardsInfoResponse.Builder	privateTenantEnabled(Boolean value)	Indicates whether a private tenant is enabled for all users.
final PostDashboardsInfoResponse.Builder	signInOptions(String value, String... values)	A list of available sign-in options.
final PostDashboardsInfoResponse.Builder	signInOptions(List<String> list)	A list of available sign-in options.
final PostDashboardsInfoResponse.Builder	userName(String value)	User's name

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

Returns:

a new builder instance.

defaultTenant

@Nonnull
public final PostDashboardsInfoResponse.Builder defaultTenant(@Nullable
 String value)

The default tenant setting for the dashboard.

API name: default_tenant

multitenancyEnabled

@Nonnull
public final PostDashboardsInfoResponse.Builder multitenancyEnabled(@Nullable
 Boolean value)

Indicates whether multi-tenancy is enabled.

API name: multitenancy_enabled

notFailOnForbiddenEnabled

@Nonnull
public final PostDashboardsInfoResponse.Builder notFailOnForbiddenEnabled(@Nullable
 Boolean value)

Indicates whether DNFOF is enabled.

API name: not_fail_on_forbidden_enabled

opensearchDashboardsIndex

@Nonnull
public final PostDashboardsInfoResponse.Builder opensearchDashboardsIndex(@Nullable
 String value)

The name of the dashboard's index.

API name: opensearch_dashboards_index

opensearchDashboardsMtEnabled

@Nonnull
public final PostDashboardsInfoResponse.Builder opensearchDashboardsMtEnabled(@Nullable
 Boolean value)

Indicates whether multi-tenancy is enabled.

API name: opensearch_dashboards_mt_enabled

opensearchDashboardsServerUser

@Nonnull
public final PostDashboardsInfoResponse.Builder opensearchDashboardsServerUser(@Nullable
 String value)

The name of the user used to connect dashboard's to the server.

API name: opensearch_dashboards_server_user

passwordValidationErrorMessage

@Nonnull
public final PostDashboardsInfoResponse.Builder passwordValidationErrorMessage(@Nullable
 String value)

The error message when a password validation fails.

API name: password_validation_error_message

passwordValidationRegex

@Nonnull
public final PostDashboardsInfoResponse.Builder passwordValidationRegex(@Nullable
 String value)

The regular expression used perform password validation.

API name: password_validation_regex

privateTenantEnabled

@Nonnull
public final PostDashboardsInfoResponse.Builder privateTenantEnabled(@Nullable
 Boolean value)

Indicates whether a private tenant is enabled for all users.

API name: private_tenant_enabled

signInOptions

@Nonnull
public final PostDashboardsInfoResponse.Builder signInOptions(List<String> list)

A list of available sign-in options.

API name: sign_in_options

Adds all elements of list to signInOptions.

signInOptions

@Nonnull
public final PostDashboardsInfoResponse.Builder signInOptions(String value,
 String... values)

A list of available sign-in options.

API name: sign_in_options

Adds one or more values to signInOptions.

userName

@Nonnull
public final PostDashboardsInfoResponse.Builder userName(@Nullable
 String value)

User's name

API name: user_name

build

@Nonnull
public PostDashboardsInfoResponse build()

Builds a PostDashboardsInfoResponse.

Specified by:

build in interface ObjectBuilder<PostDashboardsInfoResponse>

Throws:

NullPointerException - if some of the required fields are null.