メインコンテンツまでスキップ

describeUser()

これはメソッドテンプレートです。

javascript
await milvusClient.describeUser(data)

Request Syntax​

javascript
await milvusClient.describeUser({
    includeRoleInfo?: boolean,
    timeout?: number,
    username: string
})

PARAMETERS:

  • username (string) -

    [REQUIRED]

    説明対象のユーザー名です。

  • includeRoleInfo (boolean) -

    ロール情報を含めるかどうかを示すブール値です。

  • timeout (number)

    この操作のタイムアウト時間です。

    これを None に設定すると、応答が到着した時点、またはエラーが発生した時点でこの操作はタイムアウトします。

RETURNS Promise<SelectUserResponse>

このメソッドは、SelectUserResponse オブジェクトに解決される promise を返します。

typescript
{
    results: UserResult[],
    status:  ResStatus
}

PARAMETERS:

  • results (UserResult[]) -
    UserResult オブジェクトのリストです。describeUser() の場合、このリストには要求されたユーザーを説明する単一のエントリが含まれます。

    • user (User) -

      ユーザーを識別する User オブジェクトです。

      • name (string) -

      ユーザー名です。

      • name (string) -

        ユーザー名です。

    • roles (RoleEntity[]) -

      このユーザーに割り当てられているロールのリストです。

      • name (string) -

      ロール名です。

      • name (string) -

        ロール名です。

  • ResStatus
    ResStatus オブジェクトです。

    • code (number) -

      操作結果を示すコードです。この操作が成功した場合は 0 のままです。

    • error_code (string | number) -

      発生したエラーを示すエラーコードです。この操作が成功した場合は Success のままです。

    • reason (string) -

      報告されたエラーの理由を示す理由です。この操作が成功した場合は空文字列のままです。

Example​

java
milvusClient.describeUser({username: 'name'})
Ctrl I