REST Resource: projects.locations.connections

Resource: Connection

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

JSON representation 
 { 
 "name" 
 : 
 string 
 , 
 "friendlyName" 
 : 
 string 
 , 
 "description" 
 : 
 string 
 , 
 "creationTime" 
 : 
 string 
 , 
 "lastModifiedTime" 
 : 
 string 
 , 
 "hasCredential" 
 : 
 boolean 
 , 
 // Union field properties 
can be only one of the following: 
 "cloudSql" 
 : 
 { 
 object (  CloudSqlProperties 
 
) 
 } 
 // End of list of possible types for union field properties 
. 
 }
Fields
name

string

The resource name of the connection in the form of: projects/{projectId}/locations/{locationId}/connections/{connectionId}

friendlyName

string

User provided display name for the connection.

description

string

User provided description.

creationTime

string ( int64 format)

Output only. The creation timestamp of the connection.

lastModifiedTime

string ( int64 format)

Output only. The last update timestamp of the connection.

hasCredential

boolean

Output only. True, if credential is configured for this connection.

Union field properties . Properties specific to the underlying data source. properties can be only one of the following:
cloudSql

object ( CloudSqlProperties )

Cloud SQL properties.

CloudSqlProperties

Connection properties specific to the Cloud SQL.

JSON representation 
 { 
 "instanceId" 
 : 
 string 
 , 
 "database" 
 : 
 string 
 , 
 "type" 
 : 
 enum (  DatabaseType 
 
) 
 , 
 "credential" 
 : 
 { 
 object (  CloudSqlCredential 
 
) 
 } 
 , 
 "serviceAccountId" 
 : 
 string 
 }
Fields
instanceId

string

Cloud SQL instance ID in the form project:location:instance .
database

string

Database name.
type

enum ( DatabaseType )

Type of the Cloud SQL database.
credential

object ( 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.

CloudSqlCredential

Credential info for the Cloud SQL.

JSON representation 
 { 
 "username" 
 : 
 string 
 , 
 "password" 
 : 
 string 
 }
Fields
username

string

The username for the credential.
password

string

The password for the credential.

Methods

create

Creates a new connection.

delete

Deletes connection and associated credential.

get

Returns specified connection.

getIamPolicy

Gets the access control policy for a resource.

list

Returns a list of connections in the given project.

patch

Updates the specified connection.

setIamPolicy

Sets the access control policy on the specified resource.

testIamPermissions

Returns permissions that a caller has on the specified resource.

updateCredential

Sets the credential for the specified connection.