Skip to main content

describeRole()

Addedv2.3.xModifiedv3.0.x

This operation returns the privileges granted to a role and the role description.

public DescribeRoleResp describeRole(DescribeRoleReq request)

Request Syntax​

DescribeRoleResp resp = client.describeRole(DescribeRoleReq.builder()
    .roleName(String roleName)
    .build()
);

BUILDER METHODS:

  • roleName(String roleName)

    [REQUIRED]

    The name of the role to describe.

RETURNS:

DescribeRoleResp

The response contains roleName, grantInfos, and description.

EXCEPTIONS:

  • MilvusClientException

    This exception will be raised when any error occurs during this operation.

Example​

import io.milvus.v2.service.rbac.request.DescribeRoleReq;
import io.milvus.v2.service.rbac.response.DescribeRoleResp;

DescribeRoleResp resp = client.describeRole(DescribeRoleReq.builder()
    .roleName("analytics_reader")
    .build());
System.out.println(resp.getDescription());