软件包 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 错误。

注意:此操作旨在用于构建权限感知型界面和命令行工具,而不是用于授权检查。此操作可能会在没有警告的情况下“应急开启”。

授权范围

需要以下 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

必需。要更新的连接字段的更新掩码。