package google.cloud.bigquery.connection.v1beta1
Get desktop application:
View/edit binary Protocol Buffers messages
Manages external data source connections and credentials.
rpc CreateConnection (, )
connection.proto:40Creates a new connection.
message
connection.proto:122The request for [ConnectionService.CreateConnection][google.cloud.bigquery.connection.v1beta1.ConnectionService.CreateConnection].
string parent = 1
Parent resource name. Must be in the format `projects/{project_id}/locations/{location_id}`
string connection_id = 2
Optional connection id that should be assigned to the created connection.
optional connection = 3
Connection to create.
rpc GetConnection (, )
connection.proto:48Returns specified connection.
message
connection.proto:135The request for [ConnectionService.GetConnection][google.cloud.bigquery.connection.v1beta1.ConnectionService.GetConnection].
string name = 1
Name of the requested connection, for example: `projects/{project_id}/locations/{location_id}/connections/{connection_id}`
rpc ListConnections (, )
connection.proto:55Returns a list of connections in the given project.
message
connection.proto:142The request for [ConnectionService.ListConnections][google.cloud.bigquery.connection.v1beta1.ConnectionService.ListConnections].
string parent = 1
Parent resource name. Must be in the form: `projects/{project_id}/locations/{location_id}`
optional max_results = 2
Maximum number of results per page.
string page_token = 3
Page token.
message
connection.proto:155The response for [ConnectionService.ListConnections][google.cloud.bigquery.connection.v1beta1.ConnectionService.ListConnections].
string next_page_token = 1
Next page token.
repeated connections = 2
List of connections.
rpc UpdateConnection (, )
connection.proto:63Updates the specified connection. For security reasons, also resets credential if connection properties are in the update field mask.
message
connection.proto:164The request for [ConnectionService.UpdateConnection][google.cloud.bigquery.connection.v1beta1.ConnectionService.UpdateConnection].
string name = 1
Name of the connection to update, for example: `projects/{project_id}/locations/{location_id}/connections/{connection_id}`
optional connection = 2
Connection containing the updated fields.
optional update_mask = 3
Update mask for the connection fields to be updated.
Sets the credential for the specified connection.
message
connection.proto:177The request for [ConnectionService.UpdateConnectionCredential][google.cloud.bigquery.connection.v1beta1.ConnectionService.UpdateConnectionCredential].
string name = 1
Name of the connection, for example: `projects/{project_id}/locations/{location_id}/connections/{connection_id}/credential`
optional credential = 2
Credential to use with the connection.
rpc DeleteConnection (, )
connection.proto:79Deletes connection and associated credential.
message
connection.proto:187The request for [ConnectionService.DeleteConnectionRequest][].
string name = 1
Name of the deleted connection, for example: `projects/{project_id}/locations/{location_id}/connections/{connection_id}`
rpc GetIamPolicy (, )
connection.proto:88Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
rpc SetIamPolicy (, )
connection.proto:99Sets the access control policy on the specified resource. Replaces any existing policy. Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED
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.
message
connection.proto:256Credential info for the Cloud SQL.
Used in:
string username = 1
The username for the credential.
string password = 2
The password for the credential.
message
connection.proto:232Connection properties specific to the Cloud SQL.
Used in:
string instance_id = 1
Cloud SQL instance ID in the form `project:location:instance`.
string database = 2
Database name.
CloudSqlProperties.DatabaseType type = 3
Type of the Cloud SQL database.
Supported Cloud SQL database types.
Used in:
DATABASE_TYPE_UNSPECIFIED = 0
Unspecified database type.
POSTGRES = 1
Cloud SQL for PostgreSQL.
MYSQL = 2
Cloud SQL for MySQL.
message
connection.proto:195Configuration parameters to establish connection with an external data source, except the credential attributes.
Used as response type in: ConnectionService.CreateConnection, ConnectionService.GetConnection, ConnectionService.UpdateConnection
Used as field type in: , ,
string name = 1
The resource name of the connection in the form of: `projects/{project_id}/locations/{location_id}/connections/{connection_id}`
string friendly_name = 2
User provided display name for the connection.
string description = 3
User provided description.
oneof properties
Properties specific to the underlying data source.
cloud_sql = 4
Cloud SQL properties.
int64 creation_time = 5
Output only. The creation timestamp of the connection.
int64 last_modified_time = 6
Output only. The last update timestamp of the connection.
bool has_credential = 7
Output only. True, if credential is configured for this connection.
message
connection.proto:223Credential to use with a connection.
Used in:
oneof credential
Credential specific to the underlying data source.
cloud_sql = 1
Credential for Cloud SQL database.