Returns the suspensions Resource.
cancel(name, body=None, x__xgafv=None)
Cancellation of an execution and associated sub-executions. This will not cancel an IN_PROCESS or completed(SUCCESSFUL, FAILED or CANCELLED) executions.
Close httplib2 connections.
Download the execution.
Get an execution in the specified project.
Lists the results of all the integration executions. The response includes the same information as the [execution log](https://cloud.google.com/application-integration/docs/viewing-logs) in the Integration UI.
Retrieves the next page of results.
replay(name, body=None, x__xgafv=None)
Re-execute an existing execution, with same request parameters and execution strategy.
cancel(name, body=None, x__xgafv=None)
Cancellation of an execution and associated sub-executions. This will not cancel an IN_PROCESS or completed(SUCCESSFUL, FAILED or CANCELLED) executions.
Args:
name: string, Required. The execution resource name. Format: projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_id}/executions/{execution_id} (required)
body: object, The request body.
The object takes the form of:
{ # Request for cancelling an execution.
"cancelReason": "A String", # Required. Reason for cancelling the execution. This is provided by the client requesting the cancellation, and is not used by the Platform.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for cancelling an execution.
"isCanceled": True or False, # True if cancellation performed successfully.
}
close()
Close httplib2 connections.
download(name, x__xgafv=None)
Download the execution.
Args:
name: string, Required. The execution resource name. Format: projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_id}/executions/{execution_id} (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for downloading an execution.
"content": "A String", # The content of downloaded execution.
}
get(name, x__xgafv=None)
Get an execution in the specified project.
Args:
name: string, Required. The execution resource name. Format: projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_id}/executions/{execution_id} (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The Execution resource contains detailed information of an individual integration execution.
"cloudLoggingDetails": { # Cloud Logging details for execution info # Cloud Logging details for the integration version
"cloudLoggingSeverity": "A String", # Optional. Severity selected by the customer for the logs to be sent to Cloud Logging, for the integration version getting executed.
"enableCloudLogging": True or False, # Optional. Status of whether Cloud Logging is enabled or not for the integration version getting executed.
},
"createTime": "A String", # Output only. Created time of the execution.
"directSubExecutions": [ # Direct sub executions of the following Execution.
# Object with schema name: GoogleCloudIntegrationsV1alphaExecution
],
"eventExecutionDetails": { # Contains the details of the execution info of this event: this includes the tasks execution details plus the event execution statistics. Next available id: 12 # The execution info about this event.
"cancelReason": "A String", # If the execution is manually canceled, this field will contain the reason for cancellation.
"eventAttemptStats": [
{
"endTime": "A String", # The end time of the event execution for current attempt.
"startTime": "A String", # The start time of the event execution for current attempt. This could be in the future if it's been scheduled.
},
],
"eventExecutionSnapshot": [
{ # Contains the snapshot of the event execution for a given checkpoint. Next available id: 15
"checkpointTaskNumber": "A String", # Indicates "right after which checkpoint task's execution" this snapshot is taken.
"clientId": "A String", # Client that the execution snapshot is associated to.
"conditionResults": [ # All of the computed conditions that been calculated.
{ # Contains the combined condition calculation results.
"currentTaskNumber": "A String", # the current task number.
"nextTaskNumber": "A String", # the next task number.
"result": True or False, # the result comes out after evaluate the combined condition. True if there's no combined condition specified.
},
],
"diffParams": { # 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 # The parameters in Event object that differs from last snapshot.
"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.
"masked": True or False, # True if this parameter should be masked in the logs
"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",
},
},
],
},
"eventExecutionInfoId": "A String", # Points to the event execution info this snapshot belongs to.
"eventExecutionSnapshotId": "A String", # Auto-generated. Used as primary key for EventExecutionSnapshots table.
"eventExecutionSnapshotMetadata": {
"ancestorIterationNumbers": [ # Ancestor iteration number for the task(it will only be non-empty if the task is under 'private workflow')
"A String",
],
"ancestorTaskNumbers": [ # Ancestor task number for the task(it will only be non-empty if the task is under 'private workflow')
"A String",
],
"eventAttemptNum": 42, # the event attempt number this snapshot belongs to.
"integrationName": "A String", # The direct integration which the event execution snapshots belongs to
"taskAttemptNum": 42, # the task attempt number this snapshot belongs to. Could be empty.
"taskLabel": "A String", # the task label associated with this snapshot. Could be empty.
"taskName": "A String", # the task name associated with this snapshot. Could be empty.
"taskNumber": "A String", # The task number associated with this snapshot. Could be empty.
},
"eventParams": { # 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 # The parameters in Event object.
"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.
"masked": True or False, # True if this parameter should be masked in the logs
"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",
},
},
],
},
"exceedMaxSize": True or False, # indicate whether snapshot exceeded maximum size before clean up
"snapshotTime": "A String", # Indicates when this snapshot is taken.
"taskExecutionDetails": [ # All of the task execution details at the given point of time.
{ # Contains the details of the execution of this task. Next available id: 11
"taskAttemptStats": [
{
"endTime": "A String", # The end time of the task execution for current attempt.
"startTime": "A String", # The start time of the task execution for current attempt. This could be in the future if it's been scheduled.
},
],
"taskExecutionState": "A String",
"taskNumber": "A String", # Pointer to the task config it used for execution.
},
],
"taskName": "A String", # The task name associated with this snapshot. Could be empty.
"workflowName": "A String", # Name of the workflow this event execution snapshot belongs to.
},
],
"eventExecutionSnapshotsSize": "A String", # Total size of all event_execution_snapshots for an execution
"eventExecutionState": "A String",
"eventRetriesFromBeginningCount": 42, # Indicates the number of times the execution has restarted from the beginning.
"logFilePath": "A String", # The log file path (aka. cns address) for this event.
"networkAddress": "A String", # The network address (aka. bns address) that indicates where the event executor is running.
"nextExecutionTime": "A String", # Next scheduled execution time in case the execution status was RETRY_ON_HOLD.
"ryeLockUnheldCount": 42, # Used internally and shouldn't be exposed to users. A counter for the cron job to record how many times this event is in in_process state but don't have a lock consecutively/
},
"executionDetails": { # Contains the details of the execution info: this includes the tasks execution details plus the event execution statistics. # Detailed info of this execution.
"attemptStats": [ # List of Start and end time of the execution attempts.
{ # Status for the execution attempt.
"endTime": "A String", # The end time of the integration execution for current attempt.
"startTime": "A String", # The start time of the integration execution for current attempt. This could be in the future if it's been scheduled.
},
],
"eventExecutionSnapshotsSize": "A String", # Total size of all event_execution_snapshots for an execution
"executionSnapshots": [ # List of snapshots taken during the execution.
{ # Contains the snapshot of the execution for a given checkpoint.
"checkpointTaskNumber": "A String", # Indicates "after which checkpoint task's execution" this snapshot is taken.
"executionSnapshotMetadata": { # Metadata of the execution snapshot. # Metadata of the execution snapshot.
"ancestorIterationNumbers": [ # Ancestor iteration number for the task(it will only be non-empty if the task is under 'private workflow')
"A String",
],
"ancestorTaskNumbers": [ # Ancestor task number for the task(it will only be non-empty if the task is under 'private workflow')
"A String",
],
"executionAttempt": 42, # the execution attempt number this snapshot belongs to.
"integrationName": "A String", # The direct integration which the event execution snapshots belongs to
"task": "A String", # the task name associated with this snapshot.
"taskAttempt": 42, # the task attempt number this snapshot belongs to.
"taskLabel": "A String", # the task label associated with this snapshot. Could be empty.
"taskNumber": "A String", # The task number associated with this snapshot.
},
"params": { # Parameters used during the 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.
},
},
"taskExecutionDetails": [ # All of the task execution details at the given point of time.
{ # Contains the details of the execution of this task.
"taskAttemptStats": [ # Status for the current task execution attempt.
{ # Status for the execution attempt.
"endTime": "A String", # The end time of the integration execution for current attempt.
"startTime": "A String", # The start time of the integration execution for current attempt. This could be in the future if it's been scheduled.
},
],
"taskExecutionState": "A String", # The execution state of this task.
"taskNumber": "A String", # Pointer to the task config it used for execution.
},
],
},
],
"state": "A String", # Status of the execution.
},
"executionMethod": "A String", # The ways user posts this event.
"integrationVersionState": "A String", # Output only. State of the integration version
"name": "A String", # Auto-generated primary key.
"replayInfo": { # Contains the details of the execution info: this includes the replay reason and replay tree connecting executions in a parent-child relationship # Output only. Replay info for the execution
"originalExecutionInfoId": "A String", # If this execution is a replay of another execution, then this field contains the original execution id.
"replayReason": "A String", # reason for replay
"replayedExecutionInfoIds": [ # If this execution has been replayed, then this field contains the execution ids of the replayed executions.
"A String",
],
},
"requestParameters": { # Event parameters come in as part of the request.
"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.
},
},
"requestParams": [ # Event parameters come in as part of the request.
{ # 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.
"masked": True or False, # True if this parameter should be masked in the logs
"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",
},
},
],
"responseParameters": { # Event parameters returned as part of the response. In the case of error, the `ErrorInfo` field is returned in the following format: { "ErrorInfo": { "message": String, "code": Number } }
"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.
},
},
"responseParams": [
{ # 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.
"masked": True or False, # True if this parameter should be masked in the logs
"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",
},
},
],
"snapshotNumber": "A String", # Output only. An increasing sequence that is set when a new snapshot is created
"triggerId": "A String", # The trigger id of the integration trigger config. If both trigger_id and client_id is present, the integration is executed from the start tasks provided by the matching trigger config otherwise it is executed from the default start tasks.
"updateTime": "A String", # Output only. Last modified time of the execution.
}
list(parent, filter=None, filterParams_customFilter=None, filterParams_endTime=None, filterParams_eventStatuses=None, filterParams_executionId=None, filterParams_parameterKey=None, filterParams_parameterPairKey=None, filterParams_parameterPairValue=None, filterParams_parameterType=None, filterParams_parameterValue=None, filterParams_startTime=None, filterParams_taskStatuses=None, filterParams_workflowName=None, orderBy=None, pageSize=None, pageToken=None, readMask=None, refreshAcl=None, snapshotMetadataWithoutParams=None, truncateParams=None, x__xgafv=None)
Lists the results of all the integration executions. The response includes the same information as the [execution log](https://cloud.google.com/application-integration/docs/viewing-logs) in the Integration UI.
Args:
parent: string, Required. The parent resource name of the integration execution. (required)
filter: string, Optional. Standard filter field, we support filtering on following fields: workflow_name: the name of the integration. CreateTimestamp: the execution created time. event_execution_state: the state of the executions. execution_id: the id of the execution. trigger_id: the id of the trigger. parameter_type: the type of the parameters involved in the execution. All fields support for EQUALS, in additional: CreateTimestamp support for LESS_THAN, GREATER_THAN ParameterType support for HAS For example: "parameter_type" HAS \"string\" Also supports operators like AND, OR, NOT For example, trigger_id=\"id1\" AND workflow_name=\"testWorkflow\"
filterParams_customFilter: string, Optional user-provided custom filter.
filterParams_endTime: string, End timestamp.
filterParams_eventStatuses: string, List of possible event statuses. (repeated)
filterParams_executionId: string, Execution id.
filterParams_parameterKey: string, Param key. DEPRECATED. User parameter_pair_key instead.
filterParams_parameterPairKey: string, Param key in the key value pair filter.
filterParams_parameterPairValue: string, Param value in the key value pair filter.
filterParams_parameterType: string, Param type.
filterParams_parameterValue: string, Param value. DEPRECATED. User parameter_pair_value instead.
filterParams_startTime: string, Start timestamp.
filterParams_taskStatuses: string, List of possible task statuses. (repeated)
filterParams_workflowName: string, Workflow name.
orderBy: string, Optional. The results would be returned in order you specified here. Currently supporting "create_time".
pageSize: integer, Optional. The size of entries in the response.
pageToken: string, Optional. The token returned in the previous response.
readMask: string, Optional. View mask for the response data. If set, only the field specified will be returned as part of the result. If not set, all fields in Execution will be filled and returned. Supported fields: trigger_id execution_method create_time update_time execution_details execution_details.state execution_details.execution_snapshots execution_details.attempt_stats execution_details.event_execution_snapshots_size request_parameters cloud_logging_details snapshot_number replay_info
refreshAcl: boolean, Optional. If true, the service will use the most recent acl information to list event execution infos and renew the acl cache. Note that fetching the most recent acl is synchronous, so it will increase RPC call latency.
snapshotMetadataWithoutParams: boolean, Optional. If true, the service will provide execution info with snapshot metadata only i.e. without event parameters.
truncateParams: boolean, Optional. If true, the service will truncate the params to only keep the first 1000 characters of string params and empty the executions in order to make response smaller. Only works for UI and when the params fields are not filtered out.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for listing the integration execution data.
"executionInfos": [ # Required. The detailed information of requested executions.
{ # Contains all the execution details for a workflow instance. Next available id: 27
"clientId": "A String", # The event data user sends as request.
"cloudLoggingDetails": { # Cloud Logging details, selected by the user for the integration version (workflow). This message field will be also used in ExecutionInfo, to indicate the CloudLoggingDetails config at the time of workflow (integration version) execution, since this field value can be changed for an unpublished workflow. # Cloud Logging details for execution info
"cloudLoggingSeverity": "A String", # Severity selected by the customer for the logs to be sent to Cloud Logging, for the integration version getting executed.
"enableCloudLogging": True or False, # Status of whether Cloud Logging is enabled or not for the integration version getting executed.
},
"createTime": "A String", # Auto-generated.
"errorCode": { # Registered ids for errors, as "oneof" enums. Each task or logical grouping of tasks may share the same enum. # Final error-code if event failed.
"commonErrorCode": "A String",
},
"errors": [ # Errors, warnings, and informationals associated with the workflow/task. The order in which the errors were added by the workflow/task is maintained.
{ # An error, warning, or information message associated with a workflow.
"errorCode": { # Registered ids for errors, as "oneof" enums. Each task or logical grouping of tasks may share the same enum. # The associated error-code, which can be a common or internal code.
"commonErrorCode": "A String",
},
"errorMessage": "A String", # The full text of the error message, including any parameters that were thrown along with the exception.
"severity": "A String", # The severity of the error: ERROR|WARN|INFO.
"taskNumber": 42, # The task try-number, in which, the error occurred. If zero, the error happened at the event level.
},
],
"eventExecutionDetails": { # Contains the details of the execution info of this event: this includes the tasks execution details plus the event execution statistics. Next available id: 12 # The execution info about this event.
"cancelReason": "A String", # If the execution is manually canceled, this field will contain the reason for cancellation.
"eventAttemptStats": [
{
"endTime": "A String", # The end time of the event execution for current attempt.
"startTime": "A String", # The start time of the event execution for current attempt. This could be in the future if it's been scheduled.
},
],
"eventExecutionSnapshot": [ # After snapshot migration, this field will no longer be populated, but old execution snapshots will still be accessible.
{
"checkpointTaskNumber": "A String", # Indicates "right after which checkpoint task's execution" this snapshot is taken.
"conditionResults": [ # All of the computed conditions that been calculated.
{ # Contains the combined condition calculation results.
"currentTaskNumber": "A String", # the current task number.
"nextTaskNumber": "A String", # the next task number.
"result": True or False, # the result comes out after evaluate the combined condition. True if there's no combined condition specified.
},
],
"diffParams": { # 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 # The parameters in Event object that differs from last snapshot.
"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.
"masked": True or False, # True if this parameter should be masked in the logs
"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",
},
},
],
},
"eventExecutionInfoId": "A String", # Points to the event execution info this snapshot belongs to.
"eventExecutionSnapshotId": "A String", # Auto-generated. Used as primary key for EventExecutionSnapshots table.
"eventExecutionSnapshotMetadata": {
"ancestorIterationNumbers": [ # Ancestor iteration number for the task(it will only be non-empty if the task is under 'private workflow')
"A String",
],
"ancestorTaskNumbers": [ # Ancestor task number for the task(it will only be non-empty if the task is under 'private workflow')
"A String",
],
"eventAttemptNum": 42, # the event attempt number this snapshot belongs to.
"integrationName": "A String", # The direct integration which the event execution snapshots belongs to
"taskAttemptNum": 42, # the task attempt number this snapshot belongs to. Could be empty.
"taskLabel": "A String", # the task label associated with this snapshot. Could be empty.
"taskName": "A String", # the task name associated with this snapshot. Could be empty.
"taskNumber": "A String", # The task number associated with this snapshot. Could be empty.
},
"eventParams": { # 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 # The parameters in Event object.
"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.
"masked": True or False, # True if this parameter should be masked in the logs
"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",
},
},
],
},
"snapshotTime": "A String", # Indicates when this snapshot is taken.
"taskExecutionDetails": [ # All of the task execution details at the given point of time.
{ # Contains the details of the execution of this task. Next available id: 11
"taskAttemptStats": [
{
"endTime": "A String", # The end time of the task execution for current attempt.
"startTime": "A String", # The start time of the task execution for current attempt. This could be in the future if it's been scheduled.
},
],
"taskExecutionState": "A String",
"taskNumber": "A String", # Pointer to the task config it used for execution.
},
],
"taskName": "A String", # The task name associated with this snapshot. Could be empty.
},
],
"eventExecutionSnapshotsSize": "A String", # Total size of all event_execution_snapshots for an execution
"eventExecutionState": "A String", # The execution state of this event.
"eventRetriesFromBeginningCount": 42, # Indicates the number of times the execution has restarted from the beginning.
"logFilePath": "A String", # The log file path (aka. cns address) for this event.
"networkAddress": "A String", # The network address (aka. bns address) that indicates where the event executor is running.
"nextExecutionTime": "A String", # Next scheduled execution time in case the execution status was RETRY_ON_HOLD.
"ryeLockUnheldCount": 42, # Used internally and shouldn't be exposed to users. A counter for the cron job to record how many times this event is in in_process state but don't have a lock consecutively/
},
"eventExecutionInfoId": "A String", # Auto-generated primary key.
"executionTraceInfo": { # Message that helps aggregate all sub-executions triggered by one execution and keeps track of child-parent relationships. # Execution trace info to aggregate parent-child executions.
"parentEventExecutionInfoId": "A String", # Parent event execution info id that triggers the current execution through SubWorkflowExecutorTask.
"traceId": "A String", # Used to aggregate ExecutionTraceInfo.
},
"integrationVersionUserLabel": "A String", # User-defined label that annotates the executed integration version.
"lastModifiedTime": "A String", # Auto-generated.
"postMethod": "A String", # The ways user posts this event.
"product": "A String", # Which Google product the execution_info belongs to. If not set, the execution_info belongs to Integration Platform by default.
"replayInfo": { # Contains the details of the execution info: this includes the replay reason and replay tree connecting executions in a parent-child relationship # Replay info for the execution
"originalExecutionInfoId": "A String", # If this execution is a replay of another execution, then this field contains the original execution id.
"replayReason": "A String", # reason for replay
"replayedExecutionInfoIds": [ # If this execution has been replayed, then this field contains the execution ids of the replayed executions.
"A String",
],
},
"requestId": "A String", # Optional. This is used to de-dup incoming request.
"requestParams": { # 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 # Event parameters come in as part of the request.
"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.
"masked": True or False, # True if this parameter should be masked in the logs
"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",
},
},
],
},
"responseParams": { # 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 # Event parameters come out as part of the response.
"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.
"masked": True or False, # True if this parameter should be masked in the logs
"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",
},
},
],
},
"snapshotNumber": "A String", # Workflow snapshot number.
"tenant": "A String", # Tenant this event is created. Used to reschedule the event to correct tenant.
"triggerId": "A String", # The trigger id of the workflow trigger config. If both trigger_id and client_id is present, the workflow is executed from the start tasks provided by the matching trigger config otherwise it is executed from the default start tasks.
"workflowId": "A String", # Required. Pointer to the workflow it is executing.
"workflowName": "A String", # Name of the workflow.
"workflowRetryBackoffIntervalSeconds": "A String", # Time interval in seconds to schedule retry of workflow in manifold when workflow is already running
},
],
"executions": [ # The detailed information of requested executions
{ # The Execution resource contains detailed information of an individual integration execution.
"cloudLoggingDetails": { # Cloud Logging details for execution info # Cloud Logging details for the integration version
"cloudLoggingSeverity": "A String", # Optional. Severity selected by the customer for the logs to be sent to Cloud Logging, for the integration version getting executed.
"enableCloudLogging": True or False, # Optional. Status of whether Cloud Logging is enabled or not for the integration version getting executed.
},
"createTime": "A String", # Output only. Created time of the execution.
"directSubExecutions": [ # Direct sub executions of the following Execution.
# Object with schema name: GoogleCloudIntegrationsV1alphaExecution
],
"eventExecutionDetails": { # Contains the details of the execution info of this event: this includes the tasks execution details plus the event execution statistics. Next available id: 12 # The execution info about this event.
"cancelReason": "A String", # If the execution is manually canceled, this field will contain the reason for cancellation.
"eventAttemptStats": [
{
"endTime": "A String", # The end time of the event execution for current attempt.
"startTime": "A String", # The start time of the event execution for current attempt. This could be in the future if it's been scheduled.
},
],
"eventExecutionSnapshot": [
{ # Contains the snapshot of the event execution for a given checkpoint. Next available id: 15
"checkpointTaskNumber": "A String", # Indicates "right after which checkpoint task's execution" this snapshot is taken.
"clientId": "A String", # Client that the execution snapshot is associated to.
"conditionResults": [ # All of the computed conditions that been calculated.
{ # Contains the combined condition calculation results.
"currentTaskNumber": "A String", # the current task number.
"nextTaskNumber": "A String", # the next task number.
"result": True or False, # the result comes out after evaluate the combined condition. True if there's no combined condition specified.
},
],
"diffParams": { # 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 # The parameters in Event object that differs from last snapshot.
"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.
"masked": True or False, # True if this parameter should be masked in the logs
"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",
},
},
],
},
"eventExecutionInfoId": "A String", # Points to the event execution info this snapshot belongs to.
"eventExecutionSnapshotId": "A String", # Auto-generated. Used as primary key for EventExecutionSnapshots table.
"eventExecutionSnapshotMetadata": {
"ancestorIterationNumbers": [ # Ancestor iteration number for the task(it will only be non-empty if the task is under 'private workflow')
"A String",
],
"ancestorTaskNumbers": [ # Ancestor task number for the task(it will only be non-empty if the task is under 'private workflow')
"A String",
],
"eventAttemptNum": 42, # the event attempt number this snapshot belongs to.
"integrationName": "A String", # The direct integration which the event execution snapshots belongs to
"taskAttemptNum": 42, # the task attempt number this snapshot belongs to. Could be empty.
"taskLabel": "A String", # the task label associated with this snapshot. Could be empty.
"taskName": "A String", # the task name associated with this snapshot. Could be empty.
"taskNumber": "A String", # The task number associated with this snapshot. Could be empty.
},
"eventParams": { # 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 # The parameters in Event object.
"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.
"masked": True or False, # True if this parameter should be masked in the logs
"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",
},
},
],
},
"exceedMaxSize": True or False, # indicate whether snapshot exceeded maximum size before clean up
"snapshotTime": "A String", # Indicates when this snapshot is taken.
"taskExecutionDetails": [ # All of the task execution details at the given point of time.
{ # Contains the details of the execution of this task. Next available id: 11
"taskAttemptStats": [
{
"endTime": "A String", # The end time of the task execution for current attempt.
"startTime": "A String", # The start time of the task execution for current attempt. This could be in the future if it's been scheduled.
},
],
"taskExecutionState": "A String",
"taskNumber": "A String", # Pointer to the task config it used for execution.
},
],
"taskName": "A String", # The task name associated with this snapshot. Could be empty.
"workflowName": "A String", # Name of the workflow this event execution snapshot belongs to.
},
],
"eventExecutionSnapshotsSize": "A String", # Total size of all event_execution_snapshots for an execution
"eventExecutionState": "A String",
"eventRetriesFromBeginningCount": 42, # Indicates the number of times the execution has restarted from the beginning.
"logFilePath": "A String", # The log file path (aka. cns address) for this event.
"networkAddress": "A String", # The network address (aka. bns address) that indicates where the event executor is running.
"nextExecutionTime": "A String", # Next scheduled execution time in case the execution status was RETRY_ON_HOLD.
"ryeLockUnheldCount": 42, # Used internally and shouldn't be exposed to users. A counter for the cron job to record how many times this event is in in_process state but don't have a lock consecutively/
},
"executionDetails": { # Contains the details of the execution info: this includes the tasks execution details plus the event execution statistics. # Detailed info of this execution.
"attemptStats": [ # List of Start and end time of the execution attempts.
{ # Status for the execution attempt.
"endTime": "A String", # The end time of the integration execution for current attempt.
"startTime": "A String", # The start time of the integration execution for current attempt. This could be in the future if it's been scheduled.
},
],
"eventExecutionSnapshotsSize": "A String", # Total size of all event_execution_snapshots for an execution
"executionSnapshots": [ # List of snapshots taken during the execution.
{ # Contains the snapshot of the execution for a given checkpoint.
"checkpointTaskNumber": "A String", # Indicates "after which checkpoint task's execution" this snapshot is taken.
"executionSnapshotMetadata": { # Metadata of the execution snapshot. # Metadata of the execution snapshot.
"ancestorIterationNumbers": [ # Ancestor iteration number for the task(it will only be non-empty if the task is under 'private workflow')
"A String",
],
"ancestorTaskNumbers": [ # Ancestor task number for the task(it will only be non-empty if the task is under 'private workflow')
"A String",
],
"executionAttempt": 42, # the execution attempt number this snapshot belongs to.
"integrationName": "A String", # The direct integration which the event execution snapshots belongs to
"task": "A String", # the task name associated with this snapshot.
"taskAttempt": 42, # the task attempt number this snapshot belongs to.
"taskLabel": "A String", # the task label associated with this snapshot. Could be empty.
"taskNumber": "A String", # The task number associated with this snapshot.
},
"params": { # Parameters used during the 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.
},
},
"taskExecutionDetails": [ # All of the task execution details at the given point of time.
{ # Contains the details of the execution of this task.
"taskAttemptStats": [ # Status for the current task execution attempt.
{ # Status for the execution attempt.
"endTime": "A String", # The end time of the integration execution for current attempt.
"startTime": "A String", # The start time of the integration execution for current attempt. This could be in the future if it's been scheduled.
},
],
"taskExecutionState": "A String", # The execution state of this task.
"taskNumber": "A String", # Pointer to the task config it used for execution.
},
],
},
],
"state": "A String", # Status of the execution.
},
"executionMethod": "A String", # The ways user posts this event.
"integrationVersionState": "A String", # Output only. State of the integration version
"name": "A String", # Auto-generated primary key.
"replayInfo": { # Contains the details of the execution info: this includes the replay reason and replay tree connecting executions in a parent-child relationship # Output only. Replay info for the execution
"originalExecutionInfoId": "A String", # If this execution is a replay of another execution, then this field contains the original execution id.
"replayReason": "A String", # reason for replay
"replayedExecutionInfoIds": [ # If this execution has been replayed, then this field contains the execution ids of the replayed executions.
"A String",
],
},
"requestParameters": { # Event parameters come in as part of the request.
"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.
},
},
"requestParams": [ # Event parameters come in as part of the request.
{ # 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.
"masked": True or False, # True if this parameter should be masked in the logs
"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",
},
},
],
"responseParameters": { # Event parameters returned as part of the response. In the case of error, the `ErrorInfo` field is returned in the following format: { "ErrorInfo": { "message": String, "code": Number } }
"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.
},
},
"responseParams": [
{ # 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.
"masked": True or False, # True if this parameter should be masked in the logs
"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",
},
},
],
"snapshotNumber": "A String", # Output only. An increasing sequence that is set when a new snapshot is created
"triggerId": "A String", # The trigger id of the integration trigger config. If both trigger_id and client_id is present, the integration is executed from the start tasks provided by the matching trigger config otherwise it is executed from the default start tasks.
"updateTime": "A String", # Output only. Last modified time of the execution.
},
],
"nextPageToken": "A String", # The token used to retrieve the next page results.
}
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.
replay(name, body=None, x__xgafv=None)
Re-execute an existing execution, with same request parameters and execution strategy.
Args:
name: string, Required. Next ID: 3 The execution resource name. Format: projects/{gcp_project_id}/locations/{location}/integrations/{integration}/executions/{execution_id} (required)
body: object, The request body.
The object takes the form of:
{ # Request for replaying an execution.
"replayReason": "A String", # Required. The user provided reason for replaying the execution.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for replaying an execution.
"executionId": "A String", # Next ID: 4 The id of the execution corresponding to this run of the integration.
"outputParameters": { # OUTPUT parameters in format of Map. Where Key is the name of the parameter. The parameters would only be present in case of synchrounous execution. 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.
},
"replayedExecutionId": "A String", # The execution id which is replayed.
}