Application Integration API . projects . locations . products . integrations

Instance Methods

executions()

Returns the executions Resource.

executionsnapshots()

Returns the executionsnapshots Resource.

versions()

Returns the versions Resource.

archiveBundle(name, body=None, x__xgafv=None)

PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. Soft-deletes the bundle.

close()

Close httplib2 connections.

execute(name, body=None, x__xgafv=None)

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.

list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

Returns the list of all integrations in the specified project.

list_next()

Retrieves the next page of results.

monitorexecutionstats(parent, body=None, x__xgafv=None)

Get execution stats

schedule(name, body=None, x__xgafv=None)

Schedules an integration for execution by passing the trigger id and the scheduled time in the request body.

Method Details

archiveBundle(name, body=None, x__xgafv=None)
PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. Soft-deletes the bundle.

Args:
  name: string, Required. The bundle to archive. Format: projects/{project}/locations/{location}/integrations/{integration} (required)
  body: object, The request body.
    The object takes the form of:

{ # Request for ArchiveBundle.
}

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

Returns:
  An object of the form:

    { # Response for ArchiveBundle.
}
close()
Close httplib2 connections.
execute(name, body=None, x__xgafv=None)
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.
  "doNotPropagateError": 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.
  "executionId": "A String", # Optional. The id of the ON_HOLD execution to be resumed.
  "inputParameters": { # Optional. Input parameters used by integration execution.
    "a_key": { # The type of the parameter.
      "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
        "booleanValues": [ # Boolean array.
          True or False,
        ],
      },
      "booleanValue": True or False, # Boolean.
      "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
        "doubleValues": [ # Double number array.
          3.14,
        ],
      },
      "doubleValue": 3.14, # Double Number.
      "intArray": { # This message only contains a field of integer array. # Integer Array.
        "intValues": [ # Integer array.
          "A String",
        ],
      },
      "intValue": "A String", # Integer.
      "jsonValue": "A String", # Json.
      "stringArray": { # This message only contains a field of string array. # String Array.
        "stringValues": [ # String array.
          "A String",
        ],
      },
      "stringValue": "A String", # String.
    },
  },
  "parameterEntries": [ # 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.
      "dataType": "A String", # Explicitly getting the type of the parameter.
      "key": "A String", # 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.
      "value": { # 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.
        "booleanArray": {
          "booleanValues": [
            True or False,
          ],
        },
        "booleanValue": True or False,
        "doubleArray": {
          "doubleValues": [
            3.14,
          ],
        },
        "doubleValue": 3.14,
        "intArray": {
          "intValues": [
            "A String",
          ],
        },
        "intValue": "A String",
        "jsonValue": "A String",
        "protoArray": {
          "protoValues": [
            {
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          ],
        },
        "protoValue": {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
        "serializedObjectValue": {
          "objectValue": "A String",
        },
        "stringArray": {
          "stringValues": [
            "A String",
          ],
        },
        "stringValue": "A String",
      },
    },
  ],
  "parameters": { # 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 go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. Passed in as parameters to each integration execution. Redacted
    "parameters": [ # 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.
        "dataType": "A String", # Explicitly getting the type of the parameter.
        "key": "A String", # 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.
        "value": { # 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.
          "booleanArray": {
            "booleanValues": [
              True or False,
            ],
          },
          "booleanValue": True or False,
          "doubleArray": {
            "doubleValues": [
              3.14,
            ],
          },
          "doubleValue": 3.14,
          "intArray": {
            "intValues": [
              "A String",
            ],
          },
          "intValue": "A String",
          "jsonValue": "A String",
          "protoArray": {
            "protoValues": [
              {
                "a_key": "", # Properties of the object. Contains field @type with type URL.
              },
            ],
          },
          "protoValue": {
            "a_key": "", # Properties of the object. Contains field @type with type URL.
          },
          "serializedObjectValue": {
            "objectValue": "A String",
          },
          "stringArray": {
            "stringValues": [
              "A String",
            ],
          },
          "stringValue": "A String",
        },
      },
    ],
  },
  "requestId": "A String", # Optional. This is used to de-dup incoming request: if the duplicate request was detected, the response from the previous execution is returned.
  "triggerId": "A String", # 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.
  "eventParameters": { # 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 go/integration-platform/event_bus.md for more details. Next id: 4 # Details for the integration that were executed.
    "parameters": [ # 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.
        "dataType": "A String", # Explicitly getting the type of the parameter.
        "key": "A String", # 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.
        "value": { # 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.
          "booleanArray": {
            "booleanValues": [
              True or False,
            ],
          },
          "booleanValue": True or False,
          "doubleArray": {
            "doubleValues": [
              3.14,
            ],
          },
          "doubleValue": 3.14,
          "intArray": {
            "intValues": [
              "A String",
            ],
          },
          "intValue": "A String",
          "jsonValue": "A String",
          "protoArray": {
            "protoValues": [
              {
                "a_key": "", # Properties of the object. Contains field @type with type URL.
              },
            ],
          },
          "protoValue": {
            "a_key": "", # Properties of the object. Contains field @type with type URL.
          },
          "serializedObjectValue": {
            "objectValue": "A String",
          },
          "stringArray": {
            "stringValues": [
              "A String",
            ],
          },
          "stringValue": "A String",
        },
      },
    ],
  },
  "executionFailed": True or False, # Is true if any execution in the integration failed. False otherwise.
  "executionId": "A String", # The id of the execution corresponding to this run of integration.
  "outputParameters": { # 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.
    "a_key": "", # Properties of the object.
  },
  "parameterEntries": [ # 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.
      "dataType": "A String", # Explicitly getting the type of the parameter.
      "key": "A String", # 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.
      "value": { # 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.
        "booleanArray": {
          "booleanValues": [
            True or False,
          ],
        },
        "booleanValue": True or False,
        "doubleArray": {
          "doubleValues": [
            3.14,
          ],
        },
        "doubleValue": 3.14,
        "intArray": {
          "intValues": [
            "A String",
          ],
        },
        "intValue": "A String",
        "jsonValue": "A String",
        "protoArray": {
          "protoValues": [
            {
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          ],
        },
        "protoValue": {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
        "serializedObjectValue": {
          "objectValue": "A String",
        },
        "stringArray": {
          "stringValues": [
            "A String",
          ],
        },
        "stringValue": "A String",
      },
    },
  ],
}
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
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 ":" (containment), "=" (equality), ">" (greater), "<" (less than), >=" (greater than or equal to), "<=" (less than or equal to), and "!=" (inequality) operators. Negation, conjunction, and disjunction are written using NOT, AND, and OR keywords. For example, organization_id=\"1\" AND state=ACTIVE AND description:"test". 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 "last_modified_time", "created_time", "snapshot_number". 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.
  "integrations": [ # The integrations which match the request.
    { # The integration definition.
      "active": True or False, # Required. If any integration version is published.
      "description": "A String", # Optional.
      "name": "A String", # Required. The resource name of the integration.
      "updateTime": "A String", # Output only. Auto-generated.
    },
  ],
  "nextPageToken": "A String", # The next page token for the response.
}
list_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.
        
