From 255dcdb1e6bbbca806a844fe2d863f00b290a0be Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 7 Dec 2023 15:10:31 +0000 Subject: [PATCH] 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) --- ...ors_v1.projects.locations.connections.html | 335 +++++++++++++++--- ...tomConnectors.customConnectorVersions.html | 8 +- ...ts.locations.global_.customConnectors.html | 4 - ...cations.providers.connectors.versions.html | 120 +++++++ .../documents/connectors.v1.json | 119 ++++--- .../documents/connectors.v2.json | 2 +- 6 files changed, 489 insertions(+), 99 deletions(-) diff --git a/docs/dyn/connectors_v1.projects.locations.connections.html b/docs/dyn/connectors_v1.projects.locations.connections.html index 7e561f8695..e938fd246f 100644 --- a/docs/dyn/connectors_v1.projects.locations.connections.html +++ b/docs/dyn/connectors_v1.projects.locations.connections.html @@ -118,6 +118,9 @@

Instance Methods

list_next()

Retrieves the next page of results.

+

+ listenEvent(resourcePath, body=None, x__xgafv=None)

+

ListenEvent listens to the event.

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates the parameters of a single Connection.

@@ -343,21 +346,73 @@

Method Details

"username": "A String", # Username. }, }, - "encryptionKey": { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig. # Encryption key (can be either Google managed or CMEK). - "boolValue": True or False, # Value is a bool. - "encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key. - "kmsKeyName": "A String", # The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed. - "type": "A String", # Type. + "enrichmentEnabled": True or False, # Enrichment Enabled. + "eventsListenerIngressEndpoint": "A String", # Optional. Ingress endpoint of the event listener. This is used only when private connectivity is enabled. + "listenerAuthConfig": { # AuthConfig defines details of a authentication type. # Optional. Auth details for the event listener. + "additionalVariables": [ # List containing additional auth configs. + { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig. + "boolValue": True or False, # Value is a bool. + "encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key. + "kmsKeyName": "A String", # The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed. + "type": "A String", # Type. + }, + "intValue": "A String", # Value is an integer + "key": "A String", # Key of the config variable. + "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "stringValue": "A String", # Value is a string. + }, + ], + "authKey": "A String", # Identifier key for auth config + "authType": "A String", # The type of authentication configured. + "oauth2AuthCodeFlow": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication. See https://www.rfc-editor.org/rfc/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlow. + "authCode": "A String", # Authorization code to be exchanged for access and refresh tokens. + "authUri": "A String", # Auth URL for Authorization Code Flow + "clientId": "A String", # Client ID for user-provided OAuth app. + "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Client secret for user-provided OAuth app. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "enablePkce": True or False, # Whether to enable PKCE when the user performs the auth code flow. + "pkceVerifier": "A String", # PKCE verifier to be used during the auth code exchange. + "redirectUri": "A String", # Redirect URI to be provided during the auth code exchange. + "scopes": [ # Scopes the connection will request when the user performs the auth code flow. + "A String", + ], }, - "intValue": "A String", # Value is an integer - "key": "A String", # Key of the config variable. - "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret. - "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + "oauth2ClientCredentials": { # Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2ClientCredentials. + "clientId": "A String", # The client identifier. + "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + }, + "oauth2JwtBearer": { # Parameters to support JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant based authentication. See https://tools.ietf.org/html/rfc7523 for more details. # Oauth2JwtBearer. + "clientKey": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing a PKCS#8 PEM-encoded private key associated with the Client Certificate. This private key will be used to sign JWTs used for the jwt-bearer authorization grant. Specified in the form as: `projects/*/secrets/*/versions/*`. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "jwtClaims": { # JWT claims used for the jwt-bearer authorization grant. # JwtClaims providers fields to generate the token. + "audience": "A String", # Value for the "aud" claim. + "issuer": "A String", # Value for the "iss" claim. + "subject": "A String", # Value for the "sub" claim. + }, + }, + "sshPublicKey": { # Parameters to support Ssh public key Authentication. # SSH Public Key. + "certType": "A String", # Format of SSH Client cert. + "sshClientCert": { # Secret provides a reference to entries in Secret Manager. # SSH Client Cert. It should contain both public and private key. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "sshClientCertPass": { # Secret provides a reference to entries in Secret Manager. # Password (passphrase) for ssh client certificate if it has one. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "username": "A String", # The user account used to authenticate. + }, + "userPassword": { # Parameters to support Username and Password Authentication. # UserPassword. + "password": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the password. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "username": "A String", # Username. }, - "stringValue": "A String", # Value is a string. }, - "enrichmentEnabled": True or False, # Enrichment Enabled. - "eventsListenerIngressEndpoint": "A String", # Optional. Ingress endpoint of the event listener. This is used only when private connectivity is enabled. "privateConnectivityEnabled": True or False, # Optional. Private Connectivity Enabled. "registrationDestinationConfig": { # Define the Connectors target endpoint. # Registration endpoint for auto registration. "destinations": [ # The destinations for the key. @@ -724,21 +779,73 @@

