feat(connectors): update the api

#### connectors:v1 The following keys were deleted: - schemas.CustomConnector.properties.launchStage (Total Keys: 2) - schemas.CustomConnectorVersion.properties.type.type (Total Keys: 1) - schemas.EventingConfig.properties.encryptionKey.$ref (Total Keys: 1) The following keys were added: - resources.projects.resources.locations.resources.connections.methods.listenEvent (Total Keys: 12) - schemas.ConnectionSchemaMetadata.properties.errorMessage.type (Total Keys: 1) - schemas.CustomConnectorVersion.properties.serviceAccount.type (Total Keys: 1) - schemas.EventingConfig.properties.listenerAuthConfig.$ref (Total Keys: 1) - schemas.EventingConfigTemplate.properties.listenerAuthConfigTemplates (Total Keys: 2) - schemas.ListenEventRequest (Total Keys: 4) - schemas.ListenEventResponse (Total Keys: 2)
googleapis · Dec 7, 2023 · 255dcdb · 255dcdb
1 parent d1a6305
commit 255dcdb
Show file tree

Hide file tree

Showing 6 changed files with 489 additions and 99 deletions.
diff --git a/docs/dyn/connectors_v1.projects.locations.connections.html b/docs/dyn/connectors_v1.projects.locations.connections.html
diff --git a/...yn/connectors_v1.projects.locations.global_.customConnectors.customConnectorVersions.html b/...yn/connectors_v1.projects.locations.global_.customConnectors.customConnectorVersions.html
@@ -192,8 +192,8 @@ <h3>Method Details</h3>
     &quot;a_key&quot;: &quot;A String&quot;,
   },
   &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. Resource name of the Version. Format: projects/{project}/locations/{location}/customConnectors/{custom_connector}/customConnectorVersions/{custom_connector_version}
+  &quot;serviceAccount&quot;: &quot;A String&quot;, # Required. Service account needed for runtime plane to access Custom Connector secrets.
   &quot;specLocation&quot;: &quot;A String&quot;, # Optional. Location of the custom connector spec.
-  &quot;type&quot;: &quot;A String&quot;, # Required. Type of the customConnector.
   &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Updated time.
 }
 
@@ -358,8 +358,8 @@ <h3>Method Details</h3>
     &quot;a_key&quot;: &quot;A String&quot;,
   },
   &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. Resource name of the Version. Format: projects/{project}/locations/{location}/customConnectors/{custom_connector}/customConnectorVersions/{custom_connector_version}
+  &quot;serviceAccount&quot;: &quot;A String&quot;, # Required. Service account needed for runtime plane to access Custom Connector secrets.
   &quot;specLocation&quot;: &quot;A String&quot;, # Optional. Location of the custom connector spec.
-  &quot;type&quot;: &quot;A String&quot;, # Required. Type of the customConnector.
   &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Updated time.
 }</pre>
 </div>
@@ -464,8 +464,8 @@ <h3>Method Details</h3>
         &quot;a_key&quot;: &quot;A String&quot;,
       },
       &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. Resource name of the Version. Format: projects/{project}/locations/{location}/customConnectors/{custom_connector}/customConnectorVersions/{custom_connector_version}
+      &quot;serviceAccount&quot;: &quot;A String&quot;, # Required. Service account needed for runtime plane to access Custom Connector secrets.
       &quot;specLocation&quot;: &quot;A String&quot;, # Optional. Location of the custom connector spec.
-      &quot;type&quot;: &quot;A String&quot;, # Required. Type of the customConnector.
       &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Updated time.
     },
   ],
@@ -581,8 +581,8 @@ <h3>Method Details</h3>
     &quot;a_key&quot;: &quot;A String&quot;,
   },
   &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. Resource name of the Version. Format: projects/{project}/locations/{location}/customConnectors/{custom_connector}/customConnectorVersions/{custom_connector_version}
+  &quot;serviceAccount&quot;: &quot;A String&quot;, # Required. Service account needed for runtime plane to access Custom Connector secrets.
   &quot;specLocation&quot;: &quot;A String&quot;, # Optional. Location of the custom connector spec.
