- Resource: ConnectorVersion
- LaunchStage
- AuthConfigTemplate
- ConfigVariableTemplate
- ValueType
- RoleGrant
- Principal
- Resource
- Type
- SupportedRuntimeFeatures
- EgressControlConfig
- ExtractionRules
- ExtractionRule
- Source
- SourceType
- Methods
Resource: ConnectorVersion
ConnectorVersion indicates a specific version of a connector.
JSON representation | |
---|---|
{ "name": string, "createTime": string, "updateTime": string, "labels": { string: string, ... }, "launchStage": enum ( |
Fields | |
---|---|
name |
Output only. Resource name of the Version. Format: projects/{project}/locations/{location}/providers/{provider}/connectors/{connector}/versions/{version} |
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 |
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 |
launchStage |
Output only. Flag to mark the version indicating the launch stage. |
releaseVersion |
Output only. ReleaseVersion of the connector, for example: "1.0.1-alpha". |
authConfigTemplates[] |
Output only. List of auth configs supported by the Connector Version. |
configVariableTemplates[] |
Output only. List of config variables needed to create a connection. |
supportedRuntimeFeatures |
Output only. Information about the runtime features supported by the Connector. |
displayName |
Output only. Display name. |
egressControlConfig |
Output only. Configuration for Egress Control. |
roleGrants[] |
Output only. Role grant configurations for this connector version. |
roleGrant |
Output only. Role grant configuration for this config variable. It will be DEPRECATED soon. |
LaunchStage
LaunchStage is a enum to indicate launch stage: PREVIEW, GA, DEPRECATED.
Enums | |
---|---|
LAUNCH_STAGE_UNSPECIFIED |
LAUNCH_STAGE_UNSPECIFIED. |
PREVIEW |
PREVIEW. |
GA |
GA. |
DEPRECATED |
DEPRECATED. |
AuthConfigTemplate
AuthConfigTemplate defines required field over an authentication type.
JSON representation | |
---|---|
{ "authType": enum ( |
Fields | |
---|---|
authType |
The type of authentication configured. |
configVariableTemplates[] |
Config variables to describe an |
ConfigVariableTemplate
ConfigVariableTemplate provides metadata about a ConfigVariable
that is used in a Connection.
JSON representation | |
---|---|
{ "key": string, "valueType": enum ( |
Fields | |
---|---|
key |
Key of the config variable. |
valueType |
Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation. |
displayName |
Display name of the parameter. |
description |
Description. |
validationRegex |
Regular expression in RE2 syntax used for validating the |
required |
Flag represents that this |
roleGrant |
Role grant configuration for the config variable. |
ValueType
ValueType indicates the data type of the value.
Enums | |
---|---|
VALUE_TYPE_UNSPECIFIED |
Value type is not specified. |
STRING |
Value type is string. |
INT |
Value type is integer. |
BOOL |
Value type is boolean. |
SECRET |
Value type is secret. |
RoleGrant
This configuration defines all the Cloud IAM roles that needs to be granted to a particular GCP resource for the selected prinicpal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user.
JSON representation | |
---|---|
{ "principal": enum ( |
Fields | |
---|---|
principal |
Prinicipal/Identity for whom the role need to assigned. |
roles[] |
List of roles that need to be granted. |
resource |
Resource on which the roles needs to be granted for the principal. |
helperTextTemplate |
Template that UI can use to provide helper text to customers. |
Principal
Supported Principal values.
Enums | |
---|---|
PRINCIPAL_UNSPECIFIED |
Value type is not specified. |
CONNECTOR_SA |
Service Account used for Connector workload identity This is either the default service account if unspecified or Service Account provided by Customers through BYOSA. |
Resource
Resource definition
JSON representation | |
---|---|
{
"type": enum ( |
Fields | |
---|---|
type |
Different types of resource supported. |
pathTemplate |
Template to uniquely represent a GCP resource in a format IAM expects This is a template that can have references to other values provided in the config variable template. |
Type
Resource Type definition.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Value type is not specified. |
GCP_PROJECT |
GCP Project Resource. |
GCP_RESOURCE |
Any GCP Resource which is identified uniquely by IAM. |
GCP_SECRETMANAGER_SECRET |
GCP Secret Resource. |
GCP_SECRETMANAGER_SECRET_VERSION |
GCP Secret Version Resource. |
SupportedRuntimeFeatures
Supported runtime features of a connector version. This is passed to the management layer to add a new connector version by the connector developer. Details about how this proto is passed to the management layer is covered in this doc - go/runtime-manifest.
JSON representation | |
---|---|
{ "entityApis": boolean, "actionApis": boolean, "sqlQuery": boolean } |
Fields | |
---|---|
entityApis |
Specifies if the connector supports entity apis like 'createEntity'. |
actionApis |
Specifies if the connector supports action apis like 'executeAction'. |
sqlQuery |
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 |
Fields | ||
---|---|---|
Union field
|
||
backends |
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 |
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 ( |
Fields | |
---|---|
extractionRule[] |
Collection of Extraction Rule. |
ExtractionRule
Extraction Rule.
JSON representation | |
---|---|
{
"source": {
object ( |
Fields | |
---|---|
source |
Source on which the rule is applied. |
extractionRegex |
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 ( |
Fields | |
---|---|
sourceType |
Type of the source. |
fieldId |
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. |
Methods |
|
---|---|
|
Gets details of a single connector version. |
|
Lists Connector Versions in a given project and location. |