REST Resource: projects.locations.providers.connectors.versions

Resource: ConnectorVersion

ConnectorVersion indicates a specific version of a connector.

JSON representation 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "launchStage": enum (LaunchStage),
  "releaseVersion": string,
  "authConfigTemplates": [
    {
      object (AuthConfigTemplate)
    }
  ],
  "configVariableTemplates": [
    {
      object (ConfigVariableTemplate)
    }
  ],
  "destinationConfigTemplates": [
    {
      object (DestinationConfigTemplate)
    }
  ],
  "supportedRuntimeFeatures": {
    object (SupportedRuntimeFeatures)
  },
  "displayName": string,
  "egressControlConfig": {
    object (EgressControlConfig)
  },
  "roleGrants": [
    {
      object (RoleGrant)
    }
  ],
  "roleGrant": {
    object (RoleGrant)
  },
  "sslConfigTemplate": {
    object (SslConfigTemplate)
  },
  "eventingConfigTemplate": {
    object (EventingConfigTemplate)
  },
  "connectorInfraConfig": {
    object (ConnectorInfraConfig)
  },
  "unsupportedConnectionTypes": [
    enum (ConnectionType)
  ]
}
Fields
name

string

Output only. Resource name of the Version. Format: projects/{project}/locations/{location}/providers/{provider}/connectors/{connector}/versions/{version} Only global location is supported for Connector resource.
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)

Output only. 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" }.
launchStage

enum (LaunchStage)

Output only. Flag to mark the version indicating the launch stage.
releaseVersion

string

Output only. ReleaseVersion of the connector, for example: "1.0.1-alpha".
authConfigTemplates[]

object (AuthConfigTemplate)

Output only. List of auth configs supported by the Connector Version.
configVariableTemplates[]

object (ConfigVariableTemplate)

Output only. List of config variables needed to create a connection.
destinationConfigTemplates[]

object (DestinationConfigTemplate)

Output only. List of destination configs needed to create a connection.
supportedRuntimeFeatures

object (SupportedRuntimeFeatures)

Output only. Information about the runtime features supported by the Connector.
displayName

string

Output only. Display name.
egressControlConfig

object (EgressControlConfig)

Output only. Configuration for Egress Control.
roleGrants[]

object (RoleGrant)

Output only. Role grant configurations for this connector version.
roleGrant

object (RoleGrant)

Output only. Role grant configuration for this config variable. It will be DEPRECATED soon.
sslConfigTemplate

object (SslConfigTemplate)

Output only. Ssl configuration supported by the Connector.
eventingConfigTemplate

object (EventingConfigTemplate)

Output only. Eventing configuration supported by the Connector.
connectorInfraConfig

object (ConnectorInfraConfig)

Output only. Infra configs supported by Connector.
unsupportedConnectionTypes[]

enum (ConnectionType)

Output only. Unsupported connection types.

AuthConfigTemplate

AuthConfigTemplate defines required field over an authentication type.

JSON representation 
{
  "authType": enum (AuthType),
  "configVariableTemplates": [
    {
      object (ConfigVariableTemplate)
    }
  ],
  "displayName": string,
  "description": string,
  "authKey": string
}
Fields
authType

enum (AuthType)

The type of authentication configured.
configVariableTemplates[]

object (ConfigVariableTemplate)

Config variables to describe an AuthConfig for a Connection.
displayName

string

Display name for authentication template.
description

string

Connector specific description for an authentication template.
authKey

string

Identifier key for auth config

DestinationConfigTemplate

DestinationConfigTemplate defines required destinations supported by the Connector.

JSON representation 
{
  "key": string,
  "displayName": string,
  "description": string,
  "min": integer,
  "max": integer,
  "portFieldType": enum (FieldType),
  "defaultPort": integer,
  "regexPattern": string,
  "isAdvanced": boolean
}
Fields
key

string

Key of the destination.
displayName

string

Display name of the parameter.
description

string

Description.
min

integer

The minimum number of destinations supported for this key.
max

integer

The maximum number of destinations supported for this key.
portFieldType

enum (FieldType)

Whether port number should be provided by customers.
defaultPort

integer

The default port.
regexPattern

string

Regex pattern for host.
isAdvanced

boolean

Whether the current destination tempalate is part of Advanced settings

FieldType

Enums
FIELD_TYPE_UNSPECIFIED
REQUIRED
OPTIONAL
NOT_USED

SupportedRuntimeFeatures

Supported runtime features of a connector version.

JSON representation 
{
  "entityApis": boolean,
  "actionApis": boolean,
  "sqlQuery": boolean
}
Fields
entityApis

boolean

Specifies if the connector supports entity apis like 'createEntity'.
actionApis

boolean

Specifies if the connector supports action apis like 'executeAction'.
sqlQuery

boolean

Specifies if the connector supports 'ExecuteSqlQuery' operation.

EgressControlConfig

Egress control config for connector runtime. These configurations define the rules to identify which outbound domains/hosts needs to be whitelisted. It may be a static information for a particular connector version or it is derived from the configurations provided by the customer in Connection resource.

JSON representation 
{

  // Union field oneof_backends can be only one of the following:
  "backends": string,
  "extractionRules": {
    object (ExtractionRules)
  }
  // End of list of possible types for union field oneof_backends.
}
Fields

Union field oneof_backends.

oneof_backends can be only one of the following:
backends

string

Static Comma separated backends which are common for all Connection resources. Supported formats for each backend are host:port or just host (host can be ip address or domain name).
extractionRules

object (ExtractionRules)

Extractions Rules to extract the backends from customer provided configuration.