-  &quot;type&quot;: &quot;A String&quot;, # Required. Type of the customConnector.
   &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Updated time.
 }
 

diff --git a/docs/dyn/connectors_v1.projects.locations.global_.customConnectors.html b/docs/dyn/connectors_v1.projects.locations.global_.customConnectors.html
@@ -123,7 +123,6 @@ <h3>Method Details</h3>
   &quot;labels&quot;: { # 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
     &quot;a_key&quot;: &quot;A String&quot;,
   },
-  &quot;launchStage&quot;: &quot;A String&quot;, # Output only. Launch stage.
   &quot;logo&quot;: &quot;A String&quot;, # Optional. Logo of the resource.
   &quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name of the CustomConnector. Format: projects/{project}/locations/{location}/customConnectors/{connector}
   &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Updated time.
@@ -216,7 +215,6 @@ <h3>Method Details</h3>
   &quot;labels&quot;: { # 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
     &quot;a_key&quot;: &quot;A String&quot;,
   },
-  &quot;launchStage&quot;: &quot;A String&quot;, # Output only. Launch stage.
   &quot;logo&quot;: &quot;A String&quot;, # Optional. Logo of the resource.
   &quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name of the CustomConnector. Format: projects/{project}/locations/{location}/customConnectors/{connector}
   &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Updated time.
@@ -250,7 +248,6 @@ <h3>Method Details</h3>
       &quot;labels&quot;: { # 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
         &quot;a_key&quot;: &quot;A String&quot;,
       },
-      &quot;launchStage&quot;: &quot;A String&quot;, # Output only. Launch stage.
       &quot;logo&quot;: &quot;A String&quot;, # Optional. Logo of the resource.
       &quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name of the CustomConnector. Format: projects/{project}/locations/{location}/customConnectors/{connector}
       &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Updated time.
@@ -294,7 +291,6 @@ <h3>Method Details</h3>
   &quot;labels&quot;: { # 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
     &quot;a_key&quot;: &quot;A String&quot;,
   },
-  &quot;launchStage&quot;: &quot;A String&quot;, # Output only. Launch stage.
   &quot;logo&quot;: &quot;A String&quot;, # Optional. Logo of the resource.
   &quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name of the CustomConnector. Format: projects/{project}/locations/{location}/customConnectors/{connector}
   &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Updated time.

diff --git a/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html b/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html
@@ -445,6 +445,66 @@ <h3>Method Details</h3>
     &quot;enrichmentSupported&quot;: True or False, # Enrichment Supported.
     &quot;eventListenerType&quot;: &quot;A String&quot;, # The type of the event listener for a specific connector.
     &quot;isEventingSupported&quot;: True or False, # Is Eventing Supported.
