diff --git a/docs/dyn/connectors_v1.projects.locations.connections.connectionSchemaMetadata.html b/docs/dyn/connectors_v1.projects.locations.connections.connectionSchemaMetadata.html index c58ee26edc..0f7828d7f7 100644 --- a/docs/dyn/connectors_v1.projects.locations.connections.connectionSchemaMetadata.html +++ b/docs/dyn/connectors_v1.projects.locations.connections.connectionSchemaMetadata.html @@ -392,6 +392,9 @@
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.
@@ -214,6 +220,9 @@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. + }, + ], + "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. + "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", + ], + }, + }, + ], + }, + "connection": { # Connection represents an instance of connector. # Output only. Connection details + "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", + ], + }, + "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. + }, + }, + "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 + "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. + "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. + }, + "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", + ], + }, + "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", + ], + }, + "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. + }, + }, + "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. + }, + "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. + "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. diff --git a/docs/dyn/connectors_v1.projects.locations.connections.runtimeEntitySchemas.html b/docs/dyn/connectors_v1.projects.locations.connections.runtimeEntitySchemas.html index 7fe5e1642e..8bc396e7cd 100644 --- a/docs/dyn/connectors_v1.projects.locations.connections.runtimeEntitySchemas.html +++ b/docs/dyn/connectors_v1.projects.locations.connections.runtimeEntitySchemas.html @@ -163,6 +163,9 @@diff --git a/docs/dyn/connectors_v1.projects.locations.global_.customConnectors.html b/docs/dyn/connectors_v1.projects.locations.global_.customConnectors.html index 6edcc783b1..b9732b0547 100644 --- a/docs/dyn/connectors_v1.projects.locations.global_.customConnectors.html +++ b/docs/dyn/connectors_v1.projects.locations.global_.customConnectors.html @@ -116,7 +116,10 @@Method Details
"A String", ], }, + "operations": [ # List of operations supported by this entity + "A String", + ], }, ], }