connections

Creates, updates, deletes, gets or lists a connections resource.

Overview

Name	connections
Type	Resource
Id	google.integrations.connections

Fields

The following fields are returned by SELECT queries:

projects_locations_connections_list

Successful response

Name	Datatype	Description
name	string	Output only. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection}
asyncOperationsEnabled	boolean	Optional. Async operations enabled for the connection. If Async Operations is enabled, Connection allows the customers to initiate async long running operations using the actions API.
authConfig	object	Optional. Configuration for establishing the connection's authentication with an external system. (id: GoogleCloudConnectorsV1AuthConfig)
authOverrideEnabled	boolean	Optional. Auth override enabled for the connection. If Auth Override is enabled, Connection allows the backend service auth to be overridden in the entities/actions API.
billingConfig	object	Output only. Billing config for the connection. (id: GoogleCloudConnectorsV1BillingConfig)
configVariables	array	Optional. Configuration for configuring the connection with an external system.
connectionRevision	string (int64)	Output only. Connection revision. This field is only updated when the connection is created or updated by User.
connectorVersion	string	Required. Connector version on which the connection is created. The format is: projects//locations//providers//connectors//versions/* Only global location is supported for ConnectorVersion resource.
connectorVersionInfraConfig	object	Output only. Infra configs supported by Connector Version. (id: GoogleCloudConnectorsV1ConnectorVersionInfraConfig)
connectorVersionLaunchStage	string	Output only. Flag to mark the version indicating the launch stage.
createTime	string (google-datetime)	Output only. Created time.
description	string	Optional. Description of the resource.
destinationConfigs	array	Optional. Configuration of the Connector's destination. Only accepted for Connectors that accepts user defined destination(s).
envoyImageLocation	string	Output only. GCR location where the envoy image is stored. formatted like: gcr.io/{bucketName}/{imageName}
euaOauthAuthConfig	object	Optional. Additional Oauth2.0 Auth config for EUA. If the connection is configured using non-OAuth authentication but OAuth needs to be used for EUA, this field can be populated with the OAuth config. This should be a OAuth2AuthCodeFlow Auth type only. (id: GoogleCloudConnectorsV1AuthConfig)
eventingConfig	object	Optional. Eventing config of a connection (id: GoogleCloudConnectorsV1EventingConfig)
eventingEnablementType	string	Optional. Eventing enablement type. Will be nil if eventing is not enabled.
eventingRuntimeData	object	Output only. Eventing Runtime Data. (id: GoogleCloudConnectorsV1EventingRuntimeData)
fallbackOnAdminCredentials	boolean	Optional. Fallback on admin credentials for the connection. If this both auth_override_enabled and fallback_on_admin_credentials are set to true, the connection will use the admin credentials if the dynamic auth header is not present during auth override.
host	string	Output only. The name of the Hostname of the Service Directory service with TLS.
imageLocation	string	Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName}
isTrustedTester	boolean	Output only. Is trusted tester program enabled for the project.
labels	object	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
lockConfig	object	Optional. Configuration that indicates whether or not the Connection can be edited. (id: GoogleCloudConnectorsV1LockConfig)
logConfig	object	Optional. Log configuration for the connection. (id: GoogleCloudConnectorsV1LogConfig)
nodeConfig	object	Optional. Node configuration for the connection. (id: GoogleCloudConnectorsV1NodeConfig)
serviceAccount	string	Optional. Service account needed for runtime plane to access Google Cloud 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"
sslConfig	object	Optional. Ssl config of a connection (id: GoogleCloudConnectorsV1SslConfig)
status	object	Output only. Current status of the connection. (id: GoogleCloudConnectorsV1ConnectionStatus)
subscriptionType	string	Output only. This subscription type enum states the subscription type of the project.
suspended	boolean	Optional. Suspended indicates if a user has suspended a connection or not.
tlsServiceDirectory	string	Output only. The name of the Service Directory service with TLS.
trafficShapingConfigs	array	Optional. Traffic shaping configuration for the connection.
updateTime	string (google-datetime)	Output only. Updated time.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_connections_list	select	projectsId, locationsId	pageSize, pageToken, filter, orderBy	Lists Connections in a given project and location.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
locationsId	string
projectsId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string

SELECT examples

projects_locations_connections_list

Lists Connections in a given project and location.

SELECT
name,
asyncOperationsEnabled,
authConfig,
authOverrideEnabled,
billingConfig,
configVariables,
connectionRevision,
connectorVersion,
connectorVersionInfraConfig,
connectorVersionLaunchStage,
createTime,
description,
destinationConfigs,
envoyImageLocation,
euaOauthAuthConfig,
eventingConfig,
eventingEnablementType,
eventingRuntimeData,
fallbackOnAdminCredentials,
host,
imageLocation,
isTrustedTester,
labels,
lockConfig,
logConfig,
nodeConfig,
serviceAccount,
serviceDirectory,
sslConfig,
status,
subscriptionType,
suspended,
tlsServiceDirectory,
trafficShapingConfigs,
updateTime
FROM google.integrations.connections
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';