パッケージ google.cloud.bigquery.connection.v1

インデックス

ConnectionService

外部データソースの接続と認証情報を管理します。

CreateConnection

rpc CreateConnection(CreateConnectionRequest) returns (Connection)

新しい接続を作成します。

承認スコープ

次の OAuth スコープのいずれかが必要です。

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

詳細については、認証の概要をご覧ください。

DeleteConnection

rpc DeleteConnection(DeleteConnectionRequest) returns (Empty)

接続とその接続に関連付けられた認証情報を削除します。

承認スコープ

次の OAuth スコープのいずれかが必要です。

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

詳細については、認証の概要をご覧ください。

GetConnection

rpc GetConnection(GetConnectionRequest) returns (Connection)

指定した接続を返します。

承認スコープ

次の OAuth スコープのいずれかが必要です。

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

詳細については、認証の概要をご覧ください。

GetIamPolicy

rpc GetIamPolicy(GetIamPolicyRequest) returns (Policy)

リソースのアクセス制御ポリシーを取得します。リソースが存在し、ポリシーが設定されていない場合は、空のポリシーを返します。

承認スコープ

次の OAuth スコープのいずれかが必要です。

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

詳細については、認証の概要をご覧ください。

ListConnections

rpc ListConnections(ListConnectionsRequest) returns (ListConnectionsResponse)

指定したプロジェクトの接続のリストを返します。

承認スコープ

次の OAuth スコープのいずれかが必要です。

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

詳細については、認証の概要をご覧ください。

SetIamPolicy

rpc SetIamPolicy(SetIamPolicyRequest) returns (Policy)

指定したリソースにアクセス制御ポリシーを設定します。既存のポリシーをすべて置き換えます。

NOT_FOUNDINVALID_ARGUMENTPERMISSION_DENIED のエラーを返すことができます。

承認スコープ

次の OAuth スコープのいずれかが必要です。

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

詳細については、認証の概要をご覧ください。

TestIamPermissions

rpc TestIamPermissions(TestIamPermissionsRequest) returns (TestIamPermissionsResponse)

指定されたリソースに対して呼び出し元が持っている権限を返します。リソースが存在しない場合、NOT_FOUND エラーではなく、空の権限セットが返されます。

注: このオペレーションは、承認チェックではなく、権限に対応した UI とコマンドライン ツールの構築に使用するように設計されています。このオペレーションは警告なしに「フェイル オープン」することがあります。

承認スコープ

次の OAuth スコープのいずれかが必要です。

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

詳細については、認証の概要をご覧ください。

UpdateConnection

rpc UpdateConnection(UpdateConnectionRequest) returns (Connection)

指定された接続を更新します。セキュリティ上の理由から、更新フィールド マスクに接続プロパティが含まれている場合は認証情報もリセットします。

承認スコープ

次の OAuth スコープのいずれかが必要です。

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

詳細については、認証の概要をご覧ください。

CloudSqlCredential

Cloud SQL の認証情報。

フィールド
username

string

認証情報のユーザー名。

password

string

認証情報のパスワード。

CloudSqlProperties

Cloud SQL に固有の接続プロパティ。

フィールド
instance_id

string

Cloud SQL インスタンス ID。形式は project:location:instance です。

database

string

データベース名。

type

DatabaseType

Cloud SQL データベースのタイプ。

credential

CloudSqlCredential

入力のみ。Cloud SQL の認証情報。

DatabaseType

サポートされている Cloud SQL データベースのタイプ。

列挙型
DATABASE_TYPE_UNSPECIFIED 未指定のデータベース タイプ。
POSTGRES Cloud SQL for PostgreSQL。
MYSQL Cloud SQL for MySQL。

Connection

外部データソースとの接続を確立するための構成パラメータ。認証情報の属性は含まれません。

フィールド
name

string

接続のリソース名。形式は projects/{project_id}/locations/{location_id}/connections/{connection_id} です。

friendly_name

string

接続のユーザー指定の表示名。

description

string

ユーザー指定の説明。

creation_time

int64

出力のみ。接続作成時のタイムスタンプ。

last_modified_time

int64

出力のみ。接続の最終更新時のタイムスタンプ。

has_credential

bool

出力のみ。この接続に認証情報が構成されている場合は True。

cloud_sql

CloudSqlProperties

Cloud SQL のプロパティ。

CreateConnectionRequest

ConnectionService.CreateConnection のリクエスト。

フィールド
parent

string

必須。親リソース名。projects/{project_id}/locations/{location_id} の形式で指定してください。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • bigquery.connections.create
connection_id

string

作成された接続に割り当てる接続 ID(省略可)。

connection

Connection

必須。作成する接続。

DeleteConnectionRequest

[ConnectionService.DeleteConnectionRequest][] のリクエスト。

フィールド
name

string

必須。削除する接続の名前。例: projects/{project_id}/locations/{location_id}/connections/{connection_id}

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • bigquery.connections.delete

GetConnectionRequest

ConnectionService.GetConnection のリクエスト。

フィールド
name

string

必須。リクエストされた接続の名前。例: projects/{project_id}/locations/{location_id}/connections/{connection_id}

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • bigquery.connections.get

ListConnectionsRequest

ConnectionService.ListConnections のリクエスト。

フィールド
parent

string

必須。親リソース名。projects/{project_id}/locations/{location_id} という形式でなければなりません。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • bigquery.connections.list
page_size

int32

必須。ページサイズ

page_token

string

ページトークン。

ListConnectionsResponse

ConnectionService.ListConnections に対するレスポンス。

フィールド
next_page_token

string

次のページトークン。

connections[]

Connection

接続のリスト。

UpdateConnectionRequest

ConnectionService.UpdateConnection のリクエスト。

フィールド
name

string

必須。更新する接続の名前。例: projects/{project_id}/locations/{location_id}/connections/{connection_id}

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • bigquery.connections.update
connection

Connection

必須。更新されたフィールドを含む接続。

update_mask

FieldMask

必須。更新する接続フィールドのマスクを更新します。