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 | |
---|---|
Creates a new connection.
|
DeleteConnection | |
---|---|
Deletes connection and associated credential.
|
GetConnection | |
---|---|
Returns specified connection.
|
GetIamPolicy | |
---|---|
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
|
ListConnections | |
---|---|
Returns a list of connections in the given project.
|
SetIamPolicy | |
---|---|
Sets the access control policy on the specified resource. Replaces any existing policy. Can return
|
TestIamPermissions | |
---|---|
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 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.
|
UpdateConnection | |
---|---|
Updates the specified connection. For security reasons, also resets credential if connection properties are in the update field mask.
|
CloudSqlCredential
Credential info for the Cloud SQL.
Fields | |
---|---|
username |
The username for the credential. |
password |
The password for the credential. |
CloudSqlProperties
Connection properties specific to the Cloud SQL.
Fields | |
---|---|
instance_id |
Cloud SQL instance ID in the form |
database |
Database name. |
type |
Type of the Cloud SQL database. |
credential |
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 |
The resource name of the connection in the form of: |
friendly_name |
User provided display name for the connection. |
description |
User provided description. |
creation_time |
Output only. The creation timestamp of the connection. |
last_modified_time |
Output only. The last update timestamp of the connection. |
has_credential |
Output only. True, if credential is configured for this connection. |
cloud_sql |
Cloud SQL properties. |
CreateConnectionRequest
The request for ConnectionService.CreateConnection
.
Fields | |
---|---|
parent |
Required. Parent resource name. Must be in the format Authorization requires the following IAM permission on the specified resource
|
connection_id |
Optional. Connection id that should be assigned to the created connection. |
connection |
Required. Connection to create. |
DeleteConnectionRequest
The request for [ConnectionService.DeleteConnectionRequest][].
Fields | |
---|---|
name |
Required. Name of the deleted connection, for example: Authorization requires the following IAM permission on the specified resource
|
GetConnectionRequest
The request for ConnectionService.GetConnection
.
Fields | |
---|---|
name |
Required. Name of the requested connection, for example: Authorization requires the following IAM permission on the specified resource
|
ListConnectionsRequest
The request for ConnectionService.ListConnections
.
Fields | |
---|---|
parent |
Required. Parent resource name. Must be in the form: Authorization requires the following IAM permission on the specified resource
|
page_size |
Required. Page size. |
page_token |
Page token. |
ListConnectionsResponse
The response for ConnectionService.ListConnections
.
Fields | |
---|---|
next_page_token |
Next page token. |
connections[] |
List of connections. |
UpdateConnectionRequest
The request for ConnectionService.UpdateConnection
.
Fields | |
---|---|
name |
Required. Name of the connection to update, for example: Authorization requires the following IAM permission on the specified resource
|
connection |
Required. Connection containing the updated fields. |
update_mask |
Required. Update mask for the connection fields to be updated. |