- Resource: Connection
- ConnectionStatus
- State
- ConfigVariable
- Secret
- AuthConfig
- UserPassword
- Oauth2JwtBearer
- JwtClaims
- Oauth2ClientCredentials
- LockConfig
- Methods
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 ( |
Fields | |
---|---|
name |
Output only. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection} |
createTime |
Output only. Created time. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
updateTime |
Output only. Updated time. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
labels |
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 |
description |
Optional. Description of the resource. |
connectorVersion |
Required. Connector version on which the connection is created. The format is: projects/*/locations/global/providers/*/connectors/*/versions/* |
status |
Output only. Current status of the connection. |
configVariables[] |
Optional. Configuration for configuring the connection with an external system. |
authConfig |
Optional. Configuration for establishing the connection's authentication with an external system. |
lockConfig |
Optional. Configuration that indicates whether or not the Connection can be edited. |
imageLocation |
Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName} |
serviceAccount |
Optional. Service account needed for runtime plane to access GCP resources. |
serviceDirectory |
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 |
Optional. Inactive indicates the connection is active to use or not. |
envoyImageLocation |
Output only. GCR location where the envoy image is stored. formatted like: gcr.io/{bucketName}/{imageName} |
egressBackends[] |
Output only. Outbound domains/hosts needs to be allowlisted. |
ConnectionStatus
ConnectionStatus indicates the state of the connection.
JSON representation | |
---|---|
{
"state": enum ( |
Fields | |
---|---|
state |
State. |
description |
Description. |
status |
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 |
Fields | ||
---|---|---|
key |
Key of the config variable. |
|
Union field value . Value type of the config variable. value can be only one of the following: |
||
intValue |
Value is an integer |
|
boolValue |
Value is a bool. |
|
stringValue |
Value is a string. |
|
secretValue |
Value is a secret. |
Secret
Secret provides a reference to entries in Secret Manager.
JSON representation | |
---|---|
{ "secretVersion": string } |
Fields | |
---|---|
secretVersion |
The resource name of the secret version in the format, format as: |
AuthConfig
AuthConfig defines details of a authentication type.
JSON representation | |
---|---|
{ "authType": enum ( |
Fields | ||
---|---|---|
authType |
The type of authentication configured. |
|
additionalVariables[] |
List containing additional auth configs. |
|
Union field type . Supported auth types. type can be only one of the following: |
||
userPassword |
UserPassword. |
|
oauth2JwtBearer |
Oauth2JwtBearer. |
|
oauth2ClientCredentials |
Oauth2ClientCredentials. |
UserPassword
Parameters to support Username and Password Authentication.
JSON representation | |
---|---|
{
"username": string,
"password": {
object ( |
Fields | |
---|---|
username |
Username. |
password |
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 ( |
Fields | |
---|---|
clientKey |
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: |
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 |
Value for the "iss" claim. |
subject |
Value for the "sub" claim. |
audience |
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 ( |
Fields | |
---|---|
clientId |
The client identifier. |
clientSecret |
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 |
Indicates whether or not the connection is locked. |
reason |
Describes why a connection is locked. |
Methods |
|
---|---|
|
Creates a new Connection in a given project and location. |
|
Deletes a single Connection. |
|
Gets details of a single Connection. |
|
Gets schema metadata of a connection. |
|
Gets the access control policy for a resource. |
|
Lists Connections in a given project and location. |
|
Updates the parameters of a single Connection. |
|
Sets the access control policy on the specified resource. |
|
Returns permissions that a caller has on the specified resource. |