REST Resource: projects.locations.connections

Stay organized with collections Save and categorize content based on your preferences.

Resource: Connection

Connection represents an instance of connector.

JSON representation
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "description": string,
  "connectorVersion": string,
  "status": {
    object (ConnectionStatus)
  },
  "configVariables": [
    {
      object (ConfigVariable)
    }
  ],
  "authConfig": {
    object (AuthConfig)
  },
  "lockConfig": {
    object (LockConfig)
  },
  "imageLocation": string,
  "serviceAccount": string,
  "serviceDirectory": string,
  "inactive": boolean,
  "envoyImageLocation": string,
  "egressBackends": [
    string
  ]
}
Fields
name

string

Output only. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection}

createTime

string (Timestamp format)

Output only. Created time.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Output only. Updated time.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

labels

map (key: string, value: string)

Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

description

string

Optional. Description of the resource.

connectorVersion

string

Required. Connector version on which the connection is created. The format is: projects/*/locations/global/providers/*/connectors/*/versions/*

status

object (ConnectionStatus)

Output only. Current status of the connection.

configVariables[]

object (ConfigVariable)

Optional. Configuration for configuring the connection with an external system.

authConfig

object (AuthConfig)

Optional. Configuration for establishing the connection's authentication with an external system.

lockConfig

object (LockConfig)

Optional. Configuration that indicates whether or not the Connection can be edited.

imageLocation

string

Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName}

serviceAccount

string

Optional. Service account needed for runtime plane to access GCP resources.

serviceDirectory

string

Output only. The name of the Service Directory service name. Used for Private Harpoon to resolve the ILB address. e.g. "projects/cloud-connectors-e2e-testing/locations/us-central1/namespaces/istio-system/services/istio-ingressgateway-connectors"

inactive

boolean

Optional. Inactive indicates the connection is active to use or not.

envoyImageLocation

string

Output only. GCR location where the envoy image is stored. formatted like: gcr.io/{bucketName}/{imageName}

egressBackends[]

string

Output only. Outbound domains/hosts needs to be allowlisted.

ConnectionStatus

ConnectionStatus indicates the state of the connection.

JSON representation
{
  "state": enum (State),
  "description": string,
  "status": string
}
Fields
state

enum (State)

State.

description

string

Description.

status

string

Status provides detailed information for the state.

State

All the possible Connection State.

Enums
STATE_UNSPECIFIED Connection does not have a state yet.
CREATING Connection is being created.
ACTIVE Connection is running and ready for requests.
INACTIVE Connection is stopped.
DELETING Connection is being deleted.
UPDATING Connection is being updated.
ERROR Connection is not running due to an error.

ConfigVariable

ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.

JSON representation
{
  "key": string,

  // Union field value can be only one of the following:
  "intValue": string,
  "boolValue": boolean,
  "stringValue": string,
  "secretValue": {
    object (Secret)
  }
  // End of list of possible types for union field value.
}
Fields
key

string

Key of the config variable.

Union field value. Value type of the config variable. value can be only one of the following:
intValue

string (int64 format)

Value is an integer

boolValue

boolean

Value is a bool.

stringValue

string

Value is a string.

secretValue

object (Secret)

Value is a secret.

Secret

Secret provides a reference to entries in Secret Manager.

JSON representation
{
  "secretVersion": string
}
Fields
secretVersion

string

The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*.

AuthConfig

AuthConfig defines details of a authentication type.

JSON representation
{
  "authType": enum (AuthType),
  "additionalVariables": [
    {
      object (ConfigVariable)
    }
  ],

  // Union field type can be only one of the following:
  "userPassword": {
    object (UserPassword)
  },
  "oauth2JwtBearer": {
    object (Oauth2JwtBearer)
  },
  "oauth2ClientCredentials": {
    object (Oauth2ClientCredentials)
  }
  // End of list of possible types for union field type.
}
Fields
authType

enum (AuthType)

The type of authentication configured.

additionalVariables[]

object (ConfigVariable)

List containing additional auth configs.

Union field type. Supported auth types. type can be only one of the following:
userPassword

object (UserPassword)

UserPassword.

oauth2JwtBearer

object (Oauth2JwtBearer)

Oauth2JwtBearer.

oauth2ClientCredentials

object (Oauth2ClientCredentials)

Oauth2ClientCredentials.

UserPassword

Parameters to support Username and Password Authentication.

JSON representation
{
  "username": string,
  "password": {
    object (Secret)
  }
}
Fields
username

string

Username.

password

object (Secret)

Secret version reference containing the password.

Oauth2JwtBearer

Parameters to support JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant based authentication. See https://tools.ietf.org/html/rfc7523 for more details.

JSON representation
{
  "clientKey": {
    object (Secret)
  },
  "jwtClaims": {
    object (JwtClaims)
  }
}
Fields
clientKey

object (Secret)

Secret version reference containing a PKCS#8 PEM-encoded private key associated with the Client Certificate. This private key will be used to sign JWTs used for the jwt-bearer authorization grant. Specified in the form as: projects/*/secrets/*/versions/*.

jwtClaims

object (JwtClaims)

JwtClaims providers fields to generate the token.

JwtClaims

JWT claims used for the jwt-bearer authorization grant.

JSON representation
{
  "issuer": string,
  "subject": string,
  "audience": string
}
Fields
issuer

string

Value for the "iss" claim.

subject

string

Value for the "sub" claim.

audience

string

Value for the "aud" claim.

Oauth2ClientCredentials

Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details.

JSON representation
{
  "clientId": string,
  "clientSecret": {
    object (Secret)
  }
}
Fields
clientId

string

The client identifier.

clientSecret

object (Secret)

Secret version reference containing the client secret.

LockConfig

Determines whether or no a connection is locked. If locked, a reason must be specified.

JSON representation
{
  "locked": boolean,
  "reason": string
}
Fields
locked

boolean

Indicates whether or not the connection is locked.

reason

string

Describes why a connection is locked.

Methods

create

Creates a new Connection in a given project and location.

delete

Deletes a single Connection.

get

Gets details of a single Connection.

getConnectionSchemaMetadata

Gets schema metadata of a connection.

getIamPolicy

Gets the access control policy for a resource.

list

Lists Connections in a given project and location.

patch

Updates the parameters of a single Connection.

setIamPolicy

Sets the access control policy on the specified resource.

testIamPermissions

Returns permissions that a caller has on the specified resource.