describeResourceGroup()
MilvusClient interface. This method drops a resource group by name.
R<DescribeResourceGroupResponse> describeResourceGroup(DescribeResourceGroupParam requestParam);
DescribeResourceGroupParam
Use the DescribeResourceGroupParam.Builder to construct a DescribeResourceGroupParam object.
import io.milvus.param.DescribeResourceGroupParam;
DescribeResourceGroupParam.Builder builder = DescribeResourceGroupParam.newBuilder();
Methods of DescribeResourceGroupParam.Builder:
Method |
Description |
Parameters |
|---|---|---|
withGroupName(String groupName) |
Sets the group name. groupName cannot be empty or null. |
groupName: The name of the group to describe. |
build() |
Construct a DescribeResourceGroupParam object. |
N/A |
The DescribeResourceGroupParam.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<DescribeResourceGroupResponse> 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.Unknownand error message of the exception.If the API succeeds, it returns a valid
DescribeResourceGroupResponseheld by theRtemplate. You can useDescribeResourceGroupResponseto get resource group information.
Example
import io.milvus.param.DescribeResourceGroupParam;
R<DescribeResourceGroupResponse> response = client.describeResourceGroup(DescribeResourceGroupParam.newBuilder()
.withGroupName(name)
.build());
if (response.getStatus() != R.Status.Success.getCode()) {
throw new RuntimeException(response.getMessage());
}