Returns the connectionSchemaMetadata Resource.
Returns the eventSubscriptions Resource.
Returns the runtimeActionSchemas Resource.
Returns the runtimeEntitySchemas Resource.
Close httplib2 connections.
create(parent, body=None, connectionId=None, x__xgafv=None)
Creates a new Connection in a given project and location.
Deletes a single Connection.
get(name, view=None, x__xgafv=None)
Gets details of a single Connection.
getConnectionSchemaMetadata(name, x__xgafv=None)
Gets schema metadata of a connection. SchemaMetadata is a singleton resource for each connection.
getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)
Lists Connections in a given project and location.
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.
repairEventing(name, body=None, x__xgafv=None)
RepaiEventing tries to repair eventing related event subscriptions.
search(name, pageSize=None, pageToken=None, query=None, x__xgafv=None)
Returns Top matching Connections for a given query.
Retrieves the next page of results.
setIamPolicy(resource, body=None, x__xgafv=None)
Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
testIamPermissions(resource, body=None, x__xgafv=None)
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
close()
Close httplib2 connections.
create(parent, body=None, connectionId=None, x__xgafv=None)
Creates a new Connection in a given project and location.
Args:
parent: string, Required. Parent resource of the Connection, of the form: `projects/*/locations/*` (required)
body: object, The request body.
The object takes the form of:
{ # Connection represents an instance of connector.
"asyncOperationsEnabled": True or False, # 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.
"authConfig": { # AuthConfig defines details of a authentication type. # Optional. Configuration for establishing the connection's authentication with an external system.
"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",
],
},
"oauth2AuthCodeFlowGoogleManaged": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlowGoogleManaged.
"authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens.
"redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange.
"scopes": [ # Required. Scopes the connection will request when the user performs the auth code flow.
"A String",
],
},
"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.
},
},
"authOverrideEnabled": True or False, # 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": { # Billing config for the connection. # Output only. Billing config for the connection.
"billingCategory": "A String", # Output only. Billing category for the connector.
},
"configVariables": [ # Optional. Configuration for configuring the connection with an external system.
{ # 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.
},
],
"connectionRevision": "A String", # Output only. Connection revision. This field is only updated when the connection is created or updated by User.
"connectorVersion": "A String", # 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.
"connectorVersionInfraConfig": { # This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version # Output only. Infra configs supported by Connector Version.
"connectionRatelimitWindowSeconds": "A String", # Output only. The window used for ratelimiting runtime requests to connections.
"deploymentModel": "A String", # Optional. Indicates whether connector is deployed on GKE/CloudRun
"deploymentModelMigrationState": "A String", # Output only. Status of the deployment model migration.
"hpaConfig": { # Autoscaling config for connector deployment system metrics. # Output only. HPA autoscaling config.
"cpuUtilizationThreshold": "A String", # Output only. Percent CPU utilization where HPA triggers autoscaling.
"memoryUtilizationThreshold": "A String", # Output only. Percent Memory utilization where HPA triggers autoscaling.
},
"internalclientRatelimitThreshold": "A String", # Output only. Max QPS supported for internal requests originating from Connd.
"maxInstanceRequestConcurrency": 42, # Output only. Max instance request concurrency.
"ratelimitThreshold": "A String", # Output only. Max QPS supported by the connector version before throttling of requests.
"resourceLimits": { # Resource limits defined for connection pods of a given connector type. # Output only. System resource limits.
"cpu": "A String", # Output only. CPU limit.
"memory": "A String", # Output only. Memory limit.
},
"resourceRequests": { # Resource requests defined for connection pods of a given connector type. # Output only. System resource requests.
"cpu": "A String", # Output only. CPU request.
"memory": "A String", # Output only. Memory request.
},
"sharedDeployment": "A String", # Output only. The name of shared connector deployment.
"tlsMigrationState": "A String", # Output only. Status of the TLS migration.
},
"connectorVersionLaunchStage": "A String", # Output only. Flag to mark the version indicating the launch stage.
"createTime": "A String", # Output only. Created time.
"description": "A String", # Optional. Description of the resource.
"destinationConfigs": [ # Optional. Configuration of the Connector's destination. Only accepted for Connectors that accepts user defined destination(s).
{ # Define the Connectors target endpoint.
"destinations": [ # The destinations for the key.
{
"host": "A String", # For publicly routable host.
"port": 42, # The port is the target port number that is accepted by the destination.
"serviceAttachment": "A String", # PSC service attachments. Format: projects/*/regions/*/serviceAttachments/*
},
],
"key": "A String", # The key is the destination identifier that is supported by the Connector.
},
],
"envoyImageLocation": "A String", # Output only. GCR location where the envoy image is stored. formatted like: gcr.io/{bucketName}/{imageName}
"eventingConfig": { # Eventing Configuration of a connection # Optional. Eventing config of a connection
"additionalVariables": [ # Additional eventing related field values
{ # 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.
},
],
"authConfig": { # AuthConfig defines details of a authentication type. # Auth details for the webhook adapter.
"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",
],
},
"oauth2AuthCodeFlowGoogleManaged": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlowGoogleManaged.
"authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens.
"redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange.
"scopes": [ # Required. Scopes the connection will request when the user performs the auth code flow.
"A String",
],
},
"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.
},
},
"deadLetterConfig": { # Dead Letter configuration details provided by the user. # Optional. Dead letter configuration for eventing of a connection.
"projectId": "A String", # Optional. Project which has the topic given.
"topic": "A String", # Optional. Topic to push events which couldn't be processed.
},
"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",
],
},
"oauth2AuthCodeFlowGoogleManaged": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlowGoogleManaged.
"authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens.
"redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange.
"scopes": [ # Required. Scopes the connection will request when the user performs the auth code flow.
"A String",
],
},
"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.
},
},
"privateConnectivityEnabled": True or False, # Optional. Private Connectivity Enabled.
"proxyDestinationConfig": { # Define the Connectors target endpoint. # Optional. Proxy for Eventing auto-registration.
"destinations": [ # The destinations for the key.
{
"host": "A String", # For publicly routable host.
"port": 42, # The port is the target port number that is accepted by the destination.
"serviceAttachment": "A String", # PSC service attachments. Format: projects/*/regions/*/serviceAttachments/*
},
],
"key": "A String", # The key is the destination identifier that is supported by the Connector.
},
"registrationDestinationConfig": { # Define the Connectors target endpoint. # Registration endpoint for auto registration.
"destinations": [ # The destinations for the key.
{
"host": "A String", # For publicly routable host.
"port": 42, # The port is the target port number that is accepted by the destination.
"serviceAttachment": "A String", # PSC service attachments. Format: projects/*/regions/*/serviceAttachments/*
},
],
"key": "A String", # The key is the destination identifier that is supported by the Connector.
},
},
"eventingEnablementType": "A String", # Optional. Eventing enablement type. Will be nil if eventing is not enabled.
"eventingRuntimeData": { # Eventing runtime data has the details related to eventing managed by the system. # Output only. Eventing Runtime Data.
"eventsListenerEndpoint": "A String", # Output only. Events listener endpoint. The value will populated after provisioning the events listener.
"eventsListenerPscSa": "A String", # Output only. Events listener PSC Service attachment. The value will be populated after provisioning the events listener with private connectivity enabled.
"status": { # EventingStatus indicates the state of eventing. # Output only. Current status of eventing.
"description": "A String", # Output only. Description of error if State is set to "ERROR".
"state": "A String", # Output only. State.
},
"webhookData": { # WebhookData has details of webhook configuration. # Output only. Webhook data.
"additionalVariables": [ # Output only. Additional webhook related field values.
{ # 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.
},
],
"createTime": "A String", # Output only. Timestamp when the webhook was created.
"id": "A String", # Output only. ID to uniquely identify webhook.
"name": "A String", # Output only. Name of the Webhook
"nextRefreshTime": "A String", # Output only. Next webhook refresh time. Will be null if refresh is not supported.
"updateTime": "A String", # Output only. Timestamp when the webhook was last updated.
},
"webhookSubscriptions": { # WebhookSubscriptions has details of webhook subscriptions. # Output only. Webhook subscriptions.
"webhookData": [ # Output only. Webhook data.
{ # WebhookData has details of webhook configuration.
"additionalVariables": [ # Output only. Additional webhook related field values.
{ # 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.
},
],
"createTime": "A String", # Output only. Timestamp when the webhook was created.
"id": "A String", # Output only. ID to uniquely identify webhook.
"name": "A String", # Output only. Name of the Webhook
"nextRefreshTime": "A String", # Output only. Next webhook refresh time. Will be null if refresh is not supported.
"updateTime": "A String", # Output only. Timestamp when the webhook was last updated.
},
],
},
},
"host": "A String", # Output only. The name of the Hostname of the Service Directory service with TLS.
"imageLocation": "A String", # Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName}
"isTrustedTester": True or False, # Output only. Is trusted tester program enabled for the project.
"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",
},
"lockConfig": { # Determines whether or no a connection is locked. If locked, a reason must be specified. # Optional. Configuration that indicates whether or not the Connection can be edited.
"locked": True or False, # Indicates whether or not the connection is locked.
"reason": "A String", # Describes why a connection is locked.
},
"logConfig": { # Log configuration for the connection. # Optional. Log configuration for the connection.
"enabled": True or False, # Enabled represents whether logging is enabled or not for a connection.
"level": "A String", # Optional. Log configuration level.
},
"name": "A String", # Output only. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection}
"nodeConfig": { # Node configuration for the connection. # Optional. Node configuration for the connection.
"maxNodeCount": 42, # Maximum number of nodes in the runtime nodes.
"minNodeCount": 42, # Minimum number of nodes in the runtime nodes.
},
"serviceAccount": "A String", # Optional. Service account needed for runtime plane to access Google Cloud resources.
"serviceDirectory": "A String", # 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"
"sslConfig": { # SSL Configuration of a connection # Optional. Ssl config of a connection
"additionalVariables": [ # Additional SSL related field values
{ # 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.
},
],
"clientCertType": "A String", # Type of Client Cert (PEM/JKS/.. etc.)
"clientCertificate": { # Secret provides a reference to entries in Secret Manager. # Client Certificate
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"clientPrivateKey": { # Secret provides a reference to entries in Secret Manager. # Client Private Key
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"clientPrivateKeyPass": { # Secret provides a reference to entries in Secret Manager. # Secret containing the passphrase protecting the Client Private Key
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"privateServerCertificate": { # Secret provides a reference to entries in Secret Manager. # Private Server Certificate. Needs to be specified if trust model is `PRIVATE`.
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"serverCertType": "A String", # Type of Server Cert (PEM/JKS/.. etc.)
"trustModel": "A String", # Trust Model of the SSL connection
"type": "A String", # Controls the ssl type for the given connector version.
"useSsl": True or False, # Bool for enabling SSL
},
"status": { # ConnectionStatus indicates the state of the connection. # Output only. Current status of the connection.
"description": "A String", # Description.
"state": "A String", # State.
"status": "A String", # Status provides detailed information for the state.
},
"subscriptionType": "A String", # Output only. This subscription type enum states the subscription type of the project.
"suspended": True or False, # Optional. Suspended indicates if a user has suspended a connection or not.
"tlsServiceDirectory": "A String", # Output only. The name of the Service Directory service with TLS.
"updateTime": "A String", # Output only. Updated time.
}
connectionId: string, Required. Identifier to assign to the Connection. Must be unique within scope of the parent resource.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
delete(name, x__xgafv=None)
Deletes a single Connection.
Args:
name: string, Required. Resource name of the form: `projects/*/locations/*/connections/*` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
get(name, view=None, x__xgafv=None)
Gets details of a single Connection.
Args:
name: string, Required. Resource name of the form: `projects/*/locations/*/connections/*` (required)
view: string, Specifies which fields of the Connection are returned in the response. Defaults to `BASIC` view.
Allowed values
CONNECTION_VIEW_UNSPECIFIED - CONNECTION_UNSPECIFIED.
BASIC - Do not include runtime required configs.
FULL - Include runtime required configs.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Connection represents an instance of connector.
"asyncOperationsEnabled": True or False, # 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.
"authConfig": { # AuthConfig defines details of a authentication type. # Optional. Configuration for establishing the connection's authentication with an external system.
"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",
],
},
"oauth2AuthCodeFlowGoogleManaged": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlowGoogleManaged.
"authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens.
"redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange.
"scopes": [ # Required. Scopes the connection will request when the user performs the auth code flow.
"A String",
],
},
"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.
},
},
"authOverrideEnabled": True or False, # 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": { # Billing config for the connection. # Output only. Billing config for the connection.
"billingCategory": "A String", # Output only. Billing category for the connector.
},
"configVariables": [ # Optional. Configuration for configuring the connection with an external system.
{ # 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.
},
],
"connectionRevision": "A String", # Output only. Connection revision. This field is only updated when the connection is created or updated by User.
"connectorVersion": "A String", # 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.
"connectorVersionInfraConfig": { # This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version # Output only. Infra configs supported by Connector Version.
"connectionRatelimitWindowSeconds": "A String", # Output only. The window used for ratelimiting runtime requests to connections.
"deploymentModel": "A String", # Optional. Indicates whether connector is deployed on GKE/CloudRun
"deploymentModelMigrationState": "A String", # Output only. Status of the deployment model migration.
"hpaConfig": { # Autoscaling config for connector deployment system metrics. # Output only. HPA autoscaling config.
"cpuUtilizationThreshold": "A String", # Output only. Percent CPU utilization where HPA triggers autoscaling.
"memoryUtilizationThreshold": "A String", # Output only. Percent Memory utilization where HPA triggers autoscaling.
},
"internalclientRatelimitThreshold": "A String", # Output only. Max QPS supported for internal requests originating from Connd.
"maxInstanceRequestConcurrency": 42, # Output only. Max instance request concurrency.
"ratelimitThreshold": "A String", # Output only. Max QPS supported by the connector version before throttling of requests.
"resourceLimits": { # Resource limits defined for connection pods of a given connector type. # Output only. System resource limits.
"cpu": "A String", # Output only. CPU limit.
"memory": "A String", # Output only. Memory limit.
},
"resourceRequests": { # Resource requests defined for connection pods of a given connector type. # Output only. System resource requests.
"cpu": "A String", # Output only. CPU request.
"memory": "A String", # Output only. Memory request.
},
"sharedDeployment": "A String", # Output only. The name of shared connector deployment.
"tlsMigrationState": "A String", # Output only. Status of the TLS migration.
},
"connectorVersionLaunchStage": "A String", # Output only. Flag to mark the version indicating the launch stage.
"createTime": "A String", # Output only. Created time.
"description": "A String", # Optional. Description of the resource.
"destinationConfigs": [ # Optional. Configuration of the Connector's destination. Only accepted for Connectors that accepts user defined destination(s).
{ # Define the Connectors target endpoint.
"destinations": [ # The destinations for the key.
{
"host": "A String", # For publicly routable host.
"port": 42, # The port is the target port number that is accepted by the destination.
"serviceAttachment": "A String", # PSC service attachments. Format: projects/*/regions/*/serviceAttachments/*
},
],
"key": "A String", # The key is the destination identifier that is supported by the Connector.
},
],
"envoyImageLocation": "A String", # Output only. GCR location where the envoy image is stored. formatted like: gcr.io/{bucketName}/{imageName}
"eventingConfig": { # Eventing Configuration of a connection # Optional. Eventing config of a connection
"additionalVariables": [ # Additional eventing related field values
{ # 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.
},
],
"authConfig": { # AuthConfig defines details of a authentication type. # Auth details for the webhook adapter.
"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",
],
},
"oauth2AuthCodeFlowGoogleManaged": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlowGoogleManaged.
"authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens.
"redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange.
"scopes": [ # Required. Scopes the connection will request when the user performs the auth code flow.
"A String",
],
},
"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.
},
},
"deadLetterConfig": { # Dead Letter configuration details provided by the user. # Optional. Dead letter configuration for eventing of a connection.
"projectId": "A String", # Optional. Project which has the topic given.
"topic": "A String", # Optional. Topic to push events which couldn't be processed.
},
"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",
],
},
"oauth2AuthCodeFlowGoogleManaged": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlowGoogleManaged.
"authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens.
"redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange.
"scopes": [ # Required. Scopes the connection will request when the user performs the auth code flow.
"A String",
],
},
"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.
},
},
"privateConnectivityEnabled": True or False, # Optional. Private Connectivity Enabled.
"proxyDestinationConfig": { # Define the Connectors target endpoint. # Optional. Proxy for Eventing auto-registration.
"destinations": [ # The destinations for the key.
{
"host": "A String", # For publicly routable host.
"port": 42, # The port is the target port number that is accepted by the destination.
"serviceAttachment": "A String", # PSC service attachments. Format: projects/*/regions/*/serviceAttachments/*
},
],
"key": "A String", # The key is the destination identifier that is supported by the Connector.
},
"registrationDestinationConfig": { # Define the Connectors target endpoint. # Registration endpoint for auto registration.
"destinations": [ # The destinations for the key.
{
"host": "A String", # For publicly routable host.
"port": 42, # The port is the target port number that is accepted by the destination.
"serviceAttachment": "A String", # PSC service attachments. Format: projects/*/regions/*/serviceAttachments/*
},
],
"key": "A String", # The key is the destination identifier that is supported by the Connector.
},
},
"eventingEnablementType": "A String", # Optional. Eventing enablement type. Will be nil if eventing is not enabled.
"eventingRuntimeData": { # Eventing runtime data has the details related to eventing managed by the system. # Output only. Eventing Runtime Data.
"eventsListenerEndpoint": "A String", # Output only. Events listener endpoint. The value will populated after provisioning the events listener.
"eventsListenerPscSa": "A String", # Output only. Events listener PSC Service attachment. The value will be populated after provisioning the events listener with private connectivity enabled.
"status": { # EventingStatus indicates the state of eventing. # Output only. Current status of eventing.
"description": "A String", # Output only. Description of error if State is set to "ERROR".
"state": "A String", # Output only. State.
},
"webhookData": { # WebhookData has details of webhook configuration. # Output only. Webhook data.
"additionalVariables": [ # Output only. Additional webhook related field values.
{ # 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.
},
],
"createTime": "A String", # Output only. Timestamp when the webhook was created.
"id": "A String", # Output only. ID to uniquely identify webhook.
"name": "A String", # Output only. Name of the Webhook
"nextRefreshTime": "A String", # Output only. Next webhook refresh time. Will be null if refresh is not supported.
"updateTime": "A String", # Output only. Timestamp when the webhook was last updated.
},
"webhookSubscriptions": { # WebhookSubscriptions has details of webhook subscriptions. # Output only. Webhook subscriptions.
"webhookData": [ # Output only. Webhook data.
{ # WebhookData has details of webhook configuration.
"additionalVariables": [ # Output only. Additional webhook related field values.
{ # 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.
},
],
"createTime": "A String", # Output only. Timestamp when the webhook was created.
"id": "A String", # Output only. ID to uniquely identify webhook.
"name": "A String", # Output only. Name of the Webhook
"nextRefreshTime": "A String", # Output only. Next webhook refresh time. Will be null if refresh is not supported.
"updateTime": "A String", # Output only. Timestamp when the webhook was last updated.
},
],
},
},
"host": "A String", # Output only. The name of the Hostname of the Service Directory service with TLS.
"imageLocation": "A String", # Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName}
"isTrustedTester": True or False, # Output only. Is trusted tester program enabled for the project.
"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",
},
"lockConfig": { # Determines whether or no a connection is locked. If locked, a reason must be specified. # Optional. Configuration that indicates whether or not the Connection can be edited.
"locked": True or False, # Indicates whether or not the connection is locked.
"reason": "A String", # Describes why a connection is locked.
},
"logConfig": { # Log configuration for the connection. # Optional. Log configuration for the connection.
"enabled": True or False, # Enabled represents whether logging is enabled or not for a connection.
"level": "A String", # Optional. Log configuration level.
},
"name": "A String", # Output only. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection}
"nodeConfig": { # Node configuration for the connection. # Optional. Node configuration for the connection.
"maxNodeCount": 42, # Maximum number of nodes in the runtime nodes.
"minNodeCount": 42, # Minimum number of nodes in the runtime nodes.
},
"serviceAccount": "A String", # Optional. Service account needed for runtime plane to access Google Cloud resources.
"serviceDirectory": "A String", # 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"
"sslConfig": { # SSL Configuration of a connection # Optional. Ssl config of a connection
"additionalVariables": [ # Additional SSL related field values
{ # 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.
},
],
"clientCertType": "A String", # Type of Client Cert (PEM/JKS/.. etc.)
"clientCertificate": { # Secret provides a reference to entries in Secret Manager. # Client Certificate
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"clientPrivateKey": { # Secret provides a reference to entries in Secret Manager. # Client Private Key
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"clientPrivateKeyPass": { # Secret provides a reference to entries in Secret Manager. # Secret containing the passphrase protecting the Client Private Key
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"privateServerCertificate": { # Secret provides a reference to entries in Secret Manager. # Private Server Certificate. Needs to be specified if trust model is `PRIVATE`.
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"serverCertType": "A String", # Type of Server Cert (PEM/JKS/.. etc.)
"trustModel": "A String", # Trust Model of the SSL connection
"type": "A String", # Controls the ssl type for the given connector version.
"useSsl": True or False, # Bool for enabling SSL
},
"status": { # ConnectionStatus indicates the state of the connection. # Output only. Current status of the connection.
"description": "A String", # Description.
"state": "A String", # State.
"status": "A String", # Status provides detailed information for the state.
},
"subscriptionType": "A String", # Output only. This subscription type enum states the subscription type of the project.
"suspended": True or False, # Optional. Suspended indicates if a user has suspended a connection or not.
"tlsServiceDirectory": "A String", # Output only. The name of the Service Directory service with TLS.
"updateTime": "A String", # Output only. Updated time.
}
getConnectionSchemaMetadata(name, x__xgafv=None)
Gets schema metadata of a connection. SchemaMetadata is a singleton resource for each connection.
Args:
name: string, Required. Connection name Format: projects/{project}/locations/{location}/connections/{connection}/connectionSchemaMetadata (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # ConnectionSchemaMetadata is the singleton resource of each connection. It includes the entity and action names of runtime resources exposed by a connection backend.
"actions": [ # Output only. List of actions.
"A String",
],
"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.
"updateTime": "A String", # Output only. Timestamp when the connection runtime schema was updated.
}
getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Args:
resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
"auditLogConfigs": [ # The configuration for logging of each type of permission.
{ # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
"A String",
],
"logType": "A String", # The log type that this config enables.
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
},
],
"bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
{ # Associates `members`, or principals, with a `role`.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
},
"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
"A String",
],
"role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
},
],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
}
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)
Lists Connections in a given project and location.
Args:
parent: string, Required. Parent resource of the Connection, of the form: `projects/*/locations/*` (required)
filter: string, Filter.
orderBy: string, Order by parameters.
pageSize: integer, Page size.
pageToken: string, Page token.
view: string, Specifies which fields of the Connection are returned in the response. Defaults to `BASIC` view.
Allowed values
CONNECTION_VIEW_UNSPECIFIED - CONNECTION_UNSPECIFIED.
BASIC - Do not include runtime required configs.
FULL - Include runtime required configs.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for ConnectorsService.ListConnections
"connections": [ # Connections.
{ # Connection represents an instance of connector.
"asyncOperationsEnabled": True or False, # 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.
"authConfig": { # AuthConfig defines details of a authentication type. # Optional. Configuration for establishing the connection's authentication with an external system.
"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",
],
},
"oauth2AuthCodeFlowGoogleManaged": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlowGoogleManaged.
"authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens.
"redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange.
"scopes": [ # Required. Scopes the connection will request when the user performs the auth code flow.
"A String",
],
},
"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.
},
},
"authOverrideEnabled": True or False, # 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": { # Billing config for the connection. # Output only. Billing config for the connection.
"billingCategory": "A String", # Output only. Billing category for the connector.
},
"configVariables": [ # Optional. Configuration for configuring the connection with an external system.
{ # 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.
},
],
"connectionRevision": "A String", # Output only. Connection revision. This field is only updated when the connection is created or updated by User.
"connectorVersion": "A String", # 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.
"connectorVersionInfraConfig": { # This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version # Output only. Infra configs supported by Connector Version.
"connectionRatelimitWindowSeconds": "A String", # Output only. The window used for ratelimiting runtime requests to connections.
"deploymentModel": "A String", # Optional. Indicates whether connector is deployed on GKE/CloudRun
"deploymentModelMigrationState": "A String", # Output only. Status of the deployment model migration.
"hpaConfig": { # Autoscaling config for connector deployment system metrics. # Output only. HPA autoscaling config.
"cpuUtilizationThreshold": "A String", # Output only. Percent CPU utilization where HPA triggers autoscaling.
"memoryUtilizationThreshold": "A String", # Output only. Percent Memory utilization where HPA triggers autoscaling.
},
"internalclientRatelimitThreshold": "A String", # Output only. Max QPS supported for internal requests originating from Connd.
"maxInstanceRequestConcurrency": 42, # Output only. Max instance request concurrency.
"ratelimitThreshold": "A String", # Output only. Max QPS supported by the connector version before throttling of requests.
"resourceLimits": { # Resource limits defined for connection pods of a given connector type. # Output only. System resource limits.
"cpu": "A String", # Output only. CPU limit.
"memory": "A String", # Output only. Memory limit.
},
"resourceRequests": { # Resource requests defined for connection pods of a given connector type. # Output only. System resource requests.
"cpu": "A String", # Output only. CPU request.
"memory": "A String", # Output only. Memory request.
},
"sharedDeployment": "A String", # Output only. The name of shared connector deployment.
"tlsMigrationState": "A String", # Output only. Status of the TLS migration.
},
"connectorVersionLaunchStage": "A String", # Output only. Flag to mark the version indicating the launch stage.
"createTime": "A String", # Output only. Created time.
"description": "A String", # Optional. Description of the resource.
"destinationConfigs": [ # Optional. Configuration of the Connector's destination. Only accepted for Connectors that accepts user defined destination(s).
{ # Define the Connectors target endpoint.
"destinations": [ # The destinations for the key.
{
"host": "A String", # For publicly routable host.
"port": 42, # The port is the target port number that is accepted by the destination.
"serviceAttachment": "A String", # PSC service attachments. Format: projects/*/regions/*/serviceAttachments/*
},
],
"key": "A String", # The key is the destination identifier that is supported by the Connector.
},
],
"envoyImageLocation": "A String", # Output only. GCR location where the envoy image is stored. formatted like: gcr.io/{bucketName}/{imageName}
"eventingConfig": { # Eventing Configuration of a connection # Optional. Eventing config of a connection
"additionalVariables": [ # Additional eventing related field values
{ # 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.
},
],
"authConfig": { # AuthConfig defines details of a authentication type. # Auth details for the webhook adapter.
"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",
],
},
"oauth2AuthCodeFlowGoogleManaged": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlowGoogleManaged.
"authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens.
"redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange.
"scopes": [ # Required. Scopes the connection will request when the user performs the auth code flow.
"A String",
],
},
"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.
},
},
"deadLetterConfig": { # Dead Letter configuration details provided by the user. # Optional. Dead letter configuration for eventing of a connection.
"projectId": "A String", # Optional. Project which has the topic given.
"topic": "A String", # Optional. Topic to push events which couldn't be processed.
},
"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",
],
},
"oauth2AuthCodeFlowGoogleManaged": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlowGoogleManaged.
"authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens.
"redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange.
"scopes": [ # Required. Scopes the connection will request when the user performs the auth code flow.
"A String",
],
},
"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.
},
},
"privateConnectivityEnabled": True or False, # Optional. Private Connectivity Enabled.
"proxyDestinationConfig": { # Define the Connectors target endpoint. # Optional. Proxy for Eventing auto-registration.
"destinations": [ # The destinations for the key.
{
"host": "A String", # For publicly routable host.
"port": 42, # The port is the target port number that is accepted by the destination.
"serviceAttachment": "A String", # PSC service attachments. Format: projects/*/regions/*/serviceAttachments/*
},
],
"key": "A String", # The key is the destination identifier that is supported by the Connector.
},
"registrationDestinationConfig": { # Define the Connectors target endpoint. # Registration endpoint for auto registration.
"destinations": [ # The destinations for the key.
{
"host": "A String", # For publicly routable host.
"port": 42, # The port is the target port number that is accepted by the destination.
"serviceAttachment": "A String", # PSC service attachments. Format: projects/*/regions/*/serviceAttachments/*
},
],
"key": "A String", # The key is the destination identifier that is supported by the Connector.
},
},
"eventingEnablementType": "A String", # Optional. Eventing enablement type. Will be nil if eventing is not enabled.
"eventingRuntimeData": { # Eventing runtime data has the details related to eventing managed by the system. # Output only. Eventing Runtime Data.
"eventsListenerEndpoint": "A String", # Output only. Events listener endpoint. The value will populated after provisioning the events listener.
"eventsListenerPscSa": "A String", # Output only. Events listener PSC Service attachment. The value will be populated after provisioning the events listener with private connectivity enabled.
"status": { # EventingStatus indicates the state of eventing. # Output only. Current status of eventing.
"description": "A String", # Output only. Description of error if State is set to "ERROR".
"state": "A String", # Output only. State.
},
"webhookData": { # WebhookData has details of webhook configuration. # Output only. Webhook data.
"additionalVariables": [ # Output only. Additional webhook related field values.
{ # 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.
},
],
"createTime": "A String", # Output only. Timestamp when the webhook was created.
"id": "A String", # Output only. ID to uniquely identify webhook.
"name": "A String", # Output only. Name of the Webhook
"nextRefreshTime": "A String", # Output only. Next webhook refresh time. Will be null if refresh is not supported.
"updateTime": "A String", # Output only. Timestamp when the webhook was last updated.
},
"webhookSubscriptions": { # WebhookSubscriptions has details of webhook subscriptions. # Output only. Webhook subscriptions.
"webhookData": [ # Output only. Webhook data.
{ # WebhookData has details of webhook configuration.
"additionalVariables": [ # Output only. Additional webhook related field values.
{ # 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.
},
],
"createTime": "A String", # Output only. Timestamp when the webhook was created.
"id": "A String", # Output only. ID to uniquely identify webhook.
"name": "A String", # Output only. Name of the Webhook
"nextRefreshTime": "A String", # Output only. Next webhook refresh time. Will be null if refresh is not supported.
"updateTime": "A String", # Output only. Timestamp when the webhook was last updated.
},
],
},
},
"host": "A String", # Output only. The name of the Hostname of the Service Directory service with TLS.
"imageLocation": "A String", # Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName}
"isTrustedTester": True or False, # Output only. Is trusted tester program enabled for the project.
"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",
},
"lockConfig": { # Determines whether or no a connection is locked. If locked, a reason must be specified. # Optional. Configuration that indicates whether or not the Connection can be edited.
"locked": True or False, # Indicates whether or not the connection is locked.
"reason": "A String", # Describes why a connection is locked.
},
"logConfig": { # Log configuration for the connection. # Optional. Log configuration for the connection.
"enabled": True or False, # Enabled represents whether logging is enabled or not for a connection.
"level": "A String", # Optional. Log configuration level.
},
"name": "A String", # Output only. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection}
"nodeConfig": { # Node configuration for the connection. # Optional. Node configuration for the connection.
"maxNodeCount": 42, # Maximum number of nodes in the runtime nodes.
"minNodeCount": 42, # Minimum number of nodes in the runtime nodes.
},
"serviceAccount": "A String", # Optional. Service account needed for runtime plane to access Google Cloud resources.
"serviceDirectory": "A String", # 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"
"sslConfig": { # SSL Configuration of a connection # Optional. Ssl config of a connection
"additionalVariables": [ # Additional SSL related field values
{ # 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.
},
],
"clientCertType": "A String", # Type of Client Cert (PEM/JKS/.. etc.)
"clientCertificate": { # Secret provides a reference to entries in Secret Manager. # Client Certificate
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"clientPrivateKey": { # Secret provides a reference to entries in Secret Manager. # Client Private Key
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"clientPrivateKeyPass": { # Secret provides a reference to entries in Secret Manager. # Secret containing the passphrase protecting the Client Private Key
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"privateServerCertificate": { # Secret provides a reference to entries in Secret Manager. # Private Server Certificate. Needs to be specified if trust model is `PRIVATE`.
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"serverCertType": "A String", # Type of Server Cert (PEM/JKS/.. etc.)
"trustModel": "A String", # Trust Model of the SSL connection
"type": "A String", # Controls the ssl type for the given connector version.
"useSsl": True or False, # Bool for enabling SSL
},
"status": { # ConnectionStatus indicates the state of the connection. # Output only. Current status of the connection.
"description": "A String", # Description.
"state": "A String", # State.
"status": "A String", # Status provides detailed information for the state.
},
"subscriptionType": "A String", # Output only. This subscription type enum states the subscription type of the project.
"suspended": True or False, # Optional. Suspended indicates if a user has suspended a connection or not.
"tlsServiceDirectory": "A String", # Output only. The name of the Service Directory service with TLS.
"updateTime": "A String", # Output only. Updated time.
},
],
"nextPageToken": "A String", # Next page token.
"unreachable": [ # Locations that could not be reached.
"A String",
],
}
list_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
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.
Args:
name: string, Output only. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection} (required)
body: object, The request body.
The object takes the form of:
{ # Connection represents an instance of connector.
"asyncOperationsEnabled": True or False, # 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.
"authConfig": { # AuthConfig defines details of a authentication type. # Optional. Configuration for establishing the connection's authentication with an external system.
"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",
],
},
"oauth2AuthCodeFlowGoogleManaged": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlowGoogleManaged.
"authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens.
"redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange.
"scopes": [ # Required. Scopes the connection will request when the user performs the auth code flow.
"A String",
],
},
"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.
},
},
"authOverrideEnabled": True or False, # 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": { # Billing config for the connection. # Output only. Billing config for the connection.
"billingCategory": "A String", # Output only. Billing category for the connector.
},
"configVariables": [ # Optional. Configuration for configuring the connection with an external system.
{ # 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.
},
],
"connectionRevision": "A String", # Output only. Connection revision. This field is only updated when the connection is created or updated by User.
"connectorVersion": "A String", # 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.
"connectorVersionInfraConfig": { # This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version # Output only. Infra configs supported by Connector Version.
"connectionRatelimitWindowSeconds": "A String", # Output only. The window used for ratelimiting runtime requests to connections.
"deploymentModel": "A String", # Optional. Indicates whether connector is deployed on GKE/CloudRun
"deploymentModelMigrationState": "A String", # Output only. Status of the deployment model migration.
"hpaConfig": { # Autoscaling config for connector deployment system metrics. # Output only. HPA autoscaling config.
"cpuUtilizationThreshold": "A String", # Output only. Percent CPU utilization where HPA triggers autoscaling.
"memoryUtilizationThreshold": "A String", # Output only. Percent Memory utilization where HPA triggers autoscaling.
},
"internalclientRatelimitThreshold": "A String", # Output only. Max QPS supported for internal requests originating from Connd.
"maxInstanceRequestConcurrency": 42, # Output only. Max instance request concurrency.
"ratelimitThreshold": "A String", # Output only. Max QPS supported by the connector version before throttling of requests.
"resourceLimits": { # Resource limits defined for connection pods of a given connector type. # Output only. System resource limits.
"cpu": "A String", # Output only. CPU limit.
"memory": "A String", # Output only. Memory limit.
},
"resourceRequests": { # Resource requests defined for connection pods of a given connector type. # Output only. System resource requests.
"cpu": "A String", # Output only. CPU request.
"memory": "A String", # Output only. Memory request.
},
"sharedDeployment": "A String", # Output only. The name of shared connector deployment.
"tlsMigrationState": "A String", # Output only. Status of the TLS migration.
},
"connectorVersionLaunchStage": "A String", # Output only. Flag to mark the version indicating the launch stage.
"createTime": "A String", # Output only. Created time.
"description": "A String", # Optional. Description of the resource.
"destinationConfigs": [ # Optional. Configuration of the Connector's destination. Only accepted for Connectors that accepts user defined destination(s).
{ # Define the Connectors target endpoint.
"destinations": [ # The destinations for the key.
{
"host": "A String", # For publicly routable host.
"port": 42, # The port is the target port number that is accepted by the destination.
"serviceAttachment": "A String", # PSC service attachments. Format: projects/*/regions/*/serviceAttachments/*
},
],
"key": "A String", # The key is the destination identifier that is supported by the Connector.
},
],
"envoyImageLocation": "A String", # Output only. GCR location where the envoy image is stored. formatted like: gcr.io/{bucketName}/{imageName}
"eventingConfig": { # Eventing Configuration of a connection # Optional. Eventing config of a connection
"additionalVariables": [ # Additional eventing related field values
{ # 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.
},
],
"authConfig": { # AuthConfig defines details of a authentication type. # Auth details for the webhook adapter.
"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",
],
},
"oauth2AuthCodeFlowGoogleManaged": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlowGoogleManaged.
"authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens.
"redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange.
"scopes": [ # Required. Scopes the connection will request when the user performs the auth code flow.
"A String",
],
},
"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.
},
},
"deadLetterConfig": { # Dead Letter configuration details provided by the user. # Optional. Dead letter configuration for eventing of a connection.
"projectId": "A String", # Optional. Project which has the topic given.
"topic": "A String", # Optional. Topic to push events which couldn't be processed.
},
"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",
],
},
"oauth2AuthCodeFlowGoogleManaged": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlowGoogleManaged.
"authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens.
"redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange.
"scopes": [ # Required. Scopes the connection will request when the user performs the auth code flow.
"A String",
],
},
"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.
},
},
"privateConnectivityEnabled": True or False, # Optional. Private Connectivity Enabled.
"proxyDestinationConfig": { # Define the Connectors target endpoint. # Optional. Proxy for Eventing auto-registration.
"destinations": [ # The destinations for the key.
{
"host": "A String", # For publicly routable host.
"port": 42, # The port is the target port number that is accepted by the destination.
"serviceAttachment": "A String", # PSC service attachments. Format: projects/*/regions/*/serviceAttachments/*
},
],
"key": "A String", # The key is the destination identifier that is supported by the Connector.
},
"registrationDestinationConfig": { # Define the Connectors target endpoint. # Registration endpoint for auto registration.
"destinations": [ # The destinations for the key.
{
"host": "A String", # For publicly routable host.
"port": 42, # The port is the target port number that is accepted by the destination.
"serviceAttachment": "A String", # PSC service attachments. Format: projects/*/regions/*/serviceAttachments/*
},
],
"key": "A String", # The key is the destination identifier that is supported by the Connector.
},
},
"eventingEnablementType": "A String", # Optional. Eventing enablement type. Will be nil if eventing is not enabled.
"eventingRuntimeData": { # Eventing runtime data has the details related to eventing managed by the system. # Output only. Eventing Runtime Data.
"eventsListenerEndpoint": "A String", # Output only. Events listener endpoint. The value will populated after provisioning the events listener.
"eventsListenerPscSa": "A String", # Output only. Events listener PSC Service attachment. The value will be populated after provisioning the events listener with private connectivity enabled.
"status": { # EventingStatus indicates the state of eventing. # Output only. Current status of eventing.
"description": "A String", # Output only. Description of error if State is set to "ERROR".
"state": "A String", # Output only. State.
},
"webhookData": { # WebhookData has details of webhook configuration. # Output only. Webhook data.
"additionalVariables": [ # Output only. Additional webhook related field values.
{ # 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.
},
],
"createTime": "A String", # Output only. Timestamp when the webhook was created.
"id": "A String", # Output only. ID to uniquely identify webhook.
"name": "A String", # Output only. Name of the Webhook
"nextRefreshTime": "A String", # Output only. Next webhook refresh time. Will be null if refresh is not supported.
"updateTime": "A String", # Output only. Timestamp when the webhook was last updated.
},
"webhookSubscriptions": { # WebhookSubscriptions has details of webhook subscriptions. # Output only. Webhook subscriptions.
"webhookData": [ # Output only. Webhook data.
{ # WebhookData has details of webhook configuration.
"additionalVariables": [ # Output only. Additional webhook related field values.
{ # 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.
},
],
"createTime": "A String", # Output only. Timestamp when the webhook was created.
"id": "A String", # Output only. ID to uniquely identify webhook.
"name": "A String", # Output only. Name of the Webhook
"nextRefreshTime": "A String", # Output only. Next webhook refresh time. Will be null if refresh is not supported.
"updateTime": "A String", # Output only. Timestamp when the webhook was last updated.
},
],
},
},
"host": "A String", # Output only. The name of the Hostname of the Service Directory service with TLS.
"imageLocation": "A String", # Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName}
"isTrustedTester": True or False, # Output only. Is trusted tester program enabled for the project.
"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",
},
"lockConfig": { # Determines whether or no a connection is locked. If locked, a reason must be specified. # Optional. Configuration that indicates whether or not the Connection can be edited.
"locked": True or False, # Indicates whether or not the connection is locked.
"reason": "A String", # Describes why a connection is locked.
},
"logConfig": { # Log configuration for the connection. # Optional. Log configuration for the connection.
"enabled": True or False, # Enabled represents whether logging is enabled or not for a connection.
"level": "A String", # Optional. Log configuration level.
},
"name": "A String", # Output only. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection}
"nodeConfig": { # Node configuration for the connection. # Optional. Node configuration for the connection.
"maxNodeCount": 42, # Maximum number of nodes in the runtime nodes.
"minNodeCount": 42, # Minimum number of nodes in the runtime nodes.
},
"serviceAccount": "A String", # Optional. Service account needed for runtime plane to access Google Cloud resources.
"serviceDirectory": "A String", # 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"
"sslConfig": { # SSL Configuration of a connection # Optional. Ssl config of a connection
"additionalVariables": [ # Additional SSL related field values
{ # 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.
},
],
"clientCertType": "A String", # Type of Client Cert (PEM/JKS/.. etc.)
"clientCertificate": { # Secret provides a reference to entries in Secret Manager. # Client Certificate
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"clientPrivateKey": { # Secret provides a reference to entries in Secret Manager. # Client Private Key
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"clientPrivateKeyPass": { # Secret provides a reference to entries in Secret Manager. # Secret containing the passphrase protecting the Client Private Key
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"privateServerCertificate": { # Secret provides a reference to entries in Secret Manager. # Private Server Certificate. Needs to be specified if trust model is `PRIVATE`.
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"serverCertType": "A String", # Type of Server Cert (PEM/JKS/.. etc.)
"trustModel": "A String", # Trust Model of the SSL connection
"type": "A String", # Controls the ssl type for the given connector version.
"useSsl": True or False, # Bool for enabling SSL
},
"status": { # ConnectionStatus indicates the state of the connection. # Output only. Current status of the connection.
"description": "A String", # Description.
"state": "A String", # State.
"status": "A String", # Status provides detailed information for the state.
},
"subscriptionType": "A String", # Output only. This subscription type enum states the subscription type of the project.
"suspended": True or False, # Optional. Suspended indicates if a user has suspended a connection or not.
"tlsServiceDirectory": "A String", # Output only. The name of the Service Directory service with TLS.
"updateTime": "A String", # Output only. Updated time.
}
updateMask: string, Required. You can modify only the fields listed below. To lock/unlock a connection: * `lock_config` To suspend/resume a connection: * `suspended` To update the connection details: * `description` * `labels` * `connector_version` * `config_variables` * `auth_config` * `destination_configs` * `node_config` * `log_config` * `ssl_config` * `eventing_enablement_type` * `eventing_config` * `auth_override_enabled`
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
repairEventing(name, body=None, x__xgafv=None)
RepaiEventing tries to repair eventing related event subscriptions.
Args:
name: string, Required. Resource name of the form: `projects/*/locations/*/connections/*` (required)
body: object, The request body.
The object takes the form of:
{ # Request message for ConnectorsService.RepairEventing
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
search(name, pageSize=None, pageToken=None, query=None, x__xgafv=None)
Returns Top matching Connections for a given query.
Args:
name: string, Required. Parent resource of the Connection, of the form: `projects/*/locations/*/connections` (required)
pageSize: integer, Optional. The number of top matching connectors to return
pageToken: string, Optional. page_token
query: string, Required. The query against which the search needs to be done.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for Connectors.SearchConnections.
"connections": [ # A list of connectors.
{ # SearchConnectionInstance represents an instance of connector with specific fields
"actionSchema": { # Schema of a runtime action. # Output only. Schema of a runtime action.
"action": "A String", # Output only. Name of the action.
"description": "A String", # Output only. Brief Description of action
"displayName": "A String", # Output only. Display Name of action to be shown on client side
"inputJsonSchema": { # JsonSchema representation of schema metadata # Output only. JsonSchema representation of this action's input metadata
"default": "", # The default value of the field or object described by this schema.
"description": "A String", # A description of this schema.
"enum": [ # Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values
"",
],
"format": "A String", # Format of the value as per https://json-schema.org/understanding-json-schema/reference/string.html#format
"items": # Object with schema name: JsonSchema # Schema that applies to array values, applicable only if this is of type `array`.
"jdbcType": "A String", # JDBC datatype of the field.
"properties": { # The child schemas, applicable only if this is of type `object`. The key is the name of the property and the value is the json schema that describes that property
"a_key": # Object with schema name: JsonSchema
},
"required": [ # Whether this property is required.
"A String",
],
"type": [ # JSON Schema Validation: A Vocabulary for Structural Validation of JSON
"A String",
],
},
"inputParameters": [ # Output only. List of input parameter metadata for the action.
{ # Metadata of an input parameter.
"dataType": "A String", # The data type of the Parameter.
"defaultValue": "", # The following field specifies the default value of the Parameter provided by the external system if a value is not provided.
"description": "A String", # A brief description of the Parameter.
"jsonSchema": { # JsonSchema representation of schema metadata # JsonSchema representation of this action's parameter
"default": "", # The default value of the field or object described by this schema.
"description": "A String", # A description of this schema.
"enum": [ # Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values
"",
],
"format": "A String", # Format of the value as per https://json-schema.org/understanding-json-schema/reference/string.html#format
"items": # Object with schema name: JsonSchema # Schema that applies to array values, applicable only if this is of type `array`.
"jdbcType": "A String", # JDBC datatype of the field.
"properties": { # The child schemas, applicable only if this is of type `object`. The key is the name of the property and the value is the json schema that describes that property
"a_key": # Object with schema name: JsonSchema
},
"required": [ # Whether this property is required.
"A String",
],
"type": [ # JSON Schema Validation: A Vocabulary for Structural Validation of JSON
"A String",
],
},
"nullable": True or False, # Specifies whether a null value is allowed.
"parameter": "A String", # Name of the Parameter.
},
],
"inputSchemaAsString": "A String", # Output only. Input schema as string.
"resultJsonSchema": { # JsonSchema representation of schema metadata # Output only. JsonSchema representation of this action's result metadata
"default": "", # The default value of the field or object described by this schema.
"description": "A String", # A description of this schema.
"enum": [ # Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values
"",
],
"format": "A String", # Format of the value as per https://json-schema.org/understanding-json-schema/reference/string.html#format
"items": # Object with schema name: JsonSchema # Schema that applies to array values, applicable only if this is of type `array`.
"jdbcType": "A String", # JDBC datatype of the field.
"properties": { # The child schemas, applicable only if this is of type `object`. The key is the name of the property and the value is the json schema that describes that property
"a_key": # Object with schema name: JsonSchema
},
"required": [ # Whether this property is required.
"A String",
],
"type": [ # JSON Schema Validation: A Vocabulary for Structural Validation of JSON
"A String",
],
},
"resultMetadata": [ # Output only. List of result field metadata.
{ # Metadata of result field.
"dataType": "A String", # The data type of the field.
"defaultValue": "", # The following field specifies the default value of the Parameter provided by the external system if a value is not provided.
"description": "A String", # A brief description of the field.
"field": "A String", # Name of the result field.
"jsonSchema": { # JsonSchema representation of schema metadata # JsonSchema representation of this action's result
"default": "", # The default value of the field or object described by this schema.
"description": "A String", # A description of this schema.
"enum": [ # Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values
"",
],
"format": "A String", # Format of the value as per https://json-schema.org/understanding-json-schema/reference/string.html#format
"items": # Object with schema name: JsonSchema # Schema that applies to array values, applicable only if this is of type `array`.
"jdbcType": "A String", # JDBC datatype of the field.
"properties": { # The child schemas, applicable only if this is of type `object`. The key is the name of the property and the value is the json schema that describes that property
"a_key": # Object with schema name: JsonSchema
},
"required": [ # Whether this property is required.
"A String",
],
"type": [ # JSON Schema Validation: A Vocabulary for Structural Validation of JSON
"A String",
],
},
"nullable": True or False, # Specifies whether a null value is allowed.
},
],
"resultSchemaAsString": "A String", # Output only. Result schema as string.
},
"connection": { # Connection represents an instance of connector. # Output only. Connection details
"asyncOperationsEnabled": True or False, # 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.
"authConfig": { # AuthConfig defines details of a authentication type. # Optional. Configuration for establishing the connection's authentication with an external system.
"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",
],
},
"oauth2AuthCodeFlowGoogleManaged": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlowGoogleManaged.
"authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens.
"redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange.
"scopes": [ # Required. Scopes the connection will request when the user performs the auth code flow.
"A String",
],
},
"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.
},
},
"authOverrideEnabled": True or False, # 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": { # Billing config for the connection. # Output only. Billing config for the connection.
"billingCategory": "A String", # Output only. Billing category for the connector.
},
"configVariables": [ # Optional. Configuration for configuring the connection with an external system.
{ # 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.
},
],
"connectionRevision": "A String", # Output only. Connection revision. This field is only updated when the connection is created or updated by User.
"connectorVersion": "A String", # 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.
"connectorVersionInfraConfig": { # This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version # Output only. Infra configs supported by Connector Version.
"connectionRatelimitWindowSeconds": "A String", # Output only. The window used for ratelimiting runtime requests to connections.
"deploymentModel": "A String", # Optional. Indicates whether connector is deployed on GKE/CloudRun
"deploymentModelMigrationState": "A String", # Output only. Status of the deployment model migration.
"hpaConfig": { # Autoscaling config for connector deployment system metrics. # Output only. HPA autoscaling config.
"cpuUtilizationThreshold": "A String", # Output only. Percent CPU utilization where HPA triggers autoscaling.
"memoryUtilizationThreshold": "A String", # Output only. Percent Memory utilization where HPA triggers autoscaling.
},
"internalclientRatelimitThreshold": "A String", # Output only. Max QPS supported for internal requests originating from Connd.
"maxInstanceRequestConcurrency": 42, # Output only. Max instance request concurrency.
"ratelimitThreshold": "A String", # Output only. Max QPS supported by the connector version before throttling of requests.
"resourceLimits": { # Resource limits defined for connection pods of a given connector type. # Output only. System resource limits.
"cpu": "A String", # Output only. CPU limit.
"memory": "A String", # Output only. Memory limit.
},
"resourceRequests": { # Resource requests defined for connection pods of a given connector type. # Output only. System resource requests.
"cpu": "A String", # Output only. CPU request.
"memory": "A String", # Output only. Memory request.
},
"sharedDeployment": "A String", # Output only. The name of shared connector deployment.
"tlsMigrationState": "A String", # Output only. Status of the TLS migration.
},
"connectorVersionLaunchStage": "A String", # Output only. Flag to mark the version indicating the launch stage.
"createTime": "A String", # Output only. Created time.
"description": "A String", # Optional. Description of the resource.
"destinationConfigs": [ # Optional. Configuration of the Connector's destination. Only accepted for Connectors that accepts user defined destination(s).
{ # Define the Connectors target endpoint.
"destinations": [ # The destinations for the key.
{
"host": "A String", # For publicly routable host.
"port": 42, # The port is the target port number that is accepted by the destination.
"serviceAttachment": "A String", # PSC service attachments. Format: projects/*/regions/*/serviceAttachments/*
},
],
"key": "A String", # The key is the destination identifier that is supported by the Connector.
},
],
"envoyImageLocation": "A String", # Output only. GCR location where the envoy image is stored. formatted like: gcr.io/{bucketName}/{imageName}
"eventingConfig": { # Eventing Configuration of a connection # Optional. Eventing config of a connection
"additionalVariables": [ # Additional eventing related field values
{ # 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.
},
],
"authConfig": { # AuthConfig defines details of a authentication type. # Auth details for the webhook adapter.
"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",
],
},
"oauth2AuthCodeFlowGoogleManaged": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlowGoogleManaged.
"authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens.
"redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange.
"scopes": [ # Required. Scopes the connection will request when the user performs the auth code flow.
"A String",
],
},
"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.
},
},
"deadLetterConfig": { # Dead Letter configuration details provided by the user. # Optional. Dead letter configuration for eventing of a connection.
"projectId": "A String", # Optional. Project which has the topic given.
"topic": "A String", # Optional. Topic to push events which couldn't be processed.
},
"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",
],
},
"oauth2AuthCodeFlowGoogleManaged": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlowGoogleManaged.
"authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens.
"redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange.
"scopes": [ # Required. Scopes the connection will request when the user performs the auth code flow.
"A String",
],
},
"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.
},
},
"privateConnectivityEnabled": True or False, # Optional. Private Connectivity Enabled.
"proxyDestinationConfig": { # Define the Connectors target endpoint. # Optional. Proxy for Eventing auto-registration.
"destinations": [ # The destinations for the key.
{
"host": "A String", # For publicly routable host.
"port": 42, # The port is the target port number that is accepted by the destination.
"serviceAttachment": "A String", # PSC service attachments. Format: projects/*/regions/*/serviceAttachments/*
},
],
"key": "A String", # The key is the destination identifier that is supported by the Connector.
},
"registrationDestinationConfig": { # Define the Connectors target endpoint. # Registration endpoint for auto registration.
"destinations": [ # The destinations for the key.
{
"host": "A String", # For publicly routable host.
"port": 42, # The port is the target port number that is accepted by the destination.
"serviceAttachment": "A String", # PSC service attachments. Format: projects/*/regions/*/serviceAttachments/*
},
],
"key": "A String", # The key is the destination identifier that is supported by the Connector.
},
},
"eventingEnablementType": "A String", # Optional. Eventing enablement type. Will be nil if eventing is not enabled.
"eventingRuntimeData": { # Eventing runtime data has the details related to eventing managed by the system. # Output only. Eventing Runtime Data.
"eventsListenerEndpoint": "A String", # Output only. Events listener endpoint. The value will populated after provisioning the events listener.
"eventsListenerPscSa": "A String", # Output only. Events listener PSC Service attachment. The value will be populated after provisioning the events listener with private connectivity enabled.
"status": { # EventingStatus indicates the state of eventing. # Output only. Current status of eventing.
"description": "A String", # Output only. Description of error if State is set to "ERROR".
"state": "A String", # Output only. State.
},
"webhookData": { # WebhookData has details of webhook configuration. # Output only. Webhook data.
"additionalVariables": [ # Output only. Additional webhook related field values.
{ # 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.
},
],
"createTime": "A String", # Output only. Timestamp when the webhook was created.
"id": "A String", # Output only. ID to uniquely identify webhook.
"name": "A String", # Output only. Name of the Webhook
"nextRefreshTime": "A String", # Output only. Next webhook refresh time. Will be null if refresh is not supported.
"updateTime": "A String", # Output only. Timestamp when the webhook was last updated.
},
"webhookSubscriptions": { # WebhookSubscriptions has details of webhook subscriptions. # Output only. Webhook subscriptions.
"webhookData": [ # Output only. Webhook data.
{ # WebhookData has details of webhook configuration.
"additionalVariables": [ # Output only. Additional webhook related field values.
{ # 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.
},
],
"createTime": "A String", # Output only. Timestamp when the webhook was created.
"id": "A String", # Output only. ID to uniquely identify webhook.
"name": "A String", # Output only. Name of the Webhook
"nextRefreshTime": "A String", # Output only. Next webhook refresh time. Will be null if refresh is not supported.
"updateTime": "A String", # Output only. Timestamp when the webhook was last updated.
},
],
},
},
"host": "A String", # Output only. The name of the Hostname of the Service Directory service with TLS.
"imageLocation": "A String", # Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName}
"isTrustedTester": True or False, # Output only. Is trusted tester program enabled for the project.
"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",
},
"lockConfig": { # Determines whether or no a connection is locked. If locked, a reason must be specified. # Optional. Configuration that indicates whether or not the Connection can be edited.
"locked": True or False, # Indicates whether or not the connection is locked.
"reason": "A String", # Describes why a connection is locked.
},
"logConfig": { # Log configuration for the connection. # Optional. Log configuration for the connection.
"enabled": True or False, # Enabled represents whether logging is enabled or not for a connection.
"level": "A String", # Optional. Log configuration level.
},
"name": "A String", # Output only. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection}
"nodeConfig": { # Node configuration for the connection. # Optional. Node configuration for the connection.
"maxNodeCount": 42, # Maximum number of nodes in the runtime nodes.
"minNodeCount": 42, # Minimum number of nodes in the runtime nodes.
},
"serviceAccount": "A String", # Optional. Service account needed for runtime plane to access Google Cloud resources.
"serviceDirectory": "A String", # 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"
"sslConfig": { # SSL Configuration of a connection # Optional. Ssl config of a connection
"additionalVariables": [ # Additional SSL related field values
{ # 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.
},
],
"clientCertType": "A String", # Type of Client Cert (PEM/JKS/.. etc.)
"clientCertificate": { # Secret provides a reference to entries in Secret Manager. # Client Certificate
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"clientPrivateKey": { # Secret provides a reference to entries in Secret Manager. # Client Private Key
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"clientPrivateKeyPass": { # Secret provides a reference to entries in Secret Manager. # Secret containing the passphrase protecting the Client Private Key
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"privateServerCertificate": { # Secret provides a reference to entries in Secret Manager. # Private Server Certificate. Needs to be specified if trust model is `PRIVATE`.
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"serverCertType": "A String", # Type of Server Cert (PEM/JKS/.. etc.)
"trustModel": "A String", # Trust Model of the SSL connection
"type": "A String", # Controls the ssl type for the given connector version.
"useSsl": True or False, # Bool for enabling SSL
},
"status": { # ConnectionStatus indicates the state of the connection. # Output only. Current status of the connection.
"description": "A String", # Description.
"state": "A String", # State.
"status": "A String", # Status provides detailed information for the state.
},
"subscriptionType": "A String", # Output only. This subscription type enum states the subscription type of the project.
"suspended": True or False, # Optional. Suspended indicates if a user has suspended a connection or not.
"tlsServiceDirectory": "A String", # Output only. The name of the Service Directory service with TLS.
"updateTime": "A String", # Output only. Updated time.
},
"entitySchema": { # Schema of a runtime entity. # Output only. Schema of a runtime entity.
"entity": "A String", # Output only. Name of the entity.
"fields": [ # Output only. List of fields in the entity.
{ # Metadata of an entity field.
"additionalDetails": { # The following map contains fields that are not explicitly mentioned above,this give connectors the flexibility to add new metadata fields.
"a_key": "", # Properties of the object.
},
"dataType": "A String", # The data type of the Field.
"defaultValue": "", # The following field specifies the default value of the Field provided by the external system if a value is not provided.
"description": "A String", # A brief description of the Field.
"field": "A String", # Name of the Field.
"jsonSchema": { # JsonSchema representation of schema metadata # JsonSchema representation of this entity's schema
"default": "", # The default value of the field or object described by this schema.
"description": "A String", # A description of this schema.
"enum": [ # Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values
"",
],
"format": "A String", # Format of the value as per https://json-schema.org/understanding-json-schema/reference/string.html#format
"items": # Object with schema name: JsonSchema # Schema that applies to array values, applicable only if this is of type `array`.
"jdbcType": "A String", # JDBC datatype of the field.
"properties": { # The child schemas, applicable only if this is of type `object`. The key is the name of the property and the value is the json schema that describes that property
"a_key": # Object with schema name: JsonSchema
},
"required": [ # Whether this property is required.
"A String",
],
"type": [ # JSON Schema Validation: A Vocabulary for Structural Validation of JSON
"A String",
],
},
"key": True or False, # The following boolean field specifies if the current Field acts as a primary key or id if the parent is of type entity.
"nullable": True or False, # Specifies whether a null value is allowed.
"readonly": True or False, # Specifies if the Field is readonly.
},
],
"jsonSchema": { # JsonSchema representation of schema metadata # Output only. JsonSchema representation of this entity's metadata
"default": "", # The default value of the field or object described by this schema.
"description": "A String", # A description of this schema.
"enum": [ # Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values
"",
],
"format": "A String", # Format of the value as per https://json-schema.org/understanding-json-schema/reference/string.html#format
"items": # Object with schema name: JsonSchema # Schema that applies to array values, applicable only if this is of type `array`.
"jdbcType": "A String", # JDBC datatype of the field.
"properties": { # The child schemas, applicable only if this is of type `object`. The key is the name of the property and the value is the json schema that describes that property
"a_key": # Object with schema name: JsonSchema
},
"required": [ # Whether this property is required.
"A String",
],
"type": [ # JSON Schema Validation: A Vocabulary for Structural Validation of JSON
"A String",
],
},
"operations": [ # List of operations supported by this entity
"A String",
],
},
},
],
"nextPageToken": "A String", # Optional. page_token
"unreachable": [ # Locations that could not be reached.
"A String",
],
}
search_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
setIamPolicy(resource, body=None, x__xgafv=None)
Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Args:
resource: string, REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for `SetIamPolicy` method.
"policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
"auditLogConfigs": [ # The configuration for logging of each type of permission.
{ # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
"A String",
],
"logType": "A String", # The log type that this config enables.
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
},
],
"bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
{ # Associates `members`, or principals, with a `role`.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
},
"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
"A String",
],
"role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
},
],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
},
"updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
"auditLogConfigs": [ # The configuration for logging of each type of permission.
{ # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
"A String",
],
"logType": "A String", # The log type that this config enables.
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
},
],
"bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
{ # Associates `members`, or principals, with a `role`.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
},
"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
"A String",
],
"role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
},
],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
}
testIamPermissions(resource, body=None, x__xgafv=None)
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Args:
resource: string, REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for `TestIamPermissions` method.
"permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
"A String",
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for `TestIamPermissions` method.
"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
"A String",
],
}