| <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_v1.html">Application Integration API</a> . <a href="integrations_v1.projects.html">projects</a> . <a href="integrations_v1.projects.locations.html">locations</a> . <a href="integrations_v1.projects.locations.connections.html">connections</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="integrations_v1.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_v1.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. |
| "actions": [ # List of actions. |
| "A String", |
| ], |
| "entities": [ # List of entity names. |
| "A String", |
| ], |
| }</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. |
| "connections": [ # Connections. |
| { # Connection represents an instance of connector. |
| "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. |
| "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. |
| }, |
| ], |
| "authType": "A String", # The type of authentication configured. |
| "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. |
| }, |
| }, |
| "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. |
| "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. |
| }, |
| ], |
| "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. |
| "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} |
| "imageLocation": "A String", # Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName} |
| "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. |
| }, |
| "name": "A String", # Output only. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection} |
| "nodeConfig": { # Configuration for the connection. # Optional. 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 GCP 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" |
| "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. |
| }, |
| "suspended": True or False, # Optional. Suspended indicates if a user has suspended a connection or not. |
| "updateTime": "A String", # Output only. Updated time. |
| }, |
| ], |
| "nextPageToken": "A String", # 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 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| </body></html> |