Method Details

"username": "A String", # Username. }, }, - "encryptionKey": { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig. # Encryption key (can be either Google managed or CMEK). - "boolValue": True or False, # Value is a bool. - "encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key. - "kmsKeyName": "A String", # The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed. - "type": "A String", # Type. + "enrichmentEnabled": True or False, # Enrichment Enabled. + "eventsListenerIngressEndpoint": "A String", # Optional. Ingress endpoint of the event listener. This is used only when private connectivity is enabled. + "listenerAuthConfig": { # AuthConfig defines details of a authentication type. # Optional. Auth details for the event listener. + "additionalVariables": [ # List containing additional auth configs. + { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig. + "boolValue": True or False, # Value is a bool. + "encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key. + "kmsKeyName": "A String", # The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed. + "type": "A String", # Type. + }, + "intValue": "A String", # Value is an integer + "key": "A String", # Key of the config variable. + "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "stringValue": "A String", # Value is a string. + }, + ], + "authKey": "A String", # Identifier key for auth config + "authType": "A String", # The type of authentication configured. + "oauth2AuthCodeFlow": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication. See https://www.rfc-editor.org/rfc/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlow. + "authCode": "A String", # Authorization code to be exchanged for access and refresh tokens. + "authUri": "A String", # Auth URL for Authorization Code Flow + "clientId": "A String", # Client ID for user-provided OAuth app. + "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Client secret for user-provided OAuth app. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "enablePkce": True or False, # Whether to enable PKCE when the user performs the auth code flow. + "pkceVerifier": "A String", # PKCE verifier to be used during the auth code exchange. + "redirectUri": "A String", # Redirect URI to be provided during the auth code exchange. + "scopes": [ # Scopes the connection will request when the user performs the auth code flow. + "A String", + ], }, - "intValue": "A String", # Value is an integer - "key": "A String", # Key of the config variable. - "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret. - "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + "oauth2ClientCredentials": { # Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2ClientCredentials. + "clientId": "A String", # The client identifier. + "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + }, + "oauth2JwtBearer": { # Parameters to support JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant based authentication. See https://tools.ietf.org/html/rfc7523 for more details. # Oauth2JwtBearer. + "clientKey": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing a PKCS#8 PEM-encoded private key associated with the Client Certificate. This private key will be used to sign JWTs used for the jwt-bearer authorization grant. Specified in the form as: `projects/*/secrets/*/versions/*`. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "jwtClaims": { # JWT claims used for the jwt-bearer authorization grant. # JwtClaims providers fields to generate the token. + "audience": "A String", # Value for the "aud" claim. + "issuer": "A String", # Value for the "iss" claim. + "subject": "A String", # Value for the "sub" claim. + }, + }, + "sshPublicKey": { # Parameters to support Ssh public key Authentication. # SSH Public Key. + "certType": "A String", # Format of SSH Client cert. + "sshClientCert": { # Secret provides a reference to entries in Secret Manager. # SSH Client Cert. It should contain both public and private key. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "sshClientCertPass": { # Secret provides a reference to entries in Secret Manager. # Password (passphrase) for ssh client certificate if it has one. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "username": "A String", # The user account used to authenticate. + }, + "userPassword": { # Parameters to support Username and Password Authentication. # UserPassword. + "password": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the password. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "username": "A String", # Username. }, - "stringValue": "A String", # Value is a string. }, - "enrichmentEnabled": True or False, # Enrichment Enabled. - "eventsListenerIngressEndpoint": "A String", # Optional. Ingress endpoint of the event listener. This is used only when private connectivity is enabled. "privateConnectivityEnabled": True or False, # Optional. Private Connectivity Enabled. "registrationDestinationConfig": { # Define the Connectors target endpoint. # Registration endpoint for auto registration. "destinations": [ # The destinations for the key. @@ -845,6 +952,7 @@

