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,
  "cloudSql": {
    object (CloudSqlProperties)
  }
}
Fields
name

string

The resource name of the connection in the form of: projects/{project_id}/locations/{location_id}/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 the connection has credential assigned.

cloudSql

object (CloudSqlProperties)

Cloud SQL properties.

CloudSqlProperties

Connection properties specific to the Cloud SQL.

JSON representation
{
  "instanceId": string,
  "database": string,
  "type": enum (DatabaseType)
}
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.

DatabaseType

Supported Cloud SQL database types.

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

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.
Was this page helpful? Let us know how we did:

Send feedback about...