blob: 2e835ac7603eb8e566cc146fa3d6bd030a4617ec [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.integrations.html">integrations</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="integrations_v1alpha.projects.locations.integrations.executions.html">executions()</a></code>
</p>
<p class="firstline">Returns the executions Resource.</p>
<p class="toc_element">
<code><a href="integrations_v1alpha.projects.locations.integrations.versions.html">versions()</a></code>
</p>
<p class="firstline">Returns the versions 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="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Delete the selected integration and all versions inside</p>
<p class="toc_element">
<code><a href="#execute">execute(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Executes integrations synchronously by passing the trigger id in the request body. The request is not returned until the requested executions are either fulfilled or experienced an error. If the integration name is not specified (passing `-`), all of the associated integration under the given trigger_id will be executed. Otherwise only the specified integration for the given `trigger_id` is executed. This is helpful for execution the integration from UI.</p>
<p class="toc_element">
<code><a href="#executeEvent">executeEvent(name, body=None, triggerId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Executes an integration on receiving events from Integration Connector triggers, Eventarc or CPS Trigger. Input data to integration is received in body in json format</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">Returns the list of all integrations in the specified project.</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>
<p class="toc_element">
<code><a href="#schedule">schedule(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Schedules an integration for execution by passing the trigger id and the scheduled time in the request body.</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="delete">delete(name, x__xgafv=None)</code>
<pre>Delete the selected integration and all versions inside
Args:
name: string, Required. The location resource of the request. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
<div class="method">
<code class="details" id="execute">execute(name, body=None, x__xgafv=None)</code>
<pre>Executes integrations synchronously by passing the trigger id in the request body. The request is not returned until the requested executions are either fulfilled or experienced an error. If the integration name is not specified (passing `-`), all of the associated integration under the given trigger_id will be executed. Otherwise only the specified integration for the given `trigger_id` is executed. This is helpful for execution the integration from UI.
Args:
name: string, Required. The integration resource name. (required)
body: object, The request body.
The object takes the form of:
{ # The request for executing an integration.
&quot;doNotPropagateError&quot;: True or False, # Optional. Flag to determine how to should propagate errors. If this flag is set to be true, it will not throw an exception. Instead, it will return a {@link ExecuteIntegrationsResponse} with an execution id and error messages as PostWithTriggerIdExecutionException in {@link EventParameters}. The flag is set to be false by default.
&quot;executionId&quot;: &quot;A String&quot;, # Optional. The id of the ON_HOLD execution to be resumed.
&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.
&quot;booleanValues&quot;: [ # Boolean array.
True or False,
],
},
&quot;booleanValue&quot;: True or False, # Boolean.
&quot;doubleArray&quot;: { # This message only contains a field of double number array. # Double Number Array.
&quot;doubleValues&quot;: [ # Double number array.
3.14,
],
},
&quot;doubleValue&quot;: 3.14, # Double Number.
&quot;intArray&quot;: { # This message only contains a field of integer array. # Integer Array.
&quot;intValues&quot;: [ # Integer array.
&quot;A String&quot;,
],
},
&quot;intValue&quot;: &quot;A String&quot;, # Integer.
&quot;jsonValue&quot;: &quot;A String&quot;, # Json.
&quot;stringArray&quot;: { # This message only contains a field of string array. # String Array.
&quot;stringValues&quot;: [ # String array.
&quot;A String&quot;,
],
},
&quot;stringValue&quot;: &quot;A String&quot;, # String.
},
},
&quot;parameterEntries&quot;: [ # Optional. Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
{ # Key-value pair of EventBus parameters.
&quot;dataType&quot;: &quot;A String&quot;, # Explicitly getting the type of the parameter.
&quot;key&quot;: &quot;A String&quot;, # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
&quot;masked&quot;: True or False, # True if this parameter should be masked in the logs
&quot;value&quot;: { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
&quot;booleanArray&quot;: {
&quot;booleanValues&quot;: [
True or False,
],
},
&quot;booleanValue&quot;: True or False,
&quot;doubleArray&quot;: {
&quot;doubleValues&quot;: [
3.14,
],
},
&quot;doubleValue&quot;: 3.14,
&quot;intArray&quot;: {
&quot;intValues&quot;: [
&quot;A String&quot;,
],
},
&quot;intValue&quot;: &quot;A String&quot;,
&quot;jsonValue&quot;: &quot;A String&quot;,
&quot;protoArray&quot;: {
&quot;protoValues&quot;: [
{
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
],
},
&quot;protoValue&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
&quot;serializedObjectValue&quot;: {
&quot;objectValue&quot;: &quot;A String&quot;,
},
&quot;stringArray&quot;: {
&quot;stringValues&quot;: [
&quot;A String&quot;,
],
},
&quot;stringValue&quot;: &quot;A String&quot;,
},
},
],
&quot;parameters&quot;: { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Optional. Passed in as parameters to each integration execution. Redacted
&quot;parameters&quot;: [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
{ # Key-value pair of EventBus parameters.
&quot;dataType&quot;: &quot;A String&quot;, # Explicitly getting the type of the parameter.
&quot;key&quot;: &quot;A String&quot;, # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
&quot;masked&quot;: True or False, # True if this parameter should be masked in the logs
&quot;value&quot;: { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
&quot;booleanArray&quot;: {
&quot;booleanValues&quot;: [
True or False,
],
},
&quot;booleanValue&quot;: True or False,
&quot;doubleArray&quot;: {
&quot;doubleValues&quot;: [
3.14,
],
},
&quot;doubleValue&quot;: 3.14,
&quot;intArray&quot;: {
&quot;intValues&quot;: [
&quot;A String&quot;,
],
},
&quot;intValue&quot;: &quot;A String&quot;,
&quot;jsonValue&quot;: &quot;A String&quot;,
&quot;protoArray&quot;: {
&quot;protoValues&quot;: [
{
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
],
},
&quot;protoValue&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
&quot;serializedObjectValue&quot;: {
&quot;objectValue&quot;: &quot;A String&quot;,
},
&quot;stringArray&quot;: {
&quot;stringValues&quot;: [
&quot;A String&quot;,
],
},
&quot;stringValue&quot;: &quot;A String&quot;,
},
},
],
},
&quot;requestId&quot;: &quot;A String&quot;, # Optional. This is used to de-dup incoming request: if the duplicate request was detected, the response from the previous execution is returned.
&quot;triggerId&quot;: &quot;A String&quot;, # Required. Matched against all {@link TriggerConfig}s across all integrations. i.e. TriggerConfig.trigger_id.equals(trigger_id). The trigger_id is in the format of `api_trigger/TRIGGER_NAME`.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response for executing an integration.
&quot;eventParameters&quot;: { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Details for the integration that were executed.
&quot;parameters&quot;: [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
{ # Key-value pair of EventBus parameters.
&quot;dataType&quot;: &quot;A String&quot;, # Explicitly getting the type of the parameter.
&quot;key&quot;: &quot;A String&quot;, # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
&quot;masked&quot;: True or False, # True if this parameter should be masked in the logs
&quot;value&quot;: { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
&quot;booleanArray&quot;: {
&quot;booleanValues&quot;: [
True or False,
],
},
&quot;booleanValue&quot;: True or False,
&quot;doubleArray&quot;: {
&quot;doubleValues&quot;: [
3.14,
],
},
&quot;doubleValue&quot;: 3.14,
&quot;intArray&quot;: {
&quot;intValues&quot;: [
&quot;A String&quot;,
],
},
&quot;intValue&quot;: &quot;A String&quot;,
&quot;jsonValue&quot;: &quot;A String&quot;,
&quot;protoArray&quot;: {
&quot;protoValues&quot;: [
{
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
],
},
&quot;protoValue&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
&quot;serializedObjectValue&quot;: {
&quot;objectValue&quot;: &quot;A String&quot;,
},
&quot;stringArray&quot;: {
&quot;stringValues&quot;: [
&quot;A String&quot;,
],
},
&quot;stringValue&quot;: &quot;A String&quot;,
},
},
],
},
&quot;executionFailed&quot;: True or False, # Is true if any execution in the integration failed. False otherwise.
&quot;executionId&quot;: &quot;A String&quot;, # The id of the execution corresponding to this run of integration.
&quot;outputParameters&quot;: { # OUTPUT parameters in format of Map. Where Key is the name of the parameter. Note: Name of the system generated parameters are wrapped by backtick(`) to distinguish them from the user defined parameters.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
&quot;parameterEntries&quot;: [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
{ # Key-value pair of EventBus parameters.
&quot;dataType&quot;: &quot;A String&quot;, # Explicitly getting the type of the parameter.
&quot;key&quot;: &quot;A String&quot;, # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
&quot;masked&quot;: True or False, # True if this parameter should be masked in the logs
&quot;value&quot;: { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
&quot;booleanArray&quot;: {
&quot;booleanValues&quot;: [
True or False,
],
},
&quot;booleanValue&quot;: True or False,
&quot;doubleArray&quot;: {
&quot;doubleValues&quot;: [
3.14,
],
},
&quot;doubleValue&quot;: 3.14,
&quot;intArray&quot;: {
&quot;intValues&quot;: [
&quot;A String&quot;,
],
},
&quot;intValue&quot;: &quot;A String&quot;,
&quot;jsonValue&quot;: &quot;A String&quot;,
&quot;protoArray&quot;: {
&quot;protoValues&quot;: [
{
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
],
},
&quot;protoValue&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
&quot;serializedObjectValue&quot;: {
&quot;objectValue&quot;: &quot;A String&quot;,
},
&quot;stringArray&quot;: {
&quot;stringValues&quot;: [
&quot;A String&quot;,
],
},
&quot;stringValue&quot;: &quot;A String&quot;,
},
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="executeEvent">executeEvent(name, body=None, triggerId=None, x__xgafv=None)</code>
<pre>Executes an integration on receiving events from Integration Connector triggers, Eventarc or CPS Trigger. Input data to integration is received in body in json format
Args:
name: string, Required. The integration resource name. Format: projects/{gcp_project_id}/locations/{location}/integrations/{integration_id} (required)
body: object, The request body.
triggerId: string, Required. Id of the integration trigger config. The trigger_id is in the format: `integration_connector_trigger/projects/{gcp_project_id}/location/{location}/connections/{connection_name}/subscriptions/{subscription_name}`.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response for executing an integration.
&quot;executionId&quot;: &quot;A String&quot;, # The id of the execution corresponding to this run of integration.
}</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>Returns the list of all integrations in the specified project.
Args:
parent: string, Required. Project and location from which the integrations should be listed. Format: projects/{project} (required)
filter: string, Filter on fields of IntegrationVersion. Fields can be compared with literal values by use of &quot;:&quot; (containment), &quot;=&quot; (equality), &quot;&gt;&quot; (greater), &quot;&lt;&quot; (less than), &gt;=&quot; (greater than or equal to), &quot;&lt;=&quot; (less than or equal to), and &quot;!=&quot; (inequality) operators. Negation, conjunction, and disjunction are written using NOT, AND, and OR keywords. For example, organization_id=\&quot;1\&quot; AND state=ACTIVE AND description:&quot;test&quot;. Filtering cannot be performed on repeated fields like `task_config`.
orderBy: string, The results would be returned in order you specified here. Supported sort keys are: Descending sort order by &quot;last_modified_time&quot;, &quot;created_time&quot;, &quot;snapshot_number&quot;. Ascending sort order by the integration name.
pageSize: integer, The page size for the resquest.
pageToken: string, The page token for the resquest.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for ListIntegrations.
&quot;integrations&quot;: [ # The integrations which match the request.
{ # The integration definition.
&quot;active&quot;: True or False, # Required. If any integration version is published.
&quot;creatorEmail&quot;: &quot;A String&quot;, # Output only. The creator&#x27;s email address. Generated based on the End User Credentials/LOAS role of the user making the call.
&quot;description&quot;: &quot;A String&quot;, # Optional.
&quot;lastModifierEmail&quot;: &quot;A String&quot;, # Required. The last modifier of this integration
&quot;name&quot;: &quot;A String&quot;, # Required. The resource name of the integration.
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. Auto-generated.
},
],
&quot;nextPageToken&quot;: &quot;A String&quot;, # The next page token for the response.
}</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>
<div class="method">
<code class="details" id="schedule">schedule(name, body=None, x__xgafv=None)</code>
<pre>Schedules an integration for execution by passing the trigger id and the scheduled time in the request body.
Args:
name: string, The integration resource name. (required)
body: object, The request body.
The object takes the form of:
{ # The request for scheduling an integration. Next available id: 11
&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.
&quot;booleanValues&quot;: [ # Boolean array.
True or False,
],
},
&quot;booleanValue&quot;: True or False, # Boolean.
&quot;doubleArray&quot;: { # This message only contains a field of double number array. # Double Number Array.
&quot;doubleValues&quot;: [ # Double number array.
3.14,
],
},
&quot;doubleValue&quot;: 3.14, # Double Number.
&quot;intArray&quot;: { # This message only contains a field of integer array. # Integer Array.
&quot;intValues&quot;: [ # Integer array.
&quot;A String&quot;,
],
},
&quot;intValue&quot;: &quot;A String&quot;, # Integer.
&quot;jsonValue&quot;: &quot;A String&quot;, # Json.
&quot;stringArray&quot;: { # This message only contains a field of string array. # String Array.
&quot;stringValues&quot;: [ # String array.
&quot;A String&quot;,
],
},
&quot;stringValue&quot;: &quot;A String&quot;, # String.
},
},
&quot;parameterEntries&quot;: [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
{ # Key-value pair of EventBus parameters.
&quot;dataType&quot;: &quot;A String&quot;, # Explicitly getting the type of the parameter.
&quot;key&quot;: &quot;A String&quot;, # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
&quot;masked&quot;: True or False, # True if this parameter should be masked in the logs
&quot;value&quot;: { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
&quot;booleanArray&quot;: {
&quot;booleanValues&quot;: [
True or False,
],
},
&quot;booleanValue&quot;: True or False,
&quot;doubleArray&quot;: {
&quot;doubleValues&quot;: [
3.14,
],
},
&quot;doubleValue&quot;: 3.14,
&quot;intArray&quot;: {
&quot;intValues&quot;: [
&quot;A String&quot;,
],
},
&quot;intValue&quot;: &quot;A String&quot;,
&quot;jsonValue&quot;: &quot;A String&quot;,
&quot;protoArray&quot;: {
&quot;protoValues&quot;: [
{
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
],
},
&quot;protoValue&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
&quot;serializedObjectValue&quot;: {
&quot;objectValue&quot;: &quot;A String&quot;,
},
&quot;stringArray&quot;: {
&quot;stringValues&quot;: [
&quot;A String&quot;,
],
},
&quot;stringValue&quot;: &quot;A String&quot;,
},
},
],
&quot;parameters&quot;: { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Passed in as parameters to each integration execution.
&quot;parameters&quot;: [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
{ # Key-value pair of EventBus parameters.
&quot;key&quot;: &quot;A String&quot;, # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
&quot;masked&quot;: True or False, # True if this parameter should be masked in the logs
&quot;value&quot;: { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
&quot;booleanArray&quot;: {
&quot;booleanValues&quot;: [
True or False,
],
},
&quot;booleanValue&quot;: True or False,
&quot;doubleArray&quot;: {
&quot;doubleValues&quot;: [
3.14,
],
},
&quot;doubleValue&quot;: 3.14,
&quot;intArray&quot;: {
&quot;intValues&quot;: [
&quot;A String&quot;,
],
},
&quot;intValue&quot;: &quot;A String&quot;,
&quot;protoArray&quot;: {
&quot;protoValues&quot;: [
{
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
],
},
&quot;protoValue&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
&quot;serializedObjectValue&quot;: {
&quot;objectValue&quot;: &quot;A String&quot;,
},
&quot;stringArray&quot;: {
&quot;stringValues&quot;: [
&quot;A String&quot;,
],
},
&quot;stringValue&quot;: &quot;A String&quot;,
},
},
],
},
&quot;requestId&quot;: &quot;A String&quot;, # This is used to de-dup incoming request: if the duplicate request was detected, the response from the previous execution is returned.
&quot;scheduleTime&quot;: &quot;A String&quot;, # The time that the integration should be executed. If the time is less or equal to the current time, the integration is executed immediately.
&quot;triggerId&quot;: &quot;A String&quot;, # Required. Matched against all {@link TriggerConfig}s across all integrations. i.e. TriggerConfig.trigger_id.equals(trigger_id)
&quot;userGeneratedExecutionId&quot;: &quot;A String&quot;, # Optional. This is a unique id provided by the method caller. If provided this will be used as the execution_id when a new execution info is created. This is a string representation of a UUID. Must have no more than 36 characters and contain only alphanumeric characters and hyphens.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response for executing an integration.
&quot;executionInfoIds&quot;: [ # The execution info id for the executed integrations.
&quot;A String&quot;,
],
}</pre>
</div>
</body></html>