monitorexecutionstats(parent, body=None, x__xgafv=None)
Get execution stats

Args:
  parent: string, Required. The parent resource name: {parent=projects/*/locations/*}. (required)
  body: object, The request body.
    The object takes the form of:

{ # The request to get data for monarch connector config.
  "duration": "A String", # How long the series data range: "1h","1d",etc.
  "endTime": "A String", # Final time to query over, or the current time if left unset.
  "mashQuery": { # The MashQuery for searching data, set both queries for Join Operation. # Required. Query for searching data in monarch.
    "firstQuery": { # The components for constructing MashQuery. # Required. The components for constructing a mash query. Set "point_operation" if this is a single query
      "borgTaskMetric": "A String", # Required. The metric for monarch.BorgTask.
      "dataFilters": [ # Optional. optional, filters on fetched data, "metric:client_id" not supported.
        "A String",
      ],
      "fetchFilters": [ # Optional. optional, filters for Fetch Raw, "metric:client_id" not supported.
        "A String",
      ],
      "groupBy": { # MashQuery GroupBy parameters. # Optional. optional, GroupBy variables.
        "fields": [ # Optional. optional, metrics list for GroupBy.
          "A String",
        ],
        "reducer": "A String", # Optional. optional, reduce function for GroupBy.
      },
      "pointOperation": "A String", # Optional. optional, Point Operation on single query or joined query.
      "timeDelta": "A String", # Required. Window time delta.
    },
    "operationMode": { # Operation between 2 query # Optional. optional, only set when joining 2 queries. By default join 2 queries with join operation.
      "joinConfig": { # Join Operation # Optional. join operation
      },
      "operationType": "A String", # Optional. optional operation types.
      "unionConfig": { # Union operation # Optional. union operation
        "reducer": "A String", # Optional. optional, reduce function
      },
    },
    "secondQuery": { # The components for constructing MashQuery. # Optional. optional, only set when joining 2 queries. Set "point_operation" for joined query.
      "borgTaskMetric": "A String", # Required. The metric for monarch.BorgTask.
      "dataFilters": [ # Optional. optional, filters on fetched data, "metric:client_id" not supported.
        "A String",
      ],
      "fetchFilters": [ # Optional. optional, filters for Fetch Raw, "metric:client_id" not supported.
        "A String",
      ],
      "groupBy": { # MashQuery GroupBy parameters. # Optional. optional, GroupBy variables.
        "fields": [ # Optional. optional, metrics list for GroupBy.
          "A String",
        ],
        "reducer": "A String", # Optional. optional, reduce function for GroupBy.
      },
      "pointOperation": "A String", # Optional. optional, Point Operation on single query or joined query.
      "timeDelta": "A String", # Required. Window time delta.
    },
  },
  "metricFieldTable": True or False, # Returns a table of all possible metric field values within the specified duration, ignoring any data samples. Useful for autocomplete functionality.
  "outputPeriod": "A String", # The output period for the query. Must be set if there is a window operation within the query and unset otherwise.
  "responseTemplate": "A String", # Required. Template for response.
}

  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 getting Execution stats.
  "aplosSeriesListData": { # Data used for Aplos charts that accept multiple Series. # List of points.
    "series": [
      {
        "data": { # Data used to render an Aplos Series card.
          "rows": [ # A single Series Row
            { # Aplos series row is exactly two columns labeled x and y.
              "x": {
                "booleanValue": True or False,
                "doubleValue": 3.14,
                "empty": { # 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); }
                },
                "longValue": "A String",
                "stringValue": "A String",
              },
              "y": {
                "booleanValue": True or False,
                "doubleValue": 3.14,
                "empty": { # 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); }
                },
                "longValue": "A String",
                "stringValue": "A String",
              },
            },
          ],
        },
        "name": "A String",
      },
    ],
  },
  "tableData": { # The generic data format returned from all connectors. # Data in form of table.
    "headers": [ # Ordered list of column headers.
      "A String",
    ],
    "rows": [ # Ordered list of table rows.
      {
        "cells": [ # Ordered list of cell values within a row.
          {
            "booleanValue": True or False,
            "doubleValue": 3.14,
            "empty": { # 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); }
            },
            "longValue": "A String",
            "stringValue": "A String",
          },
        ],
      },
    ],
  },
}
schedule(name, body=None, x__xgafv=None)
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.
  "inputParameters": { # Optional. Input parameters used by integration execution.
    "a_key": { # The type of the parameter.
      "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
        "booleanValues": [ # Boolean array.
          True or False,
        ],
      },
      "booleanValue": True or False, # Boolean.
      "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
        "doubleValues": [ # Double number array.
          3.14,
        ],
      },
      "doubleValue": 3.14, # Double Number.
      "intArray": { # This message only contains a field of integer array. # Integer Array.
        "intValues": [ # Integer array.
          "A String",
        ],
      },
      "intValue": "A String", # Integer.
      "jsonValue": "A String", # Json.
      "stringArray": { # This message only contains a field of string array. # String Array.
        "stringValues": [ # String array.
          "A String",
        ],
      },
      "stringValue": "A String", # String.
    },
  },
  "parameterEntries": [ # 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.
      "dataType": "A String", # Explicitly getting the type of the parameter.
      "key": "A String", # 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.
      "value": { # 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.
        "booleanArray": {
          "booleanValues": [
            True or False,
          ],
        },
        "booleanValue": True or False,
        "doubleArray": {
          "doubleValues": [
            3.14,
          ],
        },
        "doubleValue": 3.14,
        "intArray": {
          "intValues": [
            "A String",
          ],
        },
        "intValue": "A String",
        "jsonValue": "A String",
        "protoArray": {
          "protoValues": [
            {
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          ],
        },
        "protoValue": {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
        "serializedObjectValue": {
          "objectValue": "A String",
        },
        "stringArray": {
          "stringValues": [
            "A String",
          ],
        },
        "stringValue": "A String",
      },
    },
  ],
  "parameters": { # 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 go/integration-platform/event_bus.md for more details. Next id: 4 # Passed in as parameters to each integration execution.
    "parameters": [ # 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.
        "key": "A String", # 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.
        "value": { # 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.
          "booleanArray": {
            "booleanValues": [
              True or False,
            ],
          },
          "booleanValue": True or False,
          "doubleArray": {
            "doubleValues": [
              3.14,
            ],
          },
          "doubleValue": 3.14,
          "intArray": {
            "intValues": [
              "A String",
            ],
          },
          "intValue": "A String",
          "protoArray": {
            "protoValues": [
              {
                "a_key": "", # Properties of the object. Contains field @type with type URL.
              },
            ],
          },
          "protoValue": {
            "a_key": "", # Properties of the object. Contains field @type with type URL.
          },
          "serializedObjectValue": {
            "objectValue": "A String",
          },
          "stringArray": {
            "stringValues": [
              "A String",
            ],
          },
          "stringValue": "A String",
        },
      },
    ],
  },
  "requestId": "A String", # This is used to de-dup incoming request: if the duplicate request was detected, the response from the previous execution is returned.
  "scheduleTime": "A String", # The time that the integration should be executed. If the time is less or equal to the current time, the integration is executed immediately.
  "triggerId": "A String", # Matched against all {@link TriggerConfig}s across all integrations. i.e. TriggerConfig.trigger_id.equals(trigger_id)
}

  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.
  "executionInfoIds": [ # The execution info id for the executed integrations.
    "A String",
  ],
}