Method Details

"entities": [ # Output only. List of entity names. "A String", ], + "errorMessage": "A String", # Error message for users. "name": "A String", # Output only. Resource name. Format: projects/{project}/locations/{location}/connections/{connection}/connectionSchemaMetadata "refreshTime": "A String", # Output only. Timestamp when the connection runtime schema refresh was triggered. "state": "A String", # Output only. The current state of runtime schema. @@ -1123,21 +1231,73 @@

Method Details

"username": "A String", # Username. }, }, - "encryptionKey": { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig. # Encryption key (can be either Google managed or CMEK). - "boolValue": True or False, # Value is a bool. - "encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key. - "kmsKeyName": "A String", # The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed. - "type": "A String", # Type. + "enrichmentEnabled": True or False, # Enrichment Enabled. + "eventsListenerIngressEndpoint": "A String", # Optional. Ingress endpoint of the event listener. This is used only when private connectivity is enabled. + "listenerAuthConfig": { # AuthConfig defines details of a authentication type. # Optional. Auth details for the event listener. + "additionalVariables": [ # List containing additional auth configs. + { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig. + "boolValue": True or False, # Value is a bool. + "encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key. + "kmsKeyName": "A String", # The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed. + "type": "A String", # Type. + }, + "intValue": "A String", # Value is an integer + "key": "A String", # Key of the config variable. + "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "stringValue": "A String", # Value is a string. + }, + ], + "authKey": "A String", # Identifier key for auth config + "authType": "A String", # The type of authentication configured. + "oauth2AuthCodeFlow": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication. See https://www.rfc-editor.org/rfc/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlow. + "authCode": "A String", # Authorization code to be exchanged for access and refresh tokens. + "authUri": "A String", # Auth URL for Authorization Code Flow + "clientId": "A String", # Client ID for user-provided OAuth app. + "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Client secret for user-provided OAuth app. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "enablePkce": True or False, # Whether to enable PKCE when the user performs the auth code flow. + "pkceVerifier": "A String", # PKCE verifier to be used during the auth code exchange. + "redirectUri": "A String", # Redirect URI to be provided during the auth code exchange. + "scopes": [ # Scopes the connection will request when the user performs the auth code flow. + "A String", + ], }, - "intValue": "A String", # Value is an integer - "key": "A String", # Key of the config variable. - "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret. - "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + "oauth2ClientCredentials": { # Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2ClientCredentials. + "clientId": "A String", # The client identifier. + "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + }, + "oauth2JwtBearer": { # Parameters to support JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant based authentication. See https://tools.ietf.org/html/rfc7523 for more details. # Oauth2JwtBearer. + "clientKey": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing a PKCS#8 PEM-encoded private key associated with the Client Certificate. This private key will be used to sign JWTs used for the jwt-bearer authorization grant. Specified in the form as: `projects/*/secrets/*/versions/*`. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "jwtClaims": { # JWT claims used for the jwt-bearer authorization grant. # JwtClaims providers fields to generate the token. + "audience": "A String", # Value for the "aud" claim. + "issuer": "A String", # Value for the "iss" claim. + "subject": "A String", # Value for the "sub" claim. + }, + }, + "sshPublicKey": { # Parameters to support Ssh public key Authentication. # SSH Public Key. + "certType": "A String", # Format of SSH Client cert. + "sshClientCert": { # Secret provides a reference to entries in Secret Manager. # SSH Client Cert. It should contain both public and private key. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "sshClientCertPass": { # Secret provides a reference to entries in Secret Manager. # Password (passphrase) for ssh client certificate if it has one. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "username": "A String", # The user account used to authenticate. + }, + "userPassword": { # Parameters to support Username and Password Authentication. # UserPassword. + "password": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the password. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "username": "A String", # Username. }, - "stringValue": "A String", # Value is a string. }, - "enrichmentEnabled": True or False, # Enrichment Enabled. - "eventsListenerIngressEndpoint": "A String", # Optional. Ingress endpoint of the event listener. This is used only when private connectivity is enabled. "privateConnectivityEnabled": True or False, # Optional. Private Connectivity Enabled. "registrationDestinationConfig": { # Define the Connectors target endpoint. # Registration endpoint for auto registration. "destinations": [ # The destinations for the key. @@ -1243,6 +1403,33 @@

Method Details

+
+ listenEvent(resourcePath, body=None, x__xgafv=None) + 
ListenEvent listens to the event.
+
+Args:
+  resourcePath: string, Required. Resource path for request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Expected request for ListenEvent API.
+  "payload": { # Optional. Request payload.
+    "a_key": "", # Properties of the object.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Expected response for ListenEvent API.
+}
+
+
patch(name, body=None, updateMask=None, x__xgafv=None) 
Updates the parameters of a single Connection.
@@ -1450,21 +1637,73 @@ 
Method Details

         "username": "A String", # Username.
       },
     },
