- Resource: Connection
- ConnectionStatus
- State
- LockConfig
- NodeConfig
- LogConfig
- LogLevel
- SslConfig
- TrustModel
- SubscriptionType
- EventingEnablementType
- EventingConfig
- DeadLetterConfig
- EnrichmentConfig
- EventingRuntimeData
- EventingStatus
- State
- WebhookData
- WebhookSubscriptions
- ConnectorVersionInfraConfig
- DeploymentModel
- DeploymentModelMigrationState
- TLSMigrationState
- BillingConfig
- BillingCategory
- TrafficShapingConfig
- 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. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
updateTime |
Output only. Updated time. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. 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/*/providers/*/connectors/*/versions/* Only global location is supported for ConnectorVersion resource. |
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. |
destinationConfigs[] |
Optional. Configuration of the Connector's destination. Only accepted for Connectors that accepts user defined destination(s). |
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 Google Cloud 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" |
envoyImageLocation |
Output only. GCR location where the envoy image is stored. formatted like: gcr.io/{bucketName}/{imageName} |
suspended |
Optional. Suspended indicates if a user has suspended a connection or not. |
nodeConfig |
Optional. Node configuration for the connection. |
logConfig |
Optional. Log configuration for the connection. |
sslConfig |
Optional. Ssl config of a connection |
subscriptionType |
Output only. This subscription type enum states the subscription type of the project. |
connectionRevision |
Output only. Connection revision. This field is only updated when the connection is created or updated by User. |
eventingEnablementType |
Optional. Eventing enablement type. Will be nil if eventing is not enabled. |
eventingConfig |
Optional. Eventing config of a connection |
connectorVersionLaunchStage |
Output only. Flag to mark the version indicating the launch stage. |
eventingRuntimeData |
Output only. Eventing Runtime Data. |
connectorVersionInfraConfig |
Output only. Infra configs supported by Connector Version. |
isTrustedTester |
Output only. Is trusted tester program enabled for the project. |
authOverrideEnabled |
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 |
Output only. Billing config for the connection. |
asyncOperationsEnabled |
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. |
host |
Output only. The name of the Hostname of the Service Directory service with TLS. |
tlsServiceDirectory |
Output only. The name of the Service Directory service with TLS. |
trafficShapingConfigs[] |
Optional. Traffic shaping configuration for the connection. |
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. |
AUTHORIZATION_REQUIRED |
Connection is not running because the authorization configuration is not complete. |
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. |
NodeConfig
Node configuration for the connection.
JSON representation |
---|
{ "minNodeCount": integer, "maxNodeCount": integer } |
Fields | |
---|---|
minNodeCount |
Minimum number of nodes in the runtime nodes. |
maxNodeCount |
Maximum number of nodes in the runtime nodes. |
LogConfig
Log configuration for the connection.
JSON representation |
---|
{
"enabled": boolean,
"level": enum ( |
Fields | |
---|---|
enabled |
Enabled represents whether logging is enabled or not for a connection. |
level |
Optional. Log configuration level. |
LogLevel
Log configuration level enum for the connection.
Enums | |
---|---|
LOG_LEVEL_UNSPECIFIED |
Log level unspecified. |
ERROR |
Only error logs are enabled. |
INFO |
Info and error logs are enabled. |
DEBUG |
Debug and high verbosity logs are enabled. |
SslConfig
SSL Configuration of a connection
JSON representation |
---|
{ "type": enum ( |
Fields | |
---|---|
type |
Optional. Controls the ssl type for the given connector version. |
trustModel |
Optional. Trust Model of the SSL connection |
privateServerCertificate |
Optional. Private Server Certificate. Needs to be specified if trust model is |
clientCertificate |
Optional. Client Certificate |
clientPrivateKey |
Optional. Client Private Key |
clientPrivateKeyPass |
Optional. Secret containing the passphrase protecting the Client Private Key |
serverCertType |
Optional. Type of Server Cert (PEM/JKS/.. etc.) |
clientCertType |
Optional. Type of Client Cert (PEM/JKS/.. etc.) |
useSsl |
Optional. Bool for enabling SSL |
additionalVariables[] |
Optional. Additional SSL related field values |
TrustModel
Enum for Ttust Model
Enums | |
---|---|
PUBLIC |
Public Trust Model. Takes the Default Java trust store. |
PRIVATE |
Private Trust Model. Takes custom/private trust store. |
INSECURE |
Insecure Trust Model. Accept all certificates. |
SubscriptionType
Subscription Types
Enums | |
---|---|
SUBSCRIPTION_TYPE_UNSPECIFIED |
Unspecified subscription type. |
PAY_G |
PayG subscription. |
PAID |
Paid Subscription. |
EventingEnablementType
Eventing Enablement Type enum.
Enums | |
---|---|
EVENTING_ENABLEMENT_TYPE_UNSPECIFIED |
Eventing Enablement Type Unspecifeied. |
EVENTING_AND_CONNECTION |
Both connection and eventing. |
ONLY_EVENTING |
Only Eventing. |
EventingConfig
Eventing Configuration of a connection
JSON representation |
---|
{ "registrationDestinationConfig": { object ( |
Fields | |
---|---|
registrationDestinationConfig |
Optional. Registration endpoint for auto registration. |
authConfig |
Optional. Auth details for the webhook adapter. |
listenerAuthConfig |
Optional. Auth details for the event listener. |
additionalVariables[] |
Optional. Additional eventing related field values |
enrichmentEnabled |
Optional. Enrichment Enabled. |
privateConnectivityEnabled |
Optional. Private Connectivity Enabled. |
eventsListenerIngressEndpoint |
Optional. Ingress endpoint of the event listener. This is used only when private connectivity is enabled. |
deadLetterConfig |
Optional. Dead letter configuration for eventing of a connection. |
proxyDestinationConfig |
Optional. Proxy for Eventing auto-registration. |
enrichmentConfig |
Optional. Data enrichment configuration. |
DeadLetterConfig
Dead Letter configuration details provided by the user.
JSON representation |
---|
{ "topic": string, "projectId": string } |
Fields | |
---|---|
topic |
Optional. Topic to push events which couldn't be processed. |
projectId |
Optional. Project which has the topic given. |
EnrichmentConfig
Data enrichment configuration.
JSON representation |
---|
{ "appendAcl": boolean } |
Fields | |
---|---|
appendAcl |
Optional. Append ACL to the event. |
EventingRuntimeData
Eventing runtime data has the details related to eventing managed by the system.
JSON representation |
---|
{ "status": { object ( |
Fields | |
---|---|
status |
Output only. Current status of eventing. |
eventsListenerEndpoint |
Output only. Events listener endpoint. The value will populated after provisioning the events listener. |
eventsListenerPscSa |
Output only. Events listener PSC Service attachment. The value will be populated after provisioning the events listener with private connectivity enabled. |
Union field eventing_setup_data . Setup data for eventing type enabled. eventing_setup_data can be only one of the following: |
|
webhookData |
Output only. Webhook data. |
webhookSubscriptions |
Output only. Webhook subscriptions. |
EventingStatus
EventingStatus indicates the state of eventing.
JSON representation |
---|
{
"state": enum ( |
Fields | |
---|---|
state |
Output only. State. |
description |
Output only. Description of error if State is set to "ERROR". |
State
All the possible Eventing States.
Enums | |
---|---|
STATE_UNSPECIFIED |
Default state. |
ACTIVE |
Eventing is enabled and ready to receive events. |
ERROR |
Eventing is not active due to an error. |
INGRESS_ENDPOINT_REQUIRED |
Ingress endpoint required. |
WebhookData
WebhookData has details of webhook configuration.
JSON representation |
---|
{
"name": string,
"id": string,
"additionalVariables": [
{
object ( |
Fields | |
---|---|
name |
Output only. Name of the Webhook |
id |
Output only. ID to uniquely identify webhook. |
additionalVariables[] |
Output only. Additional webhook related field values. |
createTime |
Output only. Timestamp when the webhook was created. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
updateTime |
Output only. Timestamp when the webhook was last updated. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
nextRefreshTime |
Output only. Next webhook refresh time. Will be null if refresh is not supported. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
WebhookSubscriptions
WebhookSubscriptions has details of webhook subscriptions.
JSON representation |
---|
{
"webhookData": [
{
object ( |
Fields | |
---|---|
webhookData[] |
Output only. Webhook data. |
ConnectorVersionInfraConfig
This configuration provides infra configs like rate limit threshold which need to be configurable for every connector version
JSON representation |
---|
{ "ratelimitThreshold": string, "internalclientRatelimitThreshold": string, "hpaConfig": { object ( |
Fields | |
---|---|
ratelimitThreshold |
Output only. Max QPS supported by the connector version before throttling of requests. |
internalclientRatelimitThreshold |
Output only. Max QPS supported for internal requests originating from Connd. |
hpaConfig |
Output only. HPA autoscaling config. |
resourceRequests |
Output only. System resource requests. |
resourceLimits |
Output only. System resource limits. |
sharedDeployment |
Output only. The name of shared connector deployment. |
connectionRatelimitWindowSeconds |
Output only. The window used for ratelimiting runtime requests to connections. |
deploymentModel |
Output only. Indicates whether connector is deployed on GKE/CloudRun |
deploymentModelMigrationState |
Output only. Status of the deployment model migration. |
maxInstanceRequestConcurrency |
Output only. Max instance request concurrency. |
tlsMigrationState |
Output only. Status of the TLS migration. |
DeploymentModel
Enum for different deployment models
Enums | |
---|---|
DEPLOYMENT_MODEL_UNSPECIFIED |
Deployment model is not specified. |
GKE_MST |
Default model gke mst. |
CLOUD_RUN_MST |
Cloud run mst. |
DeploymentModelMigrationState
State of the deployment model migration.
Enums | |
---|---|
DEPLOYMENT_MODEL_MIGRATION_STATE_UNSPECIFIED |
Deployment model migration state is not specified. |
IN_PROGRESS |
Deployment model migration is in progress. |
COMPLETED |
Deployment model migration is completed. |
ROLLEDBACK |
Deployment model migration rolledback. |
ROLLBACK_IN_PROGRESS |
Deployment model migration rollback in progress. |
TLSMigrationState
State of the TLS migration.
Enums | |
---|---|
TLS_MIGRATION_STATE_UNSPECIFIED |
TLS migration state is not specified. |
TLS_MIGRATION_NOT_STARTED |
TLS migration is in progress. |
TLS_MIGRATION_COMPLETED |
TLS migration is completed. |
BillingConfig
Billing config for the connection.
JSON representation |
---|
{
"billingCategory": enum ( |
Fields | |
---|---|
billingCategory |
Output only. Billing category for the connector. |
BillingCategory
BillingCategory is an enum to indicate billing category.
Enums | |
---|---|
BILLING_CATEGORY_UNSPECIFIED |
Billing category is not specified. |
GCP_AND_TECHNICAL_CONNECTOR |
GCP/Technical connector. |
NON_GCP_CONNECTOR |
Non-GCP connector. |
TrafficShapingConfig
- TrafficShapingConfig defines the configuration for shaping API traffic by specifying a quota limit and the duration over which this limit is enforced. This configuration helps to control and manage the rate at which API calls are made on the client side, preventing service overload on the backend.
For example: - if the quota limit is 100 calls per 10 seconds, then the message would be: { quotaLimit: 100 duration: { seconds: 10 } }
if the quota limit is 100 calls per 5 minutes, then the message would be: { quotaLimit: 100 duration: { seconds: 300 } }
if the quota limit is 10000 calls per day, then the message would be: { quotaLimit: 10000 duration: { seconds: 86400 } and so on.
JSON representation |
---|
{ "quotaLimit": string, "duration": string } |
Fields | |
---|---|
quotaLimit |
Required. Maximum number of api calls allowed. |
duration |
Required. * The duration over which the API call quota limits are calculated. This duration is used to define the time window for evaluating if the number of API calls made by a user is within the allowed quota limits. For example: - To define a quota sampled over 16 seconds, set It is important to note that this duration is not the time the quota is valid for, but rather the time window over which the quota is evaluated. For example, if the quota is 100 calls per 10 seconds, then this duration field would be set to 10 seconds. A duration in seconds with up to nine fractional digits, ending with ' |
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. |
|
RepaiEventing tries to repair eventing related event subscriptions. |
|
Returns Top matching Connections for a given query. |
|
Sets the access control policy on the specified resource. |
|
Returns permissions that a caller has on the specified resource. |