Package google.cloud.bigquery.connection.v1beta1

Index

• ConnectionService (interface)
• CloudSqlCredential (message)
• CloudSqlProperties (message)
• CloudSqlProperties.DatabaseType (enum)
• Connection (message)
• ConnectionCredential (message)
• CreateConnectionRequest (message)
• DeleteConnectionRequest (message)
• GetConnectionRequest (message)
• ListConnectionsRequest (message)
• ListConnectionsResponse (message)
• UpdateConnectionCredentialRequest (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.

UpdateConnectionCredential
rpc UpdateConnectionCredential(UpdateConnectionCredentialRequest) returns (Empty) Sets the credential for the 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.

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.
service_account_id	string Output only. The account ID of the service used for the purpose of this connection. When the connection is used in the context of an operation in BigQuery, this service account will serve as the identity being used for connecting to the CloudSQL instance specified in this connection.

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