-    "encryptionKey": { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig. # Encryption key (can be either Google managed or CMEK).
-      "boolValue": True or False, # Value is a bool.
-      "encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key.
-        "kmsKeyName": "A String", # The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed.
-        "type": "A String", # Type.
+    "enrichmentEnabled": True or False, # Enrichment Enabled.
+    "eventsListenerIngressEndpoint": "A String", # Optional. Ingress endpoint of the event listener. This is used only when private connectivity is enabled.
+    "listenerAuthConfig": { # AuthConfig defines details of a authentication type. # Optional. Auth details for the event listener.
+      "additionalVariables": [ # List containing additional auth configs.
+        { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
+          "boolValue": True or False, # Value is a bool.
+          "encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key.
+            "kmsKeyName": "A String", # The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed.
+            "type": "A String", # Type.
+          },
+          "intValue": "A String", # Value is an integer
+          "key": "A String", # Key of the config variable.
+          "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
+            "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
+          },
+          "stringValue": "A String", # Value is a string.
+        },
+      ],
+      "authKey": "A String", # Identifier key for auth config
+      "authType": "A String", # The type of authentication configured.
+      "oauth2AuthCodeFlow": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication. See https://www.rfc-editor.org/rfc/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlow.
+        "authCode": "A String", # Authorization code to be exchanged for access and refresh tokens.
+        "authUri": "A String", # Auth URL for Authorization Code Flow
+        "clientId": "A String", # Client ID for user-provided OAuth app.
+        "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Client secret for user-provided OAuth app.
+          "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
+        },
+        "enablePkce": True or False, # Whether to enable PKCE when the user performs the auth code flow.
+        "pkceVerifier": "A String", # PKCE verifier to be used during the auth code exchange.
+        "redirectUri": "A String", # Redirect URI to be provided during the auth code exchange.
+        "scopes": [ # Scopes the connection will request when the user performs the auth code flow.
+          "A String",
+        ],
       },