+    &quot;listenerAuthConfigTemplates&quot;: [ # ListenerAuthConfigTemplates represents the auth values for the event listener.
+      { # AuthConfigTemplate defines required field over an authentication type.
+        &quot;authKey&quot;: &quot;A String&quot;, # Identifier key for auth config
+        &quot;authType&quot;: &quot;A String&quot;, # The type of authentication configured.
+        &quot;configVariableTemplates&quot;: [ # Config variables to describe an `AuthConfig` for a `Connection`.
+          { # ConfigVariableTemplate provides metadata about a `ConfigVariable` that is used in a Connection.
+            &quot;authorizationCodeLink&quot;: { # This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow. # Authorization code link options. To be populated if `ValueType` is `AUTHORIZATION_CODE`
+              &quot;clientId&quot;: &quot;A String&quot;, # The client ID assigned to the Google Cloud Connectors OAuth app for the connector data source.
+              &quot;enablePkce&quot;: True or False, # Whether to enable PKCE for the auth code flow.
+              &quot;scopes&quot;: [ # The scopes for which the user will authorize Google Cloud Connectors on the connector data source.
+                &quot;A String&quot;,
+              ],
+              &quot;uri&quot;: &quot;A String&quot;, # The base URI the user must click to trigger the authorization code login flow.
+            },
+            &quot;description&quot;: &quot;A String&quot;, # Description.
+            &quot;displayName&quot;: &quot;A String&quot;, # Display name of the parameter.
+            &quot;enumOptions&quot;: [ # Enum options. To be populated if `ValueType` is `ENUM`
+              { # EnumOption definition
+                &quot;displayName&quot;: &quot;A String&quot;, # Display name of the option.
+                &quot;id&quot;: &quot;A String&quot;, # Id of the option.
+              },
+            ],
+            &quot;isAdvanced&quot;: True or False, # Indicates if current template is part of advanced settings
+            &quot;key&quot;: &quot;A String&quot;, # Key of the config variable.
+            &quot;required&quot;: True or False, # Flag represents that this `ConfigVariable` must be provided for a connection.
+            &quot;requiredCondition&quot;: { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression.
+              &quot;fieldComparisons&quot;: [ # A list of fields to be compared.
+                { # Field that needs to be compared.
+                  &quot;boolValue&quot;: True or False, # Boolean value
+                  &quot;comparator&quot;: &quot;A String&quot;, # Comparator to use for comparing the field value.
+                  &quot;intValue&quot;: &quot;A String&quot;, # Integer value
+                  &quot;key&quot;: &quot;A String&quot;, # Key of the field.
+                  &quot;stringValue&quot;: &quot;A String&quot;, # String value
+                },
+              ],
+              &quot;logicalExpressions&quot;: [ # A list of nested conditions to be compared.
+                # Object with schema name: LogicalExpression
+              ],
+              &quot;logicalOperator&quot;: &quot;A String&quot;, # The logical operator to use between the fields and conditions.
+            },
+            &quot;roleGrant&quot;: { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular Google Cloud resource for the selected principal 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 &#x27;grant&#x27; button to do the same on behalf of the user. # Role grant configuration for the config variable.
+              &quot;helperTextTemplate&quot;: &quot;A String&quot;, # Template that UI can use to provide helper text to customers.
+              &quot;principal&quot;: &quot;A String&quot;, # Prinicipal/Identity for whom the role need to assigned.
+              &quot;resource&quot;: { # Resource definition # Resource on which the roles needs to be granted for the principal.
+                &quot;pathTemplate&quot;: &quot;A String&quot;, # Template to uniquely represent a Google Cloud resource in a format IAM expects This is a template that can have references to other values provided in the config variable template.
+                &quot;type&quot;: &quot;A String&quot;, # Different types of resource supported.
+              },
+              &quot;roles&quot;: [ # List of roles that need to be granted.
+                &quot;A String&quot;,
+              ],
+            },
+            &quot;state&quot;: &quot;A String&quot;, # State of the config variable.
+            &quot;validationRegex&quot;: &quot;A String&quot;, # Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`.
+            &quot;valueType&quot;: &quot;A String&quot;, # Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation.
+          },
+        ],
+        &quot;description&quot;: &quot;A String&quot;, # Connector specific description for an authentication template.
+        &quot;displayName&quot;: &quot;A String&quot;, # Display name for authentication template.
+      },
+    ],
     &quot;registrationDestinationConfig&quot;: { # DestinationConfigTemplate defines required destinations supported by the Connector. # Registration host destination config template.
       &quot;defaultPort&quot;: 42, # The default port.
       &quot;description&quot;: &quot;A String&quot;, # Description.
@@ -910,6 +970,66 @@ <h3>Method Details</h3>
         &quot;enrichmentSupported&quot;: True or False, # Enrichment Supported.
         &quot;eventListenerType&quot;: &quot;A String&quot;, # The type of the event listener for a specific connector.
         &quot;isEventingSupported&quot;: True or False, # Is Eventing Supported.
+        &quot;listenerAuthConfigTemplates&quot;: [ # ListenerAuthConfigTemplates represents the auth values for the event listener.
+          { # AuthConfigTemplate defines required field over an authentication type.
+            &quot;authKey&quot;: &quot;A String&quot;, # Identifier key for auth config
+            &quot;authType&quot;: &quot;A String&quot;, # The type of authentication configured.
+            &quot;configVariableTemplates&quot;: [ # Config variables to describe an `AuthConfig` for a `Connection`.
+              { # ConfigVariableTemplate provides metadata about a `ConfigVariable` that is used in a Connection.
+                &quot;authorizationCodeLink&quot;: { # This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow. # Authorization code link options. To be populated if `ValueType` is `AUTHORIZATION_CODE`
+                  &quot;clientId&quot;: &quot;A String&quot;, # The client ID assigned to the Google Cloud Connectors OAuth app for the connector data source.
+                  &quot;enablePkce&quot;: True or False, # Whether to enable PKCE for the auth code flow.
+                  &quot;scopes&quot;: [ # The scopes for which the user will authorize Google Cloud Connectors on the connector data source.
+                    &quot;A String&quot;,
+                  ],
+                  &quot;uri&quot;: &quot;A String&quot;, # The base URI the user must click to trigger the authorization code login flow.
+                },
+                &quot;description&quot;: &quot;A String&quot;, # Description.
+                &quot;displayName&quot;: &quot;A String&quot;, # Display name of the parameter.
+                &quot;enumOptions&quot;: [ # Enum options. To be populated if `ValueType` is `ENUM`
+                  { # EnumOption definition
+                    &quot;displayName&quot;: &quot;A String&quot;, # Display name of the option.
+                    &quot;id&quot;: &quot;A String&quot;, # Id of the option.
+                  },
+                ],
+                &quot;isAdvanced&quot;: True or False, # Indicates if current template is part of advanced settings
+                &quot;key&quot;: &quot;A String&quot;, # Key of the config variable.
+                &quot;required&quot;: True or False, # Flag represents that this `ConfigVariable` must be provided for a connection.
+                &quot;requiredCondition&quot;: { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression.
+                  &quot;fieldComparisons&quot;: [ # A list of fields to be compared.
+                    { # Field that needs to be compared.
+                      &quot;boolValue&quot;: True or False, # Boolean value
+                      &quot;comparator&quot;: &quot;A String&quot;, # Comparator to use for comparing the field value.
+                      &quot;intValue&quot;: &quot;A String&quot;, # Integer value
+                      &quot;key&quot;: &quot;A String&quot;, # Key of the field.
+                      &quot;stringValue&quot;: &quot;A String&quot;, # String value
+                    },
+                  ],
+                  &quot;logicalExpressions&quot;: [ # A list of nested conditions to be compared.
+                    # Object with schema name: LogicalExpression
+                  ],
+                  &quot;logicalOperator&quot;: &quot;A String&quot;, # The logical operator to use between the fields and conditions.
+                },
+                &quot;roleGrant&quot;: { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular Google Cloud resource for the selected principal 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 &#x27;grant&#x27; button to do the same on behalf of the user. # Role grant configuration for the config variable.
+                  &quot;helperTextTemplate&quot;: &quot;A String&quot;, # Template that UI can use to provide helper text to customers.
+                  &quot;principal&quot;: &quot;A String&quot;, # Prinicipal/Identity for whom the role need to assigned.
+                  &quot;resource&quot;: { # Resource definition # Resource on which the roles needs to be granted for the principal.
+                    &quot;pathTemplate&quot;: &quot;A String&quot;, # Template to uniquely represent a Google Cloud resource in a format IAM expects This is a template that can have references to other values provided in the config variable template.
+                    &quot;type&quot;: &quot;A String&quot;, # Different types of resource supported.
+                  },
+                  &quot;roles&quot;: [ # List of roles that need to be granted.
+                    &quot;A String&quot;,
+                  ],
+                },
+                &quot;state&quot;: &quot;A String&quot;, # State of the config variable.
+                &quot;validationRegex&quot;: &quot;A String&quot;, # Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`.
+                &quot;valueType&quot;: &quot;A String&quot;, # Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation.
+              },
+            ],
+            &quot;description&quot;: &quot;A String&quot;, # Connector specific description for an authentication template.
+            &quot;displayName&quot;: &quot;A String&quot;, # Display name for authentication template.
+          },
+        ],
         &quot;registrationDestinationConfig&quot;: { # DestinationConfigTemplate defines required destinations supported by the Connector. # Registration host destination config template.
           &quot;defaultPort&quot;: 42, # The default port.
           &quot;description&quot;: &quot;A String&quot;, # Description.