Method: projects.locations.dataAgents.listAccessible

指定されたプロジェクトとロケーションで呼び出し元がアクセスできる DataAgent を一覧表示します。

HTTP リクエスト

GET https://geminidataanalytics.googleapis.com/v1beta/{parent=projects/*/locations/*}/dataAgents:listAccessible

この URL では gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

必須。ListAccessibleDataAgentsRequest の親の値。

クエリ パラメータ

パラメータ
pageSize

integer

省略可。サーバーはリクエストされた数よりも少ない項目を返す場合があります。指定しない場合は、サーバーで適切なデフォルトが選択されます。

pageToken

string

省略可。前回の dataAgents.listAccessible 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、dataAgents.listAccessible に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。サービスから返される数は、この値より少ない場合があります。

filter

string

省略可。結果のフィルタリング。構文については、AIP-160 をご覧ください。

orderBy

string

省略可。ユーザー指定の結果の並べ替え方法。

showDeleted

boolean

省略可。true を指定すると、返されるリストに削除済み(復元可能)DataAgent が含まれます。デフォルトは false です。

creatorFilter

enum (CreatorFilter)

省略可。エージェントの作成者をフィルタします。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

アクセス可能な DataAgent の一覧表示に対するレスポンスのメッセージ。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現
{
  "dataAgents": [
    {
      object (DataAgent)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
フィールド
dataAgents[]

object (DataAgent)

アクセス可能な DataAgent のリスト。

nextPageToken

string

次ページトークン。次ページがない場合は空。

unreachable[]

string

順序なしリスト。到達できなかったロケーション。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。

CreatorFilter

エージェントの作成者をフィルタします。

列挙型
CREATOR_FILTER_UNSPECIFIED デフォルト値。
NONE 作成者固有のフィルタは適用されません。すべてのエージェントが返されます。
CREATOR_ONLY API を呼び出すユーザーが作成したエージェントのみが返されます。
NOT_CREATOR_ONLY API を呼び出すユーザーが作成していないエージェントのみが返されます。