-      "intValue": "A String", # Value is an integer
-      "key": "A String", # Key of the config variable.
-      "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
-        "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
+      "oauth2ClientCredentials": { # Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2ClientCredentials.
+        "clientId": "A String", # The client identifier.
+        "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret.
+          "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
+        },
+      },
+      "oauth2JwtBearer": { # Parameters to support JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant based authentication. See https://tools.ietf.org/html/rfc7523 for more details. # Oauth2JwtBearer.
+        "clientKey": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing a PKCS#8 PEM-encoded private key associated with the Client Certificate. This private key will be used to sign JWTs used for the jwt-bearer authorization grant. Specified in the form as: `projects/*/secrets/*/versions/*`.
+          "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
+        },
+        "jwtClaims": { # JWT claims used for the jwt-bearer authorization grant. # JwtClaims providers fields to generate the token.
+          "audience": "A String", # Value for the "aud" claim.
+          "issuer": "A String", # Value for the "iss" claim.
+          "subject": "A String", # Value for the "sub" claim.
+        },
+      },
+      "sshPublicKey": { # Parameters to support Ssh public key Authentication. # SSH Public Key.
+        "certType": "A String", # Format of SSH Client cert.
+        "sshClientCert": { # Secret provides a reference to entries in Secret Manager. # SSH Client Cert. It should contain both public and private key.
+          "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
+        },
+        "sshClientCertPass": { # Secret provides a reference to entries in Secret Manager. # Password (passphrase) for ssh client certificate if it has one.
+          "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
+        },
+        "username": "A String", # The user account used to authenticate.
+      },
+      "userPassword": { # Parameters to support Username and Password Authentication. # UserPassword.
+        "password": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the password.
+          "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
+        },
+        "username": "A String", # Username.
       },
-      "stringValue": "A String", # Value is a string.
     },
-    "enrichmentEnabled": True or False, # Enrichment Enabled.
-    "eventsListenerIngressEndpoint": "A String", # Optional. Ingress endpoint of the event listener. This is used only when private connectivity is enabled.
     "privateConnectivityEnabled": True or False, # Optional. Private Connectivity Enabled.
     "registrationDestinationConfig": { # Define the Connectors target endpoint. # Registration endpoint for auto registration.
       "destinations": [ # The destinations for the key.
diff --git a/docs/dyn/connectors_v1.projects.locations.global_.customConnectors.customConnectorVersions.html b/docs/dyn/connectors_v1.projects.locations.global_.customConnectors.customConnectorVersions.html
index 53ab5752be..55fbb3ce13 100644
--- a/docs/dyn/connectors_v1.projects.locations.global_.customConnectors.customConnectorVersions.html
+++ b/docs/dyn/connectors_v1.projects.locations.global_.customConnectors.customConnectorVersions.html
@@ -192,8 +192,8 @@ 
Method Details

     "a_key": "A String",
   },
   "name": "A String", # Output only. Identifier. Resource name of the Version. Format: projects/{project}/locations/{location}/customConnectors/{custom_connector}/customConnectorVersions/{custom_connector_version}
+  "serviceAccount": "A String", # Required. Service account needed for runtime plane to access Custom Connector secrets.
   "specLocation": "A String", # Optional. Location of the custom connector spec.
-  "type": "A String", # Required. Type of the customConnector.
   "updateTime": "A String", # Output only. Updated time.
 }
 
@@ -358,8 +358,8 @@ 
Method Details

     "a_key": "A String",
   },
   "name": "A String", # Output only. Identifier. Resource name of the Version. Format: projects/{project}/locations/{location}/customConnectors/{custom_connector}/customConnectorVersions/{custom_connector_version}
+  "serviceAccount": "A String", # Required. Service account needed for runtime plane to access Custom Connector secrets.
   "specLocation": "A String", # Optional. Location of the custom connector spec.
-  "type": "A String", # Required. Type of the customConnector.
   "updateTime": "A String", # Output only. Updated time.
 }
@@ -464,8 +464,8 @@

Method Details

"a_key": "A String", }, "name": "A String", # Output only. Identifier. Resource name of the Version. Format: projects/{project}/locations/{location}/customConnectors/{custom_connector}/customConnectorVersions/{custom_connector_version} + "serviceAccount": "A String", # Required. Service account needed for runtime plane to access Custom Connector secrets. "specLocation": "A String", # Optional. Location of the custom connector spec. - "type": "A String", # Required. Type of the customConnector. "updateTime": "A String", # Output only. Updated time. }, ], @@ -581,8 +581,8 @@

