blob: a7b2fc252e16ee69f8a861455cb68a7af233cbf3 [file] [log] [blame] [edit]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="integrations_v1alpha.html">Application Integration API</a> . <a href="integrations_v1alpha.projects.html">projects</a> . <a href="integrations_v1alpha.projects.locations.html">locations</a> . <a href="integrations_v1alpha.projects.locations.connections.html">connections</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="integrations_v1alpha.projects.locations.connections.runtimeActionSchemas.html">runtimeActionSchemas()</a></code>
</p>
<p class="firstline">Returns the runtimeActionSchemas Resource.</p>
<p class="toc_element">
<code><a href="integrations_v1alpha.projects.locations.connections.runtimeEntitySchemas.html">runtimeEntitySchemas()</a></code>
</p>
<p class="firstline">Returns the runtimeEntitySchemas Resource.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#getConnectionSchemaMetadata">getConnectionSchemaMetadata(name, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the available entities and actions associated with a Connection.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists Connections in a given project and location.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="getConnectionSchemaMetadata">getConnectionSchemaMetadata(name, x__xgafv=None)</code>
<pre>Lists the available entities and actions associated with a Connection.
Args:
name: string, Required. ConnectionSchemaMetadata 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:
{ # Metadata of runtime connection schema.
&quot;actions&quot;: [ # List of actions.
&quot;A String&quot;,
],
&quot;entities&quot;: [ # List of entity names.
&quot;A String&quot;,
],
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response containing Connections listed by region.
&quot;connections&quot;: [ # Connections.
{ # Connection represents an instance of connector.
&quot;authConfig&quot;: { # AuthConfig defines details of a authentication type. # Optional. Configuration for establishing the connection&#x27;s authentication with an external system.
&quot;additionalVariables&quot;: [ # List containing additional auth configs.
{ # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
&quot;boolValue&quot;: True or False, # Value is a bool.
&quot;encryptionKeyValue&quot;: { # Encryption Key value. # Value is a Encryption Key.
&quot;kmsKeyName&quot;: &quot;A String&quot;, # 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.
&quot;type&quot;: &quot;A String&quot;, # Type.
},
&quot;intValue&quot;: &quot;A String&quot;, # Value is an integer
&quot;key&quot;: &quot;A String&quot;, # Key of the config variable.
&quot;secretValue&quot;: { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
&quot;secretVersion&quot;: &quot;A String&quot;, # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
&quot;stringValue&quot;: &quot;A String&quot;, # Value is a string.
},
],
&quot;authKey&quot;: &quot;A String&quot;, # Identifier key for auth config
&quot;authType&quot;: &quot;A String&quot;, # The type of authentication configured.
&quot;oauth2AuthCodeFlow&quot;: { # 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.
&quot;authCode&quot;: &quot;A String&quot;, # Authorization code to be exchanged for access and refresh tokens.
&quot;authUri&quot;: &quot;A String&quot;, # Auth URL for Authorization Code Flow
&quot;clientId&quot;: &quot;A String&quot;, # Client ID for user-provided OAuth app.
&quot;clientSecret&quot;: { # Secret provides a reference to entries in Secret Manager. # Client secret for user-provided OAuth app.
&quot;secretVersion&quot;: &quot;A String&quot;, # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
&quot;enablePkce&quot;: True or False, # Whether to enable PKCE when the user performs the auth code flow.
&quot;pkceVerifier&quot;: &quot;A String&quot;, # PKCE verifier to be used during the auth code exchange.
&quot;redirectUri&quot;: &quot;A String&quot;, # Redirect URI to be provided during the auth code exchange.
&quot;scopes&quot;: [ # Scopes the connection will request when the user performs the auth code flow.
&quot;A String&quot;,
],
},
&quot;oauth2ClientCredentials&quot;: { # 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.
&quot;clientId&quot;: &quot;A String&quot;, # The client identifier.
&quot;clientSecret&quot;: { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret.
&quot;secretVersion&quot;: &quot;A String&quot;, # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
},
&quot;oauth2JwtBearer&quot;: { # 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.
&quot;clientKey&quot;: { # 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/*`.
&quot;secretVersion&quot;: &quot;A String&quot;, # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
&quot;jwtClaims&quot;: { # JWT claims used for the jwt-bearer authorization grant. # JwtClaims providers fields to generate the token.
&quot;audience&quot;: &quot;A String&quot;, # Value for the &quot;aud&quot; claim.
&quot;issuer&quot;: &quot;A String&quot;, # Value for the &quot;iss&quot; claim.
&quot;subject&quot;: &quot;A String&quot;, # Value for the &quot;sub&quot; claim.
},
},
&quot;sshPublicKey&quot;: { # Parameters to support Ssh public key Authentication. # SSH Public Key.
&quot;certType&quot;: &quot;A String&quot;, # Format of SSH Client cert.
&quot;sshClientCert&quot;: { # Secret provides a reference to entries in Secret Manager. # SSH Client Cert. It should contain both public and private key.
&quot;secretVersion&quot;: &quot;A String&quot;, # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
&quot;sshClientCertPass&quot;: { # Secret provides a reference to entries in Secret Manager. # Password (passphrase) for ssh client certificate if it has one.
&quot;secretVersion&quot;: &quot;A String&quot;, # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
&quot;username&quot;: &quot;A String&quot;, # The user account used to authenticate.
},
&quot;userPassword&quot;: { # Parameters to support Username and Password Authentication. # UserPassword.
&quot;password&quot;: { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the password.
&quot;secretVersion&quot;: &quot;A String&quot;, # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
&quot;username&quot;: &quot;A String&quot;, # Username.
},
},
&quot;billingConfig&quot;: { # Billing config for the connection. # Output only. Billing config for the connection.
&quot;billingCategory&quot;: &quot;A String&quot;, # Output only. Billing category for the connector.
},
&quot;configVariables&quot;: [ # Optional. Configuration for configuring the connection with an external system.
{ # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
&quot;boolValue&quot;: True or False, # Value is a bool.
&quot;encryptionKeyValue&quot;: { # Encryption Key value. # Value is a Encryption Key.
&quot;kmsKeyName&quot;: &quot;A String&quot;, # 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.
&quot;type&quot;: &quot;A String&quot;, # Type.
},
&quot;intValue&quot;: &quot;A String&quot;, # Value is an integer
&quot;key&quot;: &quot;A String&quot;, # Key of the config variable.
&quot;secretValue&quot;: { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
&quot;secretVersion&quot;: &quot;A String&quot;, # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
&quot;stringValue&quot;: &quot;A String&quot;, # Value is a string.
},
],
&quot;connectionRevision&quot;: &quot;A String&quot;, # Output only. Connection revision. This field is only updated when the connection is created or updated by User.
&quot;connectorVersion&quot;: &quot;A String&quot;, # 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.
&quot;connectorVersionInfraConfig&quot;: { # 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.
&quot;connectionRatelimitWindowSeconds&quot;: &quot;A String&quot;, # Output only. The window used for ratelimiting runtime requests to connections.
&quot;deploymentModel&quot;: &quot;A String&quot;, # Optional. Indicates whether connector is deployed on GKE/CloudRun
&quot;hpaConfig&quot;: { # Autoscaling config for connector deployment system metrics. # Output only. HPA autoscaling config.
&quot;cpuUtilizationThreshold&quot;: &quot;A String&quot;, # Output only. Percent CPU utilization where HPA triggers autoscaling.
&quot;memoryUtilizationThreshold&quot;: &quot;A String&quot;, # Output only. Percent Memory utilization where HPA triggers autoscaling.
},
&quot;internalclientRatelimitThreshold&quot;: &quot;A String&quot;, # Output only. Max QPS supported for internal requests originating from Connd.
&quot;ratelimitThreshold&quot;: &quot;A String&quot;, # Output only. Max QPS supported by the connector version before throttling of requests.
&quot;resourceLimits&quot;: { # Resource limits defined for connection pods of a given connector type. # Output only. System resource limits.
&quot;cpu&quot;: &quot;A String&quot;, # Output only. CPU limit.
&quot;memory&quot;: &quot;A String&quot;, # Output only. Memory limit.
},
&quot;resourceRequests&quot;: { # Resource requests defined for connection pods of a given connector type. # Output only. System resource requests.
&quot;cpu&quot;: &quot;A String&quot;, # Output only. CPU request.
&quot;memory&quot;: &quot;A String&quot;, # Output only. Memory request.
},
&quot;sharedDeployment&quot;: &quot;A String&quot;, # Output only. The name of shared connector deployment.
},
&quot;connectorVersionLaunchStage&quot;: &quot;A String&quot;, # Output only. Flag to mark the version indicating the launch stage.
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Created time.
&quot;description&quot;: &quot;A String&quot;, # Optional. Description of the resource.
&quot;destinationConfigs&quot;: [ # Optional. Configuration of the Connector&#x27;s destination. Only accepted for Connectors that accepts user defined destination(s).
{ # Define the Connectors target endpoint.
&quot;destinations&quot;: [ # The destinations for the key.
{
&quot;host&quot;: &quot;A String&quot;, # For publicly routable host.
&quot;port&quot;: 42, # The port is the target port number that is accepted by the destination.
&quot;serviceAttachment&quot;: &quot;A String&quot;, # PSC service attachments. Format: projects/*/regions/*/serviceAttachments/*
},
],
&quot;key&quot;: &quot;A String&quot;, # The key is the destination identifier that is supported by the Connector.
},
],
&quot;envoyImageLocation&quot;: &quot;A String&quot;, # Output only. GCR location where the envoy image is stored. formatted like: gcr.io/{bucketName}/{imageName}
&quot;eventingConfig&quot;: { # Eventing Configuration of a connection # Optional. Eventing config of a connection
&quot;additionalVariables&quot;: [ # Additional eventing related field values
{ # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
&quot;boolValue&quot;: True or False, # Value is a bool.
&quot;encryptionKeyValue&quot;: { # Encryption Key value. # Value is a Encryption Key.
&quot;kmsKeyName&quot;: &quot;A String&quot;, # 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.
&quot;type&quot;: &quot;A String&quot;, # Type.
},
&quot;intValue&quot;: &quot;A String&quot;, # Value is an integer
&quot;key&quot;: &quot;A String&quot;, # Key of the config variable.
&quot;secretValue&quot;: { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
&quot;secretVersion&quot;: &quot;A String&quot;, # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
&quot;stringValue&quot;: &quot;A String&quot;, # Value is a string.
},
],
&quot;authConfig&quot;: { # AuthConfig defines details of a authentication type. # Auth details for the webhook adapter.
&quot;additionalVariables&quot;: [ # List containing additional auth configs.
{ # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
&quot;boolValue&quot;: True or False, # Value is a bool.
&quot;encryptionKeyValue&quot;: { # Encryption Key value. # Value is a Encryption Key.
&quot;kmsKeyName&quot;: &quot;A String&quot;, # 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.
&quot;type&quot;: &quot;A String&quot;, # Type.
},
&quot;intValue&quot;: &quot;A String&quot;, # Value is an integer
&quot;key&quot;: &quot;A String&quot;, # Key of the config variable.
&quot;secretValue&quot;: { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
&quot;secretVersion&quot;: &quot;A String&quot;, # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
&quot;stringValue&quot;: &quot;A String&quot;, # Value is a string.
},
],
&quot;authKey&quot;: &quot;A String&quot;, # Identifier key for auth config
&quot;authType&quot;: &quot;A String&quot;, # The type of authentication configured.
&quot;oauth2AuthCodeFlow&quot;: { # 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.
&quot;authCode&quot;: &quot;A String&quot;, # Authorization code to be exchanged for access and refresh tokens.
&quot;authUri&quot;: &quot;A String&quot;, # Auth URL for Authorization Code Flow
&quot;clientId&quot;: &quot;A String&quot;, # Client ID for user-provided OAuth app.
&quot;clientSecret&quot;: { # Secret provides a reference to entries in Secret Manager. # Client secret for user-provided OAuth app.
&quot;secretVersion&quot;: &quot;A String&quot;, # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
&quot;enablePkce&quot;: True or False, # Whether to enable PKCE when the user performs the auth code flow.
&quot;pkceVerifier&quot;: &quot;A String&quot;, # PKCE verifier to be used during the auth code exchange.
&quot;redirectUri&quot;: &quot;A String&quot;, # Redirect URI to be provided during the auth code exchange.
&quot;scopes&quot;: [ # Scopes the connection will request when the user performs the auth code flow.
&quot;A String&quot;,
],
},
&quot;oauth2ClientCredentials&quot;: { # 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.
&quot;clientId&quot;: &quot;A String&quot;, # The client identifier.
&quot;clientSecret&quot;: { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret.
&quot;secretVersion&quot;: &quot;A String&quot;, # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
},
&quot;oauth2JwtBearer&quot;: { # 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.
&quot;clientKey&quot;: { # 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/*`.
&quot;secretVersion&quot;: &quot;A String&quot;, # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
&quot;jwtClaims&quot;: { # JWT claims used for the jwt-bearer authorization grant. # JwtClaims providers fields to generate the token.
&quot;audience&quot;: &quot;A String&quot;, # Value for the &quot;aud&quot; claim.
&quot;issuer&quot;: &quot;A String&quot;, # Value for the &quot;iss&quot; claim.
&quot;subject&quot;: &quot;A String&quot;, # Value for the &quot;sub&quot; claim.
},
},
&quot;sshPublicKey&quot;: { # Parameters to support Ssh public key Authentication. # SSH Public Key.
&quot;certType&quot;: &quot;A String&quot;, # Format of SSH Client cert.
&quot;sshClientCert&quot;: { # Secret provides a reference to entries in Secret Manager. # SSH Client Cert. It should contain both public and private key.
&quot;secretVersion&quot;: &quot;A String&quot;, # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
&quot;sshClientCertPass&quot;: { # Secret provides a reference to entries in Secret Manager. # Password (passphrase) for ssh client certificate if it has one.
&quot;secretVersion&quot;: &quot;A String&quot;, # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
&quot;username&quot;: &quot;A String&quot;, # The user account used to authenticate.
},
&quot;userPassword&quot;: { # Parameters to support Username and Password Authentication. # UserPassword.
&quot;password&quot;: { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the password.
&quot;secretVersion&quot;: &quot;A String&quot;, # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
&quot;username&quot;: &quot;A String&quot;, # Username.
},
},
&quot;deadLetterConfig&quot;: { # Dead Letter configuration details provided by the user. # Optional. Dead letter configuration for eventing of a connection.
&quot;projectId&quot;: &quot;A String&quot;, # Optional. Project which has the topic given.
&quot;topic&quot;: &quot;A String&quot;, # Optional. Topic to push events which couldn&#x27;t be processed.
},
&quot;enrichmentEnabled&quot;: True or False, # Enrichment Enabled.
&quot;eventsListenerIngressEndpoint&quot;: &quot;A String&quot;, # Optional. Ingress endpoint of the event listener. This is used only when private connectivity is enabled.
&quot;listenerAuthConfig&quot;: { # AuthConfig defines details of a authentication type. # Optional. Auth details for the event listener.
&quot;additionalVariables&quot;: [ # List containing additional auth configs.
{ # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
&quot;boolValue&quot;: True or False, # Value is a bool.
&quot;encryptionKeyValue&quot;: { # Encryption Key value. # Value is a Encryption Key.
&quot;kmsKeyName&quot;: &quot;A String&quot;, # 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.
&quot;type&quot;: &quot;A String&quot;, # Type.
},
&quot;intValue&quot;: &quot;A String&quot;, # Value is an integer
&quot;key&quot;: &quot;A String&quot;, # Key of the config variable.
&quot;secretValue&quot;: { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
&quot;secretVersion&quot;: &quot;A String&quot;, # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
&quot;stringValue&quot;: &quot;A String&quot;, # Value is a string.
},
],
&quot;authKey&quot;: &quot;A String&quot;, # Identifier key for auth config
&quot;authType&quot;: &quot;A String&quot;, # The type of authentication configured.
&quot;oauth2AuthCodeFlow&quot;: { # 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.
&quot;authCode&quot;: &quot;A String&quot;, # Authorization code to be exchanged for access and refresh tokens.
&quot;authUri&quot;: &quot;A String&quot;, # Auth URL for Authorization Code Flow
&quot;clientId&quot;: &quot;A String&quot;, # Client ID for user-provided OAuth app.
&quot;clientSecret&quot;: { # Secret provides a reference to entries in Secret Manager. # Client secret for user-provided OAuth app.
&quot;secretVersion&quot;: &quot;A String&quot;, # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
&quot;enablePkce&quot;: True or False, # Whether to enable PKCE when the user performs the auth code flow.
&quot;pkceVerifier&quot;: &quot;A String&quot;, # PKCE verifier to be used during the auth code exchange.
&quot;redirectUri&quot;: &quot;A String&quot;, # Redirect URI to be provided during the auth code exchange.
&quot;scopes&quot;: [ # Scopes the connection will request when the user performs the auth code flow.
&quot;A String&quot;,
],
},
&quot;oauth2ClientCredentials&quot;: { # 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.
&quot;clientId&quot;: &quot;A String&quot;, # The client identifier.
&quot;clientSecret&quot;: { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret.
&quot;secretVersion&quot;: &quot;A String&quot;, # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
},
&quot;oauth2JwtBearer&quot;: { # 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.
&quot;clientKey&quot;: { # 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/*`.
&quot;secretVersion&quot;: &quot;A String&quot;, # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
&quot;jwtClaims&quot;: { # JWT claims used for the jwt-bearer authorization grant. # JwtClaims providers fields to generate the token.
&quot;audience&quot;: &quot;A String&quot;, # Value for the &quot;aud&quot; claim.
&quot;issuer&quot;: &quot;A String&quot;, # Value for the &quot;iss&quot; claim.
&quot;subject&quot;: &quot;A String&quot;, # Value for the &quot;sub&quot; claim.
},
},
&quot;sshPublicKey&quot;: { # Parameters to support Ssh public key Authentication. # SSH Public Key.
&quot;certType&quot;: &quot;A String&quot;, # Format of SSH Client cert.
&quot;sshClientCert&quot;: { # Secret provides a reference to entries in Secret Manager. # SSH Client Cert. It should contain both public and private key.
&quot;secretVersion&quot;: &quot;A String&quot;, # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
&quot;sshClientCertPass&quot;: { # Secret provides a reference to entries in Secret Manager. # Password (passphrase) for ssh client certificate if it has one.
&quot;secretVersion&quot;: &quot;A String&quot;, # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
&quot;username&quot;: &quot;A String&quot;, # The user account used to authenticate.
},
&quot;userPassword&quot;: { # Parameters to support Username and Password Authentication. # UserPassword.
&quot;password&quot;: { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the password.
&quot;secretVersion&quot;: &quot;A String&quot;, # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
&quot;username&quot;: &quot;A String&quot;, # Username.
},
},
&quot;privateConnectivityEnabled&quot;: True or False, # Optional. Private Connectivity Enabled.
&quot;proxyDestinationConfig&quot;: { # Define the Connectors target endpoint. # Optional. Proxy for Eventing auto-registration.
&quot;destinations&quot;: [ # The destinations for the key.
{
&quot;host&quot;: &quot;A String&quot;, # For publicly routable host.
&quot;port&quot;: 42, # The port is the target port number that is accepted by the destination.
&quot;serviceAttachment&quot;: &quot;A String&quot;, # PSC service attachments. Format: projects/*/regions/*/serviceAttachments/*
},
],
&quot;key&quot;: &quot;A String&quot;, # The key is the destination identifier that is supported by the Connector.
},
&quot;registrationDestinationConfig&quot;: { # Define the Connectors target endpoint. # Registration endpoint for auto registration.
&quot;destinations&quot;: [ # The destinations for the key.
{
&quot;host&quot;: &quot;A String&quot;, # For publicly routable host.
&quot;port&quot;: 42, # The port is the target port number that is accepted by the destination.
&quot;serviceAttachment&quot;: &quot;A String&quot;, # PSC service attachments. Format: projects/*/regions/*/serviceAttachments/*
},
],
&quot;key&quot;: &quot;A String&quot;, # The key is the destination identifier that is supported by the Connector.
},
},
&quot;eventingEnablementType&quot;: &quot;A String&quot;, # Optional. Eventing enablement type. Will be nil if eventing is not enabled.
&quot;eventingRuntimeData&quot;: { # Eventing runtime data has the details related to eventing managed by the system. # Output only. Eventing Runtime Data.
&quot;eventsListenerEndpoint&quot;: &quot;A String&quot;, # Output only. Events listener endpoint. The value will populated after provisioning the events listener.
&quot;eventsListenerPscSa&quot;: &quot;A String&quot;, # Output only. Events listener PSC Service attachment. The value will be populated after provisioning the events listener with private connectivity enabled.
&quot;status&quot;: { # EventingStatus indicates the state of eventing. # Output only. Current status of eventing.
&quot;description&quot;: &quot;A String&quot;, # Output only. Description of error if State is set to &quot;ERROR&quot;.
&quot;state&quot;: &quot;A String&quot;, # Output only. State.
},
&quot;webhookData&quot;: { # WebhookData has details of webhook configuration. # Output only. Webhook data.
&quot;additionalVariables&quot;: [ # Output only. Additional webhook related field values.
{ # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
&quot;boolValue&quot;: True or False, # Value is a bool.
&quot;encryptionKeyValue&quot;: { # Encryption Key value. # Value is a Encryption Key.
&quot;kmsKeyName&quot;: &quot;A String&quot;, # 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.
&quot;type&quot;: &quot;A String&quot;, # Type.
},
&quot;intValue&quot;: &quot;A String&quot;, # Value is an integer
&quot;key&quot;: &quot;A String&quot;, # Key of the config variable.
&quot;secretValue&quot;: { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
&quot;secretVersion&quot;: &quot;A String&quot;, # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
&quot;stringValue&quot;: &quot;A String&quot;, # Value is a string.
},
],
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the webhook was created.
&quot;id&quot;: &quot;A String&quot;, # Output only. ID to uniquely identify webhook.
&quot;name&quot;: &quot;A String&quot;, # Output only. Name of the Webhook
&quot;nextRefreshTime&quot;: &quot;A String&quot;, # Output only. Next webhook refresh time. Will be null if refresh is not supported.
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the webhook was last updated.
},
},
&quot;imageLocation&quot;: &quot;A String&quot;, # Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName}
&quot;isTrustedTester&quot;: True or False, # Output only. Is trusted tester program enabled for the project.
&quot;labels&quot;: { # Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
&quot;a_key&quot;: &quot;A String&quot;,
},
&quot;lockConfig&quot;: { # 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.
&quot;locked&quot;: True or False, # Indicates whether or not the connection is locked.
&quot;reason&quot;: &quot;A String&quot;, # Describes why a connection is locked.
},
&quot;logConfig&quot;: { # Log configuration for the connection. # Optional. Log configuration for the connection.
&quot;enabled&quot;: True or False, # Enabled represents whether logging is enabled or not for a connection.
},
&quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection}
&quot;nodeConfig&quot;: { # Node configuration for the connection. # Optional. Node configuration for the connection.
&quot;maxNodeCount&quot;: 42, # Maximum number of nodes in the runtime nodes.
&quot;minNodeCount&quot;: 42, # Minimum number of nodes in the runtime nodes.
},
&quot;serviceAccount&quot;: &quot;A String&quot;, # Optional. Service account needed for runtime plane to access Google Cloud resources.
&quot;serviceDirectory&quot;: &quot;A String&quot;, # Output only. The name of the Service Directory service name. Used for Private Harpoon to resolve the ILB address. e.g. &quot;projects/cloud-connectors-e2e-testing/locations/us-central1/namespaces/istio-system/services/istio-ingressgateway-connectors&quot;
&quot;sslConfig&quot;: { # SSL Configuration of a connection # Optional. Ssl config of a connection
&quot;additionalVariables&quot;: [ # Additional SSL related field values
{ # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
&quot;boolValue&quot;: True or False, # Value is a bool.
&quot;encryptionKeyValue&quot;: { # Encryption Key value. # Value is a Encryption Key.
&quot;kmsKeyName&quot;: &quot;A String&quot;, # 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.
&quot;type&quot;: &quot;A String&quot;, # Type.
},
&quot;intValue&quot;: &quot;A String&quot;, # Value is an integer
&quot;key&quot;: &quot;A String&quot;, # Key of the config variable.
&quot;secretValue&quot;: { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
&quot;secretVersion&quot;: &quot;A String&quot;, # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
&quot;stringValue&quot;: &quot;A String&quot;, # Value is a string.
},
],
&quot;clientCertType&quot;: &quot;A String&quot;, # Type of Client Cert (PEM/JKS/.. etc.)
&quot;clientCertificate&quot;: { # Secret provides a reference to entries in Secret Manager. # Client Certificate
&quot;secretVersion&quot;: &quot;A String&quot;, # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
&quot;clientPrivateKey&quot;: { # Secret provides a reference to entries in Secret Manager. # Client Private Key
&quot;secretVersion&quot;: &quot;A String&quot;, # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
&quot;clientPrivateKeyPass&quot;: { # Secret provides a reference to entries in Secret Manager. # Secret containing the passphrase protecting the Client Private Key
&quot;secretVersion&quot;: &quot;A String&quot;, # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
&quot;privateServerCertificate&quot;: { # Secret provides a reference to entries in Secret Manager. # Private Server Certificate. Needs to be specified if trust model is `PRIVATE`.
&quot;secretVersion&quot;: &quot;A String&quot;, # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
&quot;serverCertType&quot;: &quot;A String&quot;, # Type of Server Cert (PEM/JKS/.. etc.)
&quot;trustModel&quot;: &quot;A String&quot;, # Trust Model of the SSL connection
&quot;type&quot;: &quot;A String&quot;, # Controls the ssl type for the given connector version.
&quot;useSsl&quot;: True or False, # Bool for enabling SSL
},
&quot;status&quot;: { # ConnectionStatus indicates the state of the connection. # Output only. Current status of the connection.
&quot;description&quot;: &quot;A String&quot;, # Description.
&quot;state&quot;: &quot;A String&quot;, # State.
&quot;status&quot;: &quot;A String&quot;, # Status provides detailed information for the state.
},
&quot;subscriptionType&quot;: &quot;A String&quot;, # Output only. This subscription type enum states the subscription type of the project.
&quot;suspended&quot;: True or False, # Optional. Suspended indicates if a user has suspended a connection or not.
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. Updated time.
},
],
&quot;nextPageToken&quot;: &quot;A String&quot;, # Next page token.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>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 &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>