Package google.cloud.bigquery.connection.v1

Index

• ConnectionService (interface)
• CloudSqlCredential (message)
• CloudSqlProperties (message)
• CloudSqlProperties.DatabaseType (enum)
• Connection (message)
• CreateConnectionRequest (message)
• DeleteConnectionRequest (message)
• GetConnectionRequest (message)
• ListConnectionsRequest (message)
• ListConnectionsResponse (message)
• UpdateConnectionRequest (message)

ConnectionService

Manages external data source connections and credentials.

CreateConnection
rpc CreateConnection(CreateConnectionRequest) returns (Connection) Creates a new connection. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview.

DeleteConnection
rpc DeleteConnection(DeleteConnectionRequest) returns (Empty) Deletes connection and associated credential. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview.

GetConnection
rpc GetConnection(GetConnectionRequest) returns (Connection) Returns specified connection. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview.

GetIamPolicy
rpc GetIamPolicy(GetIamPolicyRequest) returns (Policy) Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview.

ListConnections
rpc ListConnections(ListConnectionsRequest) returns (ListConnectionsResponse) Returns a list of connections in the given project. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview.

SetIamPolicy

rpc SetIamPolicy(SetIamPolicyRequest) returns (Policy) Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview.

TestIamPermissions

rpc TestIamPermissions(TestIamPermissionsRequest) returns (TestIamPermissionsResponse) Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview.

UpdateConnection

rpc UpdateConnection(UpdateConnectionRequest) returns (Connection) Updates the specified connection. For security reasons, also resets credential if connection properties are in the update field mask. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview.

CloudSqlCredential

Credential info for the Cloud SQL.

Fields
username	string The username for the credential.
password	string The password for the credential.

CloudSqlProperties

Connection properties specific to the Cloud SQL.

Fields
instance_id	string Cloud SQL instance ID in the form project:location:instance.
database	string Database name.
type	DatabaseType Type of the Cloud SQL database.
credential	CloudSqlCredential Input only. Cloud SQL credential.

DatabaseType

Supported Cloud SQL database types.

Enums
DATABASE_TYPE_UNSPECIFIED	Unspecified database type.
POSTGRES	Cloud SQL for PostgreSQL.
MYSQL	Cloud SQL for MySQL.

Connection

Configuration parameters to establish connection with an external data source, except the credential attributes.

Fields
name	string The resource name of the connection in the form of: projects/{project_id}/locations/{location_id}/connections/{connection_id}
friendly_name	string User provided display name for the connection.
description	string User provided description.
creation_time	int64 Output only. The creation timestamp of the connection.
last_modified_time	int64 Output only. The last update timestamp of the connection.
has_credential	bool Output only. True, if credential is configured for this connection.
cloud_sql	CloudSqlProperties Cloud SQL properties.

CreateConnectionRequest

The request for ConnectionService.CreateConnection.

Fields
parent	string Required. Parent resource name. Must be in the format projects/{project_id}/locations/{location_id} Authorization requires the following IAM permission on the specified resource parent: bigquery.connections.create
connection_id	string Optional. Connection id that should be assigned to the created connection.
connection	Connection Required. Connection to create.

DeleteConnectionRequest

The request for [ConnectionService.DeleteConnectionRequest][].

Fields
name	string Required. Name of the deleted connection, for example: projects/{project_id}/locations/{location_id}/connections/{connection_id} Authorization requires the following IAM permission on the specified resource name: bigquery.connections.delete

GetConnectionRequest

The request for ConnectionService.GetConnection.

Fields
name	string Required. Name of the requested connection, for example: projects/{project_id}/locations/{location_id}/connections/{connection_id} Authorization requires the following IAM permission on the specified resource name: bigquery.connections.get

ListConnectionsRequest

The request for ConnectionService.ListConnections.

Fields
parent	string Required. Parent resource name. Must be in the form: projects/{project_id}/locations/{location_id} Authorization requires the following IAM permission on the specified resource parent: bigquery.connections.list
page_size	int32 Required. Page size.
page_token	string Page token.

ListConnectionsResponse

The response for ConnectionService.ListConnections.

Fields
next_page_token	string Next page token.
connections[]	Connection List of connections.

UpdateConnectionRequest

The request for ConnectionService.UpdateConnection.

Fields
name	string Required. Name of the connection to update, for example: projects/{project_id}/locations/{location_id}/connections/{connection_id} Authorization requires the following IAM permission on the specified resource name: bigquery.connections.update
connection	Connection Required. Connection containing the updated fields.
update_mask	FieldMask Required. Update mask for the connection fields to be updated.