ExtractionRules

Extraction Rules to identity the backends from customer provided configuration in Connection resource.

JSON representation 
{
  "extractionRule": [
    {
      object (ExtractionRule)
    }
  ]
}
Fields
extractionRule[]

object (ExtractionRule)

Collection of Extraction Rule.

ExtractionRule

Extraction Rule.

JSON representation 
{
  "source": {
    object (Source)
  },
  "extractionRegex": string
}
Fields
source

object (Source)

Source on which the rule is applied.
extractionRegex

string

Regex used to extract backend details from source. If empty, whole source value will be used.

Source

Source to extract the backend from.

JSON representation 
{
  "sourceType": enum (SourceType),
  "fieldId": string
}
Fields
sourceType

enum (SourceType)

Type of the source.
fieldId

string

Field identifier. For example config vaiable name.

SourceType

Supported Source types for extraction.

Enums
SOURCE_TYPE_UNSPECIFIED Default SOURCE.
CONFIG_VARIABLE Config Variable source type.

SslConfigTemplate

Ssl config details of a connector version

JSON representation 
{
  "sslType": enum (SslType),
  "isTlsMandatory": boolean,
  "serverCertType": [
    enum (CertType)
  ],
  "clientCertType": [
    enum (CertType)
  ],
  "additionalVariables": [
    {
      object (ConfigVariableTemplate)
    }
  ]
}
Fields
sslType

enum (SslType)

Controls the ssl type for the given connector version
isTlsMandatory

boolean

Boolean for determining if the connector version mandates TLS.
serverCertType[]

enum (CertType)

List of supported Server Cert Types
clientCertType[]

enum (CertType)

List of supported Client Cert Types
additionalVariables[]

object (ConfigVariableTemplate)

Any additional fields that need to be rendered

EventingConfigTemplate

Eventing Config details of a connector version.

JSON representation 
{
  "registrationDestinationConfig": {
    object (DestinationConfigTemplate)
  },
  "authConfigTemplates": [
    {
      object (AuthConfigTemplate)
    }
  ],
  "listenerAuthConfigTemplates": [
    {
      object (AuthConfigTemplate)
    }
  ],
  "additionalVariables": [
    {
      object (ConfigVariableTemplate)
    }
  ],
  "autoRefresh": boolean,
  "enrichmentSupported": boolean,
  "autoRegistrationSupported": boolean,
  "encryptionKeyTemplate": {
    object (ConfigVariableTemplate)
  },
  "isEventingSupported": boolean,
  "eventListenerType": enum (EventListenerType),
  "proxyDestinationConfig": {
    object (DestinationConfigTemplate)
  }
}
Fields
registrationDestinationConfig

object (DestinationConfigTemplate)

Registration host destination config template.
authConfigTemplates[]

object (AuthConfigTemplate)

AuthConfigTemplates represents the auth values for the webhook adapter.
listenerAuthConfigTemplates[]

object (AuthConfigTemplate)

ListenerAuthConfigTemplates represents the auth values for the event listener.
additionalVariables[]

object (ConfigVariableTemplate)

Additional fields that need to be rendered.
autoRefresh

boolean

Auto refresh to extend webhook life.
enrichmentSupported

boolean

Enrichment Supported.
autoRegistrationSupported

boolean

Auto Registration supported.
encryptionKeyTemplate

object (ConfigVariableTemplate)

Encryption key (can be either Google managed or CMEK).
isEventingSupported

boolean

Is Eventing Supported.
eventListenerType

enum (EventListenerType)

The type of the event listener for a specific connector.
proxyDestinationConfig

object (DestinationConfigTemplate)

Proxy destination config template.

EventListenerType

The different types of the event listener for a connector.

Enums
EVENT_LISTENER_TYPE_UNSPECIFIED Default value.
WEBHOOK_LISTENER Webhook listener. e.g. Jira, Zendesk, Servicenow etc.,
JMS_LISTENER JMS Listener. e.g. IBM MQ, Rabbit MQ etc.,

ConnectorInfraConfig

This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version

JSON representation 
{
  "ratelimitThreshold": string,
  "internalclientRatelimitThreshold": string,
  "hpaConfig": {
    object (HPAConfig)
  },
  "resourceRequests": {
    object (ResourceRequests)
  },
  "resourceLimits": {
    object (ResourceLimits)
  },
  "sharedDeployment": string,
  "connectionRatelimitWindowSeconds": string,
  "deploymentModel": enum (DeploymentModel)
}
Fields
ratelimitThreshold

string (int64 format)

Max QPS supported by the connector version before throttling of requests.
internalclientRatelimitThreshold

string (int64 format)

Max QPS supported for internal requests originating from Connd.
hpaConfig

object (HPAConfig)

HPA autoscaling config.
resourceRequests

object (ResourceRequests)

System resource requests.
resourceLimits

object (ResourceLimits)

System resource limits.
sharedDeployment

string

The name of shared connector deployment.
connectionRatelimitWindowSeconds

string (int64 format)

The window used for ratelimiting runtime requests to connections.
deploymentModel

enum (DeploymentModel)

Indicate whether connector is deployed on GKE/CloudRun

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.

ConnectionType

ConnectionType defines different types of possible connection.

Enums
CONNECTION_TYPE_UNSPECIFIED Connection type is unspecified.
CONNECTION_WITH_EVENTING Connection with eventing.
ONLY_CONNECTION Only connection.
ONLY_EVENTING Only eventing.

Methods

get

 Gets details of a single connector version.

list

 Lists Connector Versions in a given project and location.