@zilliz/milvus2-sdk-node 2.2.3 → 2.2.5

package/dist/milvus/User.d.ts

@@ -1,28 +1,26 @@
-import { Client } from './Client';
-import { ListCredUsersResponse, ResStatus, SelectRoleResponse, SelectUserResponse, SelectGrantResponse, HasRoleResponse } from './types/Response';
-import { CreateUserReq, DeleteUserReq, ListUsersReq, UpdateUserReq, CreateRoleReq, DropRoleReq, AddUserToRoleReq, RemoveUserFromRoleReq, SelectRoleReq, SelectUserReq, OperateRolePrivilegeReq, SelectGrantReq, ListGrantsReq, HasRoleReq } from './types/User';
-import { GrpcTimeOut } from './types/Common';
-export declare class User extends Client {
+import { Resource } from './Resource';
+import { CreateUserReq, DeleteUserReq, ListUsersReq, UpdateUserReq, CreateRoleReq, DropRoleReq, AddUserToRoleReq, RemoveUserFromRoleReq, SelectRoleReq, SelectUserReq, OperateRolePrivilegeReq, SelectGrantReq, ListGrantsReq, HasRoleReq, GrpcTimeOut, ListCredUsersResponse, ResStatus, SelectRoleResponse, SelectUserResponse, SelectGrantResponse, HasRoleResponse } from '.';
+export declare class User extends Resource {
     /**
      * Create user in milvus
      *
      * @param data
-     *  | Property | Type   | Description |
-     *  | :-------------- | :----  | :---- |
+     *  | Property | Type  | Description |
+     *  | :-- | :-- | :-- |
      *  | username | String | username |
      *  | password | String | user password |
+     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined |
      *
-     *
-     * @return
+     * @returns
      *  | Property | Description |
-     *  | :-------------| :--------  |
+     *  | :-- | :-- |
      *  | error_code | Error code number |
      *  | reason | Error cause|
      *
      * #### Example
      *
      * ```
-     *  milvusClient.userManager.createUser({
+     *  milvusClient.createUser({
      *    username: NAME,
      *    password: PASSWORD,
      *  });
@@ -34,23 +32,24 @@ export declare class User extends Client {
      *
      * @param data
      *  | Property | Type | Description |
-     *  | :-------------- | :----  | :------ |
+     *  | :-- | :-- | :-- |
      *  | username | String | username |
      *  | password | String | user password |
+     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined |
      *
-     *
-     * @return
+     * @returns
      *  | Property | Description |
-     *  | :-------------| :--------  |
+     *  | :-- | :-- |
      *  | error_code | Error code number |
      *  | reason | Error cause|
      *
      * #### Example
      *
      * ```
-     *  milvusClient.userManager.createUser({
+     *  milvusClient.updateUser({
      *    username: NAME,
-     *    password: PASSWORD,
+     *    newPassword: PASSWORD,
+     *    oldPassword: PASSWORD,
      *  });
      * ```
      */
@@ -60,20 +59,20 @@ export declare class User extends Client {
      *
      * @param data
      *  | Property | Type | Description |
-     *  | :-------------- | :----  | :-- |
+     *  | :-- | :-- | :-- |
      *  | username | String | username |
+     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined |
      *
-     *
-     * @return
+     * @returns
      *  | Property | Description |
-     *  | :-------------| :--------  |
+     *  | :-- | :-- |
      *  | error_code | Error code number |
      *  | reason | Error cause|
      *
      * #### Example
      *
      * ```
-     *  milvusClient.userManager.deleteUser({
+     *  milvusClient.deleteUser({
      *    username: NAME,
      *  });
      * ```
@@ -82,80 +81,111 @@ export declare class User extends Client {
     /**
      * List user in milvus
      *
-     * @return
+     * @param data
+     *  | Property | Type | Description |
+     *  | :-- | :-- | :-- |
+     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined |
+     *
+     * @returns
      *  | Property | Description |
-     *  | :-------------| :--------  |
-     *  | status | { error_code: number, reason: string }|
+     *  | :-- | :-- |
+     *  | status | { error_code: number, reason: string } |
      *  | usernames | string[] |
      *
      * #### Example
      *
      * ```
-     *  milvusClient.userManager.listUsers();
+     *  milvusClient.listUsers();
      * ```
      */
     listUsers(data?: ListUsersReq): Promise<ListCredUsersResponse>;
     /**
      * Create user role
      *
-     * @return
+     * @param data
+     *  | Property | Type | Description |
+     *  | :-- | :-- | :-- |
+     *  | roleName | String | role name |
+     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined |
+     *
+     * @returns
      *  | Property | Description |
-     *  | :-------------| :--------  |
-     *  | status | { error_code: number, reason: string }|
+     *  | :-- | :-- |
+     *  | status | { error_code: number, reason: string } |
      *  | reason | '' |
      *
      * #### Example
      *
      * ```
-     *  milvusClient.userManager.createRole({roleName: 'myrole'});
+     *  milvusClient.createRole({roleName: 'myrole'});
      * ```
      */
     createRole(data: CreateRoleReq): Promise<ResStatus>;
     /**
      * Drop user role
      *
-     * @return
+     * @param data
+     *  | Property | Type | Description |
+     *  | :-- | :-- | :-- |
+     *  | roleName | String | User name |
+     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined |
+     *
+     * @returns
      *  | Property | Description |
-     *  | :-------------| :--------  |
-     *  | status | { error_code: number, reason: string }|
+     *  | :-- | :-- |
+     *  | status | { error_code: number, reason: string } |
      *  | reason | '' |
      *
      * #### Example
      *
      * ```
-     *  milvusClient.userManager.dropRole({roleName: 'myrole'});
+     *  milvusClient.dropRole({roleName: 'myrole'});
      * ```
      */
     dropRole(data: DropRoleReq): Promise<ResStatus>;
     /**
      * add user to role
      *
-     * @return
+     * @param data
+     *  | Property | Type | Description |
+     *  | :-- | :-- | :-- |
+     *  | username | String | User name |
+     *  | roleName | String | Role name |
+     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined |
+     *
+     * @returns
      *  | Property | Description |
-     *  | :-------------| :--------  |
-     *  | status | { error_code: number, reason: string }|
+     *  | :-- | :-- |
+     *  | status | { error_code: number, reason: string } |
      *  | reason | '' |
      *
      * #### Example
      *
      * ```
-     *  milvusClient.userManager.addUserToRole({username: 'my', roleName: 'myrole'});
+     *  milvusClient.addUserToRole({username: 'my', roleName: 'myrole'});
      * ```
      */
     addUserToRole(data: AddUserToRoleReq): Promise<ResStatus>;
     /**
      * remove user from role
      *
-     * @return
+     * @param data
+     *  | Property | Type | Description |
+     *  | :-- | :-- | :-- |
+     *  | username | String | User name |
+     *  | roleName | String | Role name |
+     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined |
+     *
+     * @returns
      *  | Property | Description |
-     *  | :-------------| :-------- |
-     *  | status | { error_code: number, reason: string }|
+     *  | :-- | :-- |
+     *  | status | { error_code: number, reason: string } |
      *  | reason | '' |
      *
      * #### Example
      *
      * ```
-     *  milvusClient.userManager.removeUserFromRole({username: 'my', roleName: 'myrole'});
+     *  milvusClient.removeUserFromRole({username: 'my', roleName: 'myrole'});
      * ```
      */
     removeUserFromRole(data: RemoveUserFromRoleReq): Promise<ResStatus>;
@@ -164,21 +194,21 @@ export declare class User extends Client {
      *
      * @param data
      *  | Property | Type | Description |
-     *  | :------- | :----- | :------------ |
-     *  | roleName | String | role name |
+     *  | :-- | :-- | :-- |
+     *  | roleName | String | Role name |
      *  | includeUserInfo? | boolean | should result including user info, by default: true |
-     *  | timeout | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined       |
+     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined       |
   
-     * @return
+     * @returns
      *  | Property | Description |
-     *  | :-------------| :-------- |
-     *  | status | { error_code: number, reason: string }|
+     *  | :-- | :-- |
+     *  | status | { error_code: number, reason: string } |
      *  | results | { users: {name: string}[]; role: {name: string} }[] |
      *
      * #### Example
      *
      * ```
-     *  milvusClient.userManager.selectRole({roleName: 'myrole'});
+     *  milvusClient.selectRole({roleName: 'myrole'});
      * ```
      */
     selectRole(data: SelectRoleReq): Promise<SelectRoleResponse>;
@@ -187,19 +217,19 @@ export declare class User extends Client {
      *
      *  @param data
      *  | Property | Type | Description |
-     *  | :------- | :----- | :------------ |
-     *  | timeout | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined       |
+     *  | :-- | :-- | :-- |
+     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined       |
      *
-     * @return
+     * @returns
      *  | Property | Description |
-     *  | :-------------| :-------- |
-     *  | status | { error_code: number, reason: string }|
+     *  | :-- | :-- |
+     *  | status | { error_code: number, reason: string } |
      *  | reason | '' |
      *
      * #### Example
      *
      * ```
-     *  milvusClient.userManager.listRoles();
+     *  milvusClient.listRoles();
      * ```
      */
     listRoles(data?: GrpcTimeOut): Promise<SelectRoleResponse>;
@@ -208,21 +238,21 @@ export declare class User extends Client {
      *
      *  @param data
      *  | Property | Type | Description |
-     *  | :------- | :----- | :------------ |
-     *  | userName | String | user name |
+     *  | :-- | :-- | :-- |
+     *  | userName | String | User name |
      *  | includeUserInfo? | boolean | should result including user info, by default: true |
-     *  | timeout | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined       |
+     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined       |
      *
-     * @return
+     * @returns
      *  | Property | Description |
-     *  | :-------------| :--------  |
-     *  | status | { error_code: number, reason: string }|
+     *  | :-- | :-- |
+     *  | status | { error_code: number, reason: string } |
      *  | results | user: {name: string}; roles: {name: string}[] |
      *
      * #### Example
      *
      * ```
-     *  milvusClient.userManager.selectUser({username: 'name'});
+     *  milvusClient.selectUser({username: 'name'});
      * ```
      */
     selectUser(data: SelectUserReq): Promise<SelectUserResponse>;
@@ -231,23 +261,23 @@ export declare class User extends Client {
      *
      *  @param data
      *  | Property | Type | Description |
-     *  | :------- | :----- | :------------ |
-     *  | roleName | String | role name |
+     *  | :-- | :-- | :-- |
+     *  | roleName | String | Role name |
      *  | object | string | Type of the operational object to which the specified privilege belongs, such as Collection, Index, Partition, etc. This parameter is case-sensitive.|
      *  | objectName | string | Name of the object to which the role is granted the specified prvilege. |
      *  | privilegeName | string | Name of the privilege to be granted to the role. This parameter is case-sensitive. |
-     *  | timeout | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined       |
+     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined       |
      *
-     * @return
+     * @returns
      *  | Property | Description |
-     *  | :-------------| :--------  |
-     *  | status | { error_code: number, reason: string }|
+     *  | :-- | :-- |
+     *  | status | { error_code: number, reason: string } |
      *  | reason | '' |
      *
      * #### Example
      *
      * ```
-     *  milvusClient.userManager.grantRolePrivilege({
+     *  milvusClient.grantRolePrivilege({
      *    roleName: 'roleName',
      *    object: '*',
      *    objectName: 'Collection',
@@ -261,23 +291,23 @@ export declare class User extends Client {
      *
      *  @param data
      *  | Property | Type | Description |
-     *  | :------- | :----- | :------------ |
-     *  | roleName | String | role name |
+     *  | :-- | :-- | :-- |
+     *  | roleName | String | Role name |
      *  | object | string | Type of the operational object to which the specified privilege belongs, such as Collection, Index, Partition, etc. This parameter is case-sensitive.|
      *  | objectName | string | Name of the object to which the role is granted the specified prvilege. |
      *  | privilegeName | string | Name of the privilege to be granted to the role. This parameter is case-sensitive. |
-     *  | timeout | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined       |
+     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined       |
      *
-     * @return
+     * @returns
      *  | Property | Description |
      *  | :------------- | :-------- |
-     *  | status | { error_code: number, reason: string }|
+     *  | status | { error_code: number, reason: string } |
      *  | reason | '' |
      *
      * #### Example
      *
      * ```
-     *  milvusClient.userManager.grantRolePrivilege({
+     *  milvusClient.grantRolePrivilege({
      *    roleName: 'roleName',
      *    object: '*',
      *    objectName: 'Collection',
@@ -290,47 +320,43 @@ export declare class User extends Client {
      * revoke all roles priviledges
      *  @param data
      *  | Property | Type | Description |
-     *  | :------- | :----- | :------------ |
-     *  | roleName | String | role name |
-     *  | object | string | Type of the operational object to which the specified privilege belongs, such as Collection, Index, Partition, etc. This parameter is case-sensitive.|
-     *  | objectName | string | Name of the object to which the role is granted the specified prvilege. |
-     *  | privilegeName | string | Name of the privilege to be granted to the role. This parameter is case-sensitive. |
-     *  | timeout | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined       |
+     *  | :-- | :-- | :-- |
+     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined |
      *
-     * @return
+     * @returns
      *  | Property | Description |
-     *  | :-------------| :--------  |
-     *  | status | { error_code: number, reason: string }|
-     *  | reason | ''      |
+     *  | :-- | :-- |
+     *  | status | { error_code: number, reason: string } |
+     *  | reason | '' |
      *
      * #### Example
      *
      * ```
-     *  milvusClient.userManager.revokeAllRolesPrivileges({});
+     *  milvusClient.revokeAllRolesPrivileges();
      * ```
      */
-    revokeAllRolesPrivileges(data?: GrpcTimeOut): Promise<ResStatus[]>;
+    dropAllRoles(data?: GrpcTimeOut): Promise<ResStatus[]>;
     /**
      * select a grant
      *  @param data
      *  | Property | Type | Description |
-     *  | :------- | :----- | :------------ |
-     *  | roleName | String | role name |
+     *  | :-- | :-- | :-- |
+     *  | roleName | String | Role name |
      *  | object | string | Type of the operational object to which the specified privilege belongs, such as Collection, Index, Partition, etc. This parameter is case-sensitive.|
      *  | objectName | string | Name of the object to which the role is granted the specified prvilege. |
      *  | privilegeName | string | Name of the privilege to be granted to the role. This parameter is case-sensitive. |
-     *  | timeout | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined       |
+     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined       |
      *
-     * @return
-     *  | Property      | Description |
-     *  | :-------------| :--------  |
-     *  | status        |  { error_code: number, reason: string }|
-     *  | reason    |       ''     |
+     * @returns
+     *  | Property | Description |
+     *  | :-- | :-- |
+     *  | status | { error_code: number, reason: string } |
+     *  | reason | '' |
      *
      * #### Example
      *
      * ```
-     *  milvusClient.userManager.selectGrant({
+     *  milvusClient.selectGrant({
      *    roleName: 'roleName',
      *    object: '*',
      *    objectName: 'Collection',
@@ -343,20 +369,20 @@ export declare class User extends Client {
      * list all grants for a role
      *  @param data
      *  | Property | Type | Description |
-     *  | :------- | :----- | :------------ |
-     *  | roleName | String | role name |
-     *  | timeout | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined       |
+     *  | :-- | :-- | :-- |
+     *  | roleName | String | Role name |
+     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined       |
      *
-     * @return
+     * @returns
      *  | Property | Description |
-     *  | :-------------| :-------- |
-     *  | status | { error_code: number, reason: string }|
+     *  | :-- | :-- |
+     *  | status | { error_code: number, reason: string } |
      *  | reason | '' |
      *
      * #### Example
      *
      * ```
-     *  milvusClient.userManager.listGrants({
+     *  milvusClient.listGrants({
      *    roleName: 'roleName',
      * });
      * ```
@@ -366,20 +392,20 @@ export declare class User extends Client {
      * check if the role is existing
      *  @param data
      *  | Property | Type | Description |
-     *  | :------- | :----- | :------------ |
-     *  | roleName | String | role name |
-     *  | timeout | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined       |
+     *  | :-- | :-- | :-- |
+     *  | roleName | String | Role name |
+     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined       |
      *
-     * @return
+     * @returns
      *  | Property | Description |
-     *  | :-------------| :-------- |
-     *  | status | { error_code: number, reason: string }|
+     *  | :-- | :-- |
+     *  | status | { error_code: number, reason: string } |
      *  | reason | '' |
      *
      * #### Example
      *
      * ```
-     *  milvusClient.userManager.hasRole({
+     *  milvusClient.hasRole({
      *    roleName: 'roleName',
      * });
      * ```