Package org.opensearch.client.opensearch.security

Class AuthinfoResponse.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.security.AuthinfoResponse.Builder

All Implemented Interfaces:

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

Enclosing class:

AuthinfoResponse

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

Builder for AuthinfoResponse.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final AuthinfoResponse.Builder	backendRoles(String value, String... values)	The backend roles associated with the user.
final AuthinfoResponse.Builder	backendRoles(List<String> list)	The backend roles associated with the user.
AuthinfoResponse	build()	Builds a AuthinfoResponse.
AuthinfoResponse.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final AuthinfoResponse.Builder	customAttributeNames(String value, String... values)	The name of the attributes associated with the user.
final AuthinfoResponse.Builder	customAttributeNames(List<String> list)	The name of the attributes associated with the user.
final AuthinfoResponse.Builder	peerCertificates(String value)	The number of peer certificates related to the user.
final AuthinfoResponse.Builder	principal(String value)	The user's principal.
final AuthinfoResponse.Builder	remoteAddress(String value)	The IP address of remote user.
final AuthinfoResponse.Builder	roles(String value, String... values)	The roles associated with the user.
final AuthinfoResponse.Builder	roles(List<String> list)	The roles associated with the user.
final AuthinfoResponse.Builder	sizeOfBackendroles(String value)	The size of the user's backend roles in bytes.
final AuthinfoResponse.Builder	sizeOfCustomAttributes(String value)	The size of the user's custom attributes in bytes.
final AuthinfoResponse.Builder	sizeOfUser(String value)	The size of user contained in memory.
final AuthinfoResponse.Builder	ssoLogoutUrl(String value)	The logout URL.
final AuthinfoResponse.Builder	tenants(String key, Boolean value)	The tenants the user has access to with read-write or read-only access indicators.
final AuthinfoResponse.Builder	tenants(Map<String,Boolean> map)	The tenants the user has access to with read-write or read-only access indicators.
final AuthinfoResponse.Builder	user(String value)	A user object as a string.
final AuthinfoResponse.Builder	userName(String value)	The username.
final AuthinfoResponse.Builder	userRequestedTenant(String value)	The name of the tenant the user would like to switch to.

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

Returns:

a new builder instance.

backendRoles

@Nonnull
public final AuthinfoResponse.Builder backendRoles(List<String> list)

The backend roles associated with the user.

API name: backend_roles

Adds all elements of list to backendRoles.

backendRoles

@Nonnull
public final AuthinfoResponse.Builder backendRoles(String value,
 String... values)

The backend roles associated with the user.

API name: backend_roles

Adds one or more values to backendRoles.

customAttributeNames

@Nonnull
public final AuthinfoResponse.Builder customAttributeNames(List<String> list)

The name of the attributes associated with the user.

API name: custom_attribute_names

Adds all elements of list to customAttributeNames.

customAttributeNames

@Nonnull
public final AuthinfoResponse.Builder customAttributeNames(String value,
 String... values)

The name of the attributes associated with the user.

API name: custom_attribute_names

Adds one or more values to customAttributeNames.

peerCertificates

@Nonnull
public final AuthinfoResponse.Builder peerCertificates(@Nullable
 String value)

The number of peer certificates related to the user.

API name: peer_certificates

principal

@Nonnull
public final AuthinfoResponse.Builder principal(@Nullable
 String value)

The user's principal.

API name: principal

remoteAddress

@Nonnull
public final AuthinfoResponse.Builder remoteAddress(@Nullable
 String value)

The IP address of remote user.

API name: remote_address

roles

@Nonnull
public final AuthinfoResponse.Builder roles(List<String> list)

The roles associated with the user.

API name: roles

Adds all elements of list to roles.

roles

@Nonnull
public final AuthinfoResponse.Builder roles(String value,
 String... values)

The roles associated with the user.

API name: roles

Adds one or more values to roles.

sizeOfBackendroles

@Nonnull
public final AuthinfoResponse.Builder sizeOfBackendroles(@Nullable
 String value)

The size of the user's backend roles in bytes.

API name: size_of_backendroles

sizeOfCustomAttributes

@Nonnull
public final AuthinfoResponse.Builder sizeOfCustomAttributes(@Nullable
 String value)

The size of the user's custom attributes in bytes.

API name: size_of_custom_attributes

sizeOfUser

@Nonnull
public final AuthinfoResponse.Builder sizeOfUser(@Nullable
 String value)

The size of user contained in memory.

API name: size_of_user

ssoLogoutUrl

@Nonnull
public final AuthinfoResponse.Builder ssoLogoutUrl(@Nullable
 String value)

The logout URL.

API name: sso_logout_url

tenants

@Nonnull
public final AuthinfoResponse.Builder tenants(Map<String,Boolean> map)

The tenants the user has access to with read-write or read-only access indicators.

API name: tenants

Adds all elements of map to tenants.

tenants

@Nonnull
public final AuthinfoResponse.Builder tenants(String key,
 Boolean value)

The tenants the user has access to with read-write or read-only access indicators.

API name: tenants

Adds an entry to tenants.

user

@Nonnull
public final AuthinfoResponse.Builder user(@Nullable
 String value)

A user object as a string.

API name: user

userName

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

The username.

API name: user_name

userRequestedTenant

@Nonnull
public final AuthinfoResponse.Builder userRequestedTenant(@Nullable
 String value)

The name of the tenant the user would like to switch to.

API name: user_requested_tenant

build

@Nonnull
public AuthinfoResponse build()

Builds a AuthinfoResponse.

Specified by:

build in interface ObjectBuilder<AuthinfoResponse>

Throws:

NullPointerException - if some of the required fields are null.