Skip to content

Commit

Permalink
feat(integrations): update the api
Browse files Browse the repository at this point in the history
#### integrations:v1

The following keys were added:
- resources.projects.resources.locations.methods.generateOpenApiSpec (Total Keys: 12)
- schemas.GoogleCloudConnectorsV1ConnectorVersionInfraConfig.properties.deploymentModel.readOnly (Total Keys: 1)
- schemas.GoogleCloudIntegrationsV1alphaApiTriggerResource (Total Keys: 5)
- schemas.GoogleCloudIntegrationsV1alphaGenerateOpenApiSpecRequest (Total Keys: 5)
- schemas.GoogleCloudIntegrationsV1alphaGenerateOpenApiSpecResponse (Total Keys: 3)
  • Loading branch information
yoshi-automation committed Dec 10, 2024
1 parent ccd8de6 commit 84fa3b1
Show file tree
Hide file tree
Showing 6 changed files with 177 additions and 54 deletions.
30 changes: 15 additions & 15 deletions docs/dyn/integrations_v1.projects.locations.connections.html
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@ <h3>Method Details</h3>
&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;deploymentModel&quot;: &quot;A String&quot;, # Output only. Indicates whether connector is deployed on GKE/CloudRun
&quot;deploymentModelMigrationState&quot;: &quot;A String&quot;, # Output only. Status of the deployment model migration.
&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.
Expand Down Expand Up @@ -280,7 +280,7 @@ <h3>Method Details</h3>
],
&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
&quot;additionalVariables&quot;: [ # Optional. 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.
Expand All @@ -295,7 +295,7 @@ <h3>Method Details</h3>
&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;authConfig&quot;: { # AuthConfig defines details of a authentication type. # Optional. 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.
Expand Down Expand Up @@ -371,7 +371,7 @@ <h3>Method Details</h3>
&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;enrichmentEnabled&quot;: True or False, # Optional. 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.
Expand Down Expand Up @@ -456,7 +456,7 @@ <h3>Method Details</h3>
],
&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;registrationDestinationConfig&quot;: { # Define the Connectors target endpoint. # Optional. Registration endpoint for auto registration.
&quot;destinations&quot;: [ # The destinations for the key.
{
&quot;host&quot;: &quot;A String&quot;, # For publicly routable host.
Expand Down Expand Up @@ -546,7 +546,7 @@ <h3>Method Details</h3>
&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
&quot;additionalVariables&quot;: [ # Optional. 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.
Expand All @@ -561,23 +561,23 @@ <h3>Method Details</h3>
&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;clientCertType&quot;: &quot;A String&quot;, # Optional. Type of Client Cert (PEM/JKS/.. etc.)
&quot;clientCertificate&quot;: { # Secret provides a reference to entries in Secret Manager. # Optional. 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;clientPrivateKey&quot;: { # Secret provides a reference to entries in Secret Manager. # Optional. 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;clientPrivateKeyPass&quot;: { # Secret provides a reference to entries in Secret Manager. # Optional. 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;privateServerCertificate&quot;: { # Secret provides a reference to entries in Secret Manager. # Optional. 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;serverCertType&quot;: &quot;A String&quot;, # Optional. Type of Server Cert (PEM/JKS/.. etc.)
&quot;trustModel&quot;: &quot;A String&quot;, # Optional. Trust Model of the SSL connection
&quot;type&quot;: &quot;A String&quot;, # Optional. Controls the ssl type for the given connector version.
&quot;useSsl&quot;: True or False, # Optional. 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.
Expand Down
37 changes: 37 additions & 0 deletions docs/dyn/integrations_v1.projects.locations.html
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,9 @@ <h2>Instance Methods</h2>
<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="#generateOpenApiSpec">generateOpenApiSpec(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Generate OpenAPI spec for the requested integrations and api triggers</p>
<p class="toc_element">
<code><a href="#getClients">getClients(parent, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the client configuration for the given project and location resource name</p>
Expand All @@ -136,6 +139,40 @@ <h3>Method Details</h3>
<pre>Close httplib2 connections.</pre>
</div>

<div class="method">
<code class="details" id="generateOpenApiSpec">generateOpenApiSpec(name, body=None, x__xgafv=None)</code>
<pre>Generate OpenAPI spec for the requested integrations and api triggers

Args:
name: string, Required. Project and location from which the integrations should be fetched. Format: projects/{project}/location/{location} (required)
body: object, The request body.
The object takes the form of:

{ # Request for GenerateOpenApiSpec.
&quot;apiTriggerResources&quot;: [ # Required. List of api triggers
{ # List of API triggerID and their workflow resource name.
&quot;integrationResource&quot;: &quot;A String&quot;, # Required. Integration where the API is published
&quot;triggerId&quot;: [ # Required. Trigger Id of the API trigger(s) in the integration
&quot;A String&quot;,
],
},
],
&quot;fileFormat&quot;: &quot;A String&quot;, # Required. File format for generated spec.
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Response of the GenerateOpenApiSpec API.
&quot;openApiSpec&quot;: &quot;A String&quot;, # Open API spec as per the required format
}</pre>
</div>

<div class="method">
<code class="details" id="getClients">getClients(parent, x__xgafv=None)</code>
<pre>Gets the client configuration for the given project and location resource name
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -464,7 +464,7 @@ <h3>Method Details</h3>
body: object, The request body.
The object takes the form of:

{ # The request for scheduling an integration. Next available id: 11
{ # The request for scheduling an integration.
&quot;inputParameters&quot;: { # Optional. Input parameters used by integration execution.
&quot;a_key&quot;: { # The type of the parameter.
&quot;booleanArray&quot;: { # This message only contains a field of boolean array. # Boolean Array.
Expand Down
Loading

0 comments on commit 84fa3b1

Please sign in to comment.