Class GetUserRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<GetUserRequest.Builder>
co.elastic.clients.elasticsearch.security.GetUserRequest.Builder
- All Implemented Interfaces:
WithJson<GetUserRequest.Builder>
,ObjectBuilder<GetUserRequest>
- Enclosing class:
- GetUserRequest
public static class GetUserRequest.Builder extends RequestBase.AbstractBuilder<GetUserRequest.Builder> implements ObjectBuilder<GetUserRequest>
Builder for
GetUserRequest
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description GetUserRequest
build()
Builds aGetUserRequest
.protected GetUserRequest.Builder
self()
GetUserRequest.Builder
username(java.lang.String value, java.lang.String... values)
An identifier for the user.GetUserRequest.Builder
username(java.util.List<java.lang.String> list)
An identifier for the user.GetUserRequest.Builder
withProfileUid(java.lang.Boolean value)
If true will return the User Profile ID for a user, if any.Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
username
An identifier for the user. You can specify multiple usernames as a comma-separated list. If you omit this parameter, the API retrieves information about all users.API name:
username
Adds all elements of
list
tousername
. -
username
An identifier for the user. You can specify multiple usernames as a comma-separated list. If you omit this parameter, the API retrieves information about all users.API name:
username
Adds one or more values to
username
. -
withProfileUid
If true will return the User Profile ID for a user, if any.API name:
with_profile_uid
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<GetUserRequest.Builder>
-
build
Builds aGetUserRequest
.- Specified by:
build
in interfaceObjectBuilder<GetUserRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-