addUserToRole()

MilvusClient interface. This method adds a user to a role. The user will get permissions that the role is allowed to perform operations.

R<RpcStatus> addUserToRole(AddUserToRoleParam requestParam);

AddUserToRoleParam

Use the AddUserToRoleParam.Builder to construct an AddUserToRoleParam object.

import io.milvus.param.AddUserToRoleParam;
AddUserToRoleParam.Builder builder = AddUserToRoleParam.newBuilder();

Methods of AddUserToRoleParam.Builder:

Method	Description	Parameters
withRoleName(String roleName)	Sets the roleName. RoleName cannot be empty or null.	roleName: The role name used to create the privilege.
withUsername(String username)	Sets the username. Username cannot be empty or null.	username: The user name.
build()	Construct a AddUserToRoleParam object.	N/A

The AddUserToRoleParam.Builder.build() can throw the following exceptions:

• ParamException: error if the parameter is invalid.

Returns

This method catches all the exceptions and returns an R<RpcStatus> object.

• If the API fails on the server side, it returns the error code and message from the server.

• If the API fails by RPC exception, it returns R.Status.Unknown and error message of the exception.

• If the API succeeds, it returns R.Status.Success.

Example

import io.milvus.param.AddUserToRoleParam;

R<RpcStatus> response = client.addUserToRole(AddUserToRoleParam.newBuilder()
            .withRoleName(roleName)
            .withUserName(userName)
            .build());

if (response.getStatus() != R.Status.Success.getCode()) {
    throw new RuntimeException(response.getMessage());
}