Method Details

"a_key": "A String", }, "name": "A String", # Output only. Identifier. Resource name of the Version. Format: projects/{project}/locations/{location}/customConnectors/{custom_connector}/customConnectorVersions/{custom_connector_version} + "serviceAccount": "A String", # Required. Service account needed for runtime plane to access Custom Connector secrets. "specLocation": "A String", # Optional. Location of the custom connector spec. - "type": "A String", # Required. Type of the customConnector. "updateTime": "A String", # 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 index eb9d3d52b8..6884830f21 100644 --- a/docs/dyn/connectors_v1.projects.locations.global_.customConnectors.html +++ b/docs/dyn/connectors_v1.projects.locations.global_.customConnectors.html @@ -123,7 +123,6 @@

Method Details

"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 "a_key": "A String", }, - "launchStage": "A String", # Output only. Launch stage. "logo": "A String", # Optional. Logo of the resource. "name": "A String", # Identifier. Resource name of the CustomConnector. Format: projects/{project}/locations/{location}/customConnectors/{connector} "updateTime": "A String", # Output only. Updated time. @@ -216,7 +215,6 @@

Method Details

"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 "a_key": "A String", }, - "launchStage": "A String", # Output only. Launch stage. "logo": "A String", # Optional. Logo of the resource. "name": "A String", # Identifier. Resource name of the CustomConnector. Format: projects/{project}/locations/{location}/customConnectors/{connector} "updateTime": "A String", # Output only. Updated time. @@ -250,7 +248,6 @@

Method Details

"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 "a_key": "A String", }, - "launchStage": "A String", # Output only. Launch stage. "logo": "A String", # Optional. Logo of the resource. "name": "A String", # Identifier. Resource name of the CustomConnector. Format: projects/{project}/locations/{location}/customConnectors/{connector} "updateTime": "A String", # Output only. Updated time. @@ -294,7 +291,6 @@

Method Details

"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 "a_key": "A String", }, - "launchStage": "A String", # Output only. Launch stage. "logo": "A String", # Optional. Logo of the resource. "name": "A String", # Identifier. Resource name of the CustomConnector. Format: projects/{project}/locations/{location}/customConnectors/{connector} "updateTime": "A String", # 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 index b1bc66442f..a9069eefd5 100644 --- 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 @@

Method Details

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

Method Details

"enrichmentSupported": True or False, # Enrichment Supported. "eventListenerType": "A String", # The type of the event listener for a specific connector. "isEventingSupported": True or False, # Is Eventing Supported. + "listenerAuthConfigTemplates": [ # ListenerAuthConfigTemplates represents the auth values for the event listener. + { # AuthConfigTemplate defines required field over an authentication type. + "authKey": "A String", # Identifier key for auth config + "authType": "A String", # The type of authentication configured. + "configVariableTemplates": [ # Config variables to describe an `AuthConfig` for a `Connection`. + { # ConfigVariableTemplate provides metadata about a `ConfigVariable` that is used in a Connection. + "authorizationCodeLink": { # 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` + "clientId": "A String", # The client ID assigned to the Google Cloud Connectors OAuth app for the connector data source. + "enablePkce": True or False, # Whether to enable PKCE for the auth code flow. + "scopes": [ # The scopes for which the user will authorize Google Cloud Connectors on the connector data source. + "A String", + ], + "uri": "A String", # The base URI the user must click to trigger the authorization code login flow. + }, + "description": "A String", # Description. + "displayName": "A String", # Display name of the parameter. + "enumOptions": [ # Enum options. To be populated if `ValueType` is `ENUM` + { # EnumOption definition + "displayName": "A String", # Display name of the option. + "id": "A String", # Id of the option. + }, + ], + "isAdvanced": True or False, # Indicates if current template is part of advanced settings + "key": "A String", # Key of the config variable. + "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. + "requiredCondition": { # 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. + "fieldComparisons": [ # A list of fields to be compared. + { # Field that needs to be compared. + "boolValue": True or False, # Boolean value + "comparator": "A String", # Comparator to use for comparing the field value. + "intValue": "A String", # Integer value + "key": "A String", # Key of the field. + "stringValue": "A String", # String value + }, + ], + "logicalExpressions": [ # A list of nested conditions to be compared. + # Object with schema name: LogicalExpression + ], + "logicalOperator": "A String", # The logical operator to use between the fields and conditions. + }, + "roleGrant": { # 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 'grant' button to do the same on behalf of the user. # Role grant configuration for the config variable. + "helperTextTemplate": "A String", # Template that UI can use to provide helper text to customers. + "principal": "A String", # Prinicipal/Identity for whom the role need to assigned. + "resource": { # Resource definition # Resource on which the roles needs to be granted for the principal. + "pathTemplate": "A String", # 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. + "type": "A String", # Different types of resource supported. + }, + "roles": [ # List of roles that need to be granted. + "A String", + ], + }, + "state": "A String", # State of the config variable. + "validationRegex": "A String", # Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`. + "valueType": "A String", # Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation. + }, + ], + "description": "A String", # Connector specific description for an authentication template. + "displayName": "A String", # Display name for authentication template. + }, + ], "registrationDestinationConfig": { # DestinationConfigTemplate defines required destinations supported by the Connector. # Registration host destination config template. "defaultPort": 42, # The default port. "description": "A String", # Description. diff --git a/googleapiclient/discovery_cache/documents/connectors.v1.json b/googleapiclient/discovery_cache/documents/connectors.v1.json index 9306d07ef8..843e001398 100644 --- a/googleapiclient/discovery_cache/documents/connectors.v1.json +++ b/googleapiclient/discovery_cache/documents/connectors.v1.json @@ -478,6 +478,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "listenEvent": { + "description": "ListenEvent listens to the event.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:listenEvent", + "httpMethod": "POST", + "id": "connectors.projects.locations.connections.listenEvent", + "parameterOrder": [ + "resourcePath" + ], + "parameters": { + "resourcePath": { + "description": "Required. Resource path for request.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resourcePath}:listenEvent", + "request": { + "$ref": "ListenEventRequest" + }, + "response": { + "$ref": "ListenEventResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "patch": { "description": "Updates the parameters of a single Connection.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}", @@ -2321,7 +2349,7 @@ } } }, - "revision": "20231106", + "revision": "20231126", "rootUrl": "https://connectors.googleapis.com/", "schemas": { "AuditConfig": { @@ -2395,7 +2423,8 @@ "OAUTH2_JWT_BEARER", "OAUTH2_CLIENT_CREDENTIALS", "SSH_PUBLIC_KEY", - "OAUTH2_AUTH_CODE_FLOW" + "OAUTH2_AUTH_CODE_FLOW", + "GOOGLE_AUTHENTICATION" ], "enumDescriptions": [ "Authentication type not specified.", @@ -2403,7 +2432,8 @@ "JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant based authentication", "Oauth 2.0 Client Credentials Grant Authentication", "SSH Public Key Authentication", - "Oauth 2.0 Authorization Code Flow" + "Oauth 2.0 Authorization Code Flow", + "Google authentication" ], "type": "string" }, @@ -2446,7 +2476,8 @@ "OAUTH2_JWT_BEARER", "OAUTH2_CLIENT_CREDENTIALS", "SSH_PUBLIC_KEY", - "OAUTH2_AUTH_CODE_FLOW" + "OAUTH2_AUTH_CODE_FLOW", + "GOOGLE_AUTHENTICATION" ], "enumDescriptions": [ "Authentication type not specified.", @@ -2454,7 +2485,8 @@ "JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant based authentication", "Oauth 2.0 Client Credentials Grant Authentication", "SSH Public Key Authentication", - "Oauth 2.0 Authorization Code Flow" + "Oauth 2.0 Authorization Code Flow", + "Google authentication" ], "type": "string" }, @@ -2844,6 +2876,10 @@ "readOnly": true, "type": "array" }, + "errorMessage": { + "description": "Error message for users.", + "type": "string" + }, "name": { "description": "Output only. Resource name. Format: projects/{project}/locations/{location}/connections/{connection}/connectionSchemaMetadata", "readOnly": true, @@ -3279,25 +3315,6 @@ "description": "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", "type": "object" }, - "launchStage": { - "description": "Output only. Launch stage.", - "enum": [ - "LAUNCH_STAGE_UNSPECIFIED", - "PREVIEW", - "GA", - "DEPRECATED", - "PRIVATE_PREVIEW" - ], - "enumDescriptions": [ - "LAUNCH_STAGE_UNSPECIFIED.", - "PREVIEW.", - "GA.", - "DEPRECATED.", - "PRIVATE_PREVIEW." - ], - "readOnly": true, - "type": "string" - }, "logo": { "description": "Optional. Logo of the resource.", "type": "string" @@ -3349,22 +3366,12 @@ "readOnly": true, "type": "string" }, - "specLocation": { - "description": "Optional. Location of the custom connector spec.", + "serviceAccount": { + "description": "Required. Service account needed for runtime plane to access Custom Connector secrets.", "type": "string" }, - "type": { - "description": "Required. Type of the customConnector.", - "enum": [ - "CUSTOM_CONNECTOR_TYPE_UNSPECIFIED", - "OPEN_API", - "PROTO" - ], - "enumDescriptions": [ - "Connector type is not specified.", - "OpenAPI connector.", - "Proto connector." - ], + "specLocation": { + "description": "Optional. Location of the custom connector spec.", "type": "string" }, "updateTime": { @@ -3791,10 +3798,6 @@ "$ref": "AuthConfig", "description": "Auth details for the webhook adapter." }, - "encryptionKey": { - "$ref": "ConfigVariable", - "description": "Encryption key (can be either Google managed or CMEK)." - }, "enrichmentEnabled": { "description": "Enrichment Enabled.", "type": "boolean" @@ -3803,6 +3806,10 @@ "description": "Optional. Ingress endpoint of the event listener. This is used only when private connectivity is enabled.", "type": "string" }, + "listenerAuthConfig": { + "$ref": "AuthConfig", + "description": "Optional. Auth details for the event listener." + }, "privateConnectivityEnabled": { "description": "Optional. Private Connectivity Enabled.", "type": "boolean" @@ -3866,6 +3873,13 @@ "description": "Is Eventing Supported.", "type": "boolean" }, + "listenerAuthConfigTemplates": { + "description": "ListenerAuthConfigTemplates represents the auth values for the event listener.", + "items": { + "$ref": "AuthConfigTemplate" + }, + "type": "array" + }, "registrationDestinationConfig": { "$ref": "DestinationConfigTemplate", "description": "Registration host destination config template." @@ -5066,6 +5080,27 @@ }, "type": "object" }, + "ListenEventRequest": { + "description": "Expected request for ListenEvent API.", + "id": "ListenEventRequest", + "properties": { + "payload": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Request payload.", + "type": "object" + } + }, + "type": "object" + }, + "ListenEventResponse": { + "description": "Expected response for ListenEvent API.", + "id": "ListenEventResponse", + "properties": {}, + "type": "object" + }, "Location": { "description": "A resource that represents a Google Cloud location.", "id": "Location", diff --git a/googleapiclient/discovery_cache/documents/connectors.v2.json b/googleapiclient/discovery_cache/documents/connectors.v2.json index 0f2577fe3c..1f23a4407c 100644 --- a/googleapiclient/discovery_cache/documents/connectors.v2.json +++ b/googleapiclient/discovery_cache/documents/connectors.v2.json @@ -558,7 +558,7 @@ } } }, - "revision": "20231106", + "revision": "20231126", "rootUrl": "https://connectors.googleapis.com/", "schemas": { "Action": {