Close httplib2 connections.
create(parent, body=None, testCaseId=None, x__xgafv=None)
Creates a new test case
Deletes a test case
download(name, fileFormat=None, x__xgafv=None)
Downloads a test case. Retrieves the `TestCase` for a given `test_case_id` and returns the response as a string.
executeTest(testCaseName, body=None, x__xgafv=None)
Executes functional test
Get a test case
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)
Lists all the test cases that satisfy the filters.
Lists the results of all functional test 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.
Retrieves the next page of results.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a test case
takeoverEditLock(name, body=None, x__xgafv=None)
Clear the lock fields and assign them to current user
upload(parent, body=None, x__xgafv=None)
Uploads a test case. The content can be a previously downloaded test case. Performs the same function as CreateTestCase, but accepts input in a string format, which holds the complete representation of the TestCase content.
close()
Close httplib2 connections.
create(parent, body=None, testCaseId=None, x__xgafv=None)
Creates a new test case
Args:
parent: string, Required. The parent resource where this test case will be created. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{integration_version} (required)
body: object, The request body.
The object takes the form of:
{ # Defines the functional test case for Application Integration. Next available id: 15
"createTime": "A String", # Auto-generated.
"creatorEmail": "A String", # Optional. The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
"databasePersistencePolicy": "A String", # Optional. Various policies for how to persist the test execution info including execution info, execution export info, execution metadata index and execution param index..
"description": "A String", # Optional. Description of the test case.
"displayName": "A String", # Required. The display name of test case.
"lastModifierEmail": "A String", # The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
"lockHolderEmail": "A String", # Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
"name": "A String", # Output only. Auto-generated primary key.
"testInputParameters": [ # Optional. Parameters that are expected to be passed to the test case when the test case is triggered. This gives the user the ability to provide default values. This should include all the output variables of the trigger as input variables.
{ # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.
"containsLargeData": True or False, # Indicates whether this variable contains large data and need to be uploaded to Cloud Storage.
"dataType": "A String", # Type of the parameter.
"defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
"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.
},
"description": "A String", # Optional. Description of the parameter.
"displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
"inputOutputType": "A String", # Specifies the input/output type for the parameter.
"isTransient": True or False, # Whether this parameter is a transient parameter.
"jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this 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 integration definition.
"masked": True or False, # True if this parameter should be masked in the logs
"producer": "A String", # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
"searchable": True or False, # Searchable in the execution log or not.
},
],
"testTaskConfigs": [ # Optional. However, the test case doesn't mock or assert anything without test_task_configs.
{ # The task mock configuration details and assertions for functional tests. Next available id: 6
"assertions": [ # Optional. List of conditions or expressions which should be evaluated to true unless there is a bug/problem in the integration. These are evaluated one the task execution is completed as per the mock strategy in test case
{ # An assertion which will check for a condition over task execution status or an expression for task output variables Next available id: 5
"assertionStrategy": "A String", # The type of assertion to perform.
"condition": "A String", # Optional. Standard filter expression for ASSERT_CONDITION to succeed
"parameter": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Next available id: 4 # Optional. Key-value pair for ASSERT_EQUALS, ASSERT_NOT_EQUALS, ASSERT_CONTAINS to succeed
"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": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
"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.
},
},
"retryCount": 42, # Number of times given task should be retried in case of ASSERT_FAILED_EXECUTION
},
],
"mockConfig": { # The configuration for mocking of a task during test execution Next available id: 4 # Optional. Defines how to mock the given task during test execution
"failedExecutions": "A String", # Optional. Number of times the given task should fail for failure mock strategy
"mockStrategy": "A String", # Mockstrategy defines how the particular task should be mocked during test execution
"parameters": [ # Optional. List of key-value pairs for specific mock strategy
{ # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Next available id: 4
"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": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
"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.
},
},
],
},
"task": "A String", # Required. This defines in the test case, the task name in integration which will be mocked by this test task config
"taskConfig": { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. # Optional. Auto-generated.
"conditionalFailurePolicies": { # Conditional task failur retry strategies # Optional. The list of conditional failure policies that will be applied to the task in order.
"defaultFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # The default failure policy to be applied if no conditional failure policy matches.
"condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"failurePolicies": [ # The list of failure policies that will be applied to the task in order.
{ # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied).
"condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
],
},
"description": "A String", # Optional. User-provided description intended to give additional business context about the task.
"displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
"errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
"externalTaskType": "A String", # Optional. External task type of the task
"failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
"condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"jsonValidationOption": "A String", # Optional. If set, overrides the option configured in the Task implementation class.
"nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
{ # The task that is next in line to be executed, if the condition specified evaluated to true.
"condition": "A String", # Standard filter expression for this task to become an eligible next task.
"description": "A String", # User-provided description intended to give additional business context about the task.
"displayName": "A String", # User-provided label that is attached to this edge in the UI.
"taskConfigId": "A String", # ID of the next task.
"taskId": "A String", # Task number of the next task.
},
],
"nextTasksExecutionPolicy": "A String", # Optional. The policy dictating the execution of the next set of tasks for the current task.
"parameters": { # Optional. The customized parameters the user can pass to this task.
"a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Next available id: 4
"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": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
"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.
},
},
},
"position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI.
"x": 42, # Required. X axis of the coordinate
"y": 42, # Required. Y axis of the coordinate
},
"successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Optional. Determines what action to take upon successful task completion.
"finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
},
"synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
"condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"task": "A String", # Optional. The name for the task.
"taskExecutionStrategy": "A String", # Optional. The policy dictating the execution strategy of this task.
"taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
"taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template
},
"taskNumber": "A String", # Required. This defines in the test case, the task in integration which will be mocked by this test task config
},
],
"triggerConfig": { # Configuration detail of a trigger. # Optional. Auto-generated.
"alertConfig": [ # Optional. An alert threshold configuration for the [trigger + client + integration] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + integration] when published.
{ # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
"aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week). For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
"alertThreshold": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
"disableAlert": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this integration alert.
"displayName": "A String", # Name of the alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the integration.
"durationThreshold": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
"metricType": "A String", # The type of metric.
"onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
"thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
"thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. # The metric value, above or below which the alert should be triggered.
"absolute": "A String", # Absolute value threshold.
"percentage": 42, # Percentage threshold.
},
},
],
"cloudSchedulerConfig": { # Cloud Scheduler Trigger configuration # Optional. Cloud Scheduler Trigger related metadata
"cronTab": "A String", # Required. The cron tab of cloud scheduler trigger.
"errorMessage": "A String", # Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations
"location": "A String", # Required. The location where associated cloud scheduler job will be created
"serviceAccountEmail": "A String", # Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time
},
"description": "A String", # Optional. User-provided description intended to give additional business context about the task.
"errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
"inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger.
"names": [ # Optional. List of variable names.
"A String",
],
},
"label": "A String", # Optional. The user created label for a particular trigger.
"nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed.
"outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger.
"names": [ # Optional. List of variable names.
"A String",
],
},
"position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI.
"x": 42, # Required. X axis of the coordinate
"y": 42, # Required. Y axis of the coordinate
},
"properties": { # Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Pub/sub triggers.
"a_key": "A String",
},
"startTasks": [ # Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph).
{ # The task that is next in line to be executed, if the condition specified evaluated to true.
"condition": "A String", # Standard filter expression for this task to become an eligible next task.
"description": "A String", # User-provided description intended to give additional business context about the task.
"displayName": "A String", # User-provided label that is attached to this edge in the UI.
"taskConfigId": "A String", # ID of the next task.
"taskId": "A String", # Task number of the next task.
},
],
"trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose.
"triggerId": "A String", # Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format: api_trigger/TRIGGER_NAME Where trigger config has properties with value {"Trigger name": TRIGGER_NAME}
"triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI.
"triggerType": "A String", # Optional. Type of trigger
},
"triggerId": "A String", # Required. This defines the trigger ID in workflow which is considered to be executed as starting point of the test case
"updateTime": "A String", # Auto-generated.
}
testCaseId: string, Required. Required
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Defines the functional test case for Application Integration. Next available id: 15
"createTime": "A String", # Auto-generated.
"creatorEmail": "A String", # Optional. The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
"databasePersistencePolicy": "A String", # Optional. Various policies for how to persist the test execution info including execution info, execution export info, execution metadata index and execution param index..
"description": "A String", # Optional. Description of the test case.
"displayName": "A String", # Required. The display name of test case.
"lastModifierEmail": "A String", # The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
"lockHolderEmail": "A String", # Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
"name": "A String", # Output only. Auto-generated primary key.
"testInputParameters": [ # Optional. Parameters that are expected to be passed to the test case when the test case is triggered. This gives the user the ability to provide default values. This should include all the output variables of the trigger as input variables.
{ # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.
"containsLargeData": True or False, # Indicates whether this variable contains large data and need to be uploaded to Cloud Storage.
"dataType": "A String", # Type of the parameter.
"defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
"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.
},
"description": "A String", # Optional. Description of the parameter.
"displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
"inputOutputType": "A String", # Specifies the input/output type for the parameter.
"isTransient": True or False, # Whether this parameter is a transient parameter.
"jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this 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 integration definition.
"masked": True or False, # True if this parameter should be masked in the logs
"producer": "A String", # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
"searchable": True or False, # Searchable in the execution log or not.
},
],
"testTaskConfigs": [ # Optional. However, the test case doesn't mock or assert anything without test_task_configs.
{ # The task mock configuration details and assertions for functional tests. Next available id: 6
"assertions": [ # Optional. List of conditions or expressions which should be evaluated to true unless there is a bug/problem in the integration. These are evaluated one the task execution is completed as per the mock strategy in test case
{ # An assertion which will check for a condition over task execution status or an expression for task output variables Next available id: 5
"assertionStrategy": "A String", # The type of assertion to perform.
"condition": "A String", # Optional. Standard filter expression for ASSERT_CONDITION to succeed
"parameter": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Next available id: 4 # Optional. Key-value pair for ASSERT_EQUALS, ASSERT_NOT_EQUALS, ASSERT_CONTAINS to succeed
"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": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
"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.
},
},
"retryCount": 42, # Number of times given task should be retried in case of ASSERT_FAILED_EXECUTION
},
],
"mockConfig": { # The configuration for mocking of a task during test execution Next available id: 4 # Optional. Defines how to mock the given task during test execution
"failedExecutions": "A String", # Optional. Number of times the given task should fail for failure mock strategy
"mockStrategy": "A String", # Mockstrategy defines how the particular task should be mocked during test execution
"parameters": [ # Optional. List of key-value pairs for specific mock strategy
{ # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Next available id: 4
"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": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
"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.
},
},
],
},
"task": "A String", # Required. This defines in the test case, the task name in integration which will be mocked by this test task config
"taskConfig": { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. # Optional. Auto-generated.
"conditionalFailurePolicies": { # Conditional task failur retry strategies # Optional. The list of conditional failure policies that will be applied to the task in order.
"defaultFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # The default failure policy to be applied if no conditional failure policy matches.
"condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"failurePolicies": [ # The list of failure policies that will be applied to the task in order.
{ # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied).
"condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
],
},
"description": "A String", # Optional. User-provided description intended to give additional business context about the task.
"displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
"errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
"externalTaskType": "A String", # Optional. External task type of the task
"failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
"condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"jsonValidationOption": "A String", # Optional. If set, overrides the option configured in the Task implementation class.
"nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
{ # The task that is next in line to be executed, if the condition specified evaluated to true.
"condition": "A String", # Standard filter expression for this task to become an eligible next task.
"description": "A String", # User-provided description intended to give additional business context about the task.
"displayName": "A String", # User-provided label that is attached to this edge in the UI.
"taskConfigId": "A String", # ID of the next task.
"taskId": "A String", # Task number of the next task.
},
],
"nextTasksExecutionPolicy": "A String", # Optional. The policy dictating the execution of the next set of tasks for the current task.
"parameters": { # Optional. The customized parameters the user can pass to this task.
"a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Next available id: 4
"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": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
"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.
},
},
},
"position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI.
"x": 42, # Required. X axis of the coordinate
"y": 42, # Required. Y axis of the coordinate
},
"successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Optional. Determines what action to take upon successful task completion.
"finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
},
"synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
"condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"task": "A String", # Optional. The name for the task.
"taskExecutionStrategy": "A String", # Optional. The policy dictating the execution strategy of this task.
"taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
"taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template
},
"taskNumber": "A String", # Required. This defines in the test case, the task in integration which will be mocked by this test task config
},
],
"triggerConfig": { # Configuration detail of a trigger. # Optional. Auto-generated.
"alertConfig": [ # Optional. An alert threshold configuration for the [trigger + client + integration] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + integration] when published.
{ # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
"aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week). For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
"alertThreshold": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
"disableAlert": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this integration alert.
"displayName": "A String", # Name of the alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the integration.
"durationThreshold": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
"metricType": "A String", # The type of metric.
"onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
"thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
"thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. # The metric value, above or below which the alert should be triggered.
"absolute": "A String", # Absolute value threshold.
"percentage": 42, # Percentage threshold.
},
},
],
"cloudSchedulerConfig": { # Cloud Scheduler Trigger configuration # Optional. Cloud Scheduler Trigger related metadata
"cronTab": "A String", # Required. The cron tab of cloud scheduler trigger.
"errorMessage": "A String", # Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations
"location": "A String", # Required. The location where associated cloud scheduler job will be created
"serviceAccountEmail": "A String", # Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time
},
"description": "A String", # Optional. User-provided description intended to give additional business context about the task.
"errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
"inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger.
"names": [ # Optional. List of variable names.
"A String",
],
},
"label": "A String", # Optional. The user created label for a particular trigger.
"nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed.
"outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger.
"names": [ # Optional. List of variable names.
"A String",
],
},
"position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI.
"x": 42, # Required. X axis of the coordinate
"y": 42, # Required. Y axis of the coordinate
},
"properties": { # Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Pub/sub triggers.
"a_key": "A String",
},
"startTasks": [ # Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph).
{ # The task that is next in line to be executed, if the condition specified evaluated to true.
"condition": "A String", # Standard filter expression for this task to become an eligible next task.
"description": "A String", # User-provided description intended to give additional business context about the task.
"displayName": "A String", # User-provided label that is attached to this edge in the UI.
"taskConfigId": "A String", # ID of the next task.
"taskId": "A String", # Task number of the next task.
},
],
"trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose.
"triggerId": "A String", # Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format: api_trigger/TRIGGER_NAME Where trigger config has properties with value {"Trigger name": TRIGGER_NAME}
"triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI.
"triggerType": "A String", # Optional. Type of trigger
},
"triggerId": "A String", # Required. This defines the trigger ID in workflow which is considered to be executed as starting point of the test case
"updateTime": "A String", # Auto-generated.
}
delete(name, x__xgafv=None)
Deletes a test case
Args:
name: string, Required. ID for the test case to be deleted (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); }
}
download(name, fileFormat=None, x__xgafv=None)
Downloads a test case. Retrieves the `TestCase` for a given `test_case_id` and returns the response as a string.
Args:
name: string, Required. The test case to download. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{integration_version}/testCases/{test_case_id} (required)
fileFormat: string, File format for download request.
Allowed values
FILE_FORMAT_UNSPECIFIED - Unspecified file format
JSON - JSON File Format
YAML - YAML File Format
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for DownloadTestCase.
"content": "A String", # String representation of the test case.
}
executeTest(testCaseName, body=None, x__xgafv=None)
Executes functional test
Args:
testCaseName: string, Required. Test case resource name (required)
body: object, The request body.
The object takes the form of:
{ # The request for executing a functional test.
"inputParameters": { # Optional. Input parameters used by test case 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.
},
},
}
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 a functional test.
"assertionResults": [ # Results of each assertions ran during execution of test case.
{ # The result of an assertion.
"assertion": { # An assertion which will check for a condition over task execution status or an expression for task output variables Next available id: 5 # Assertion that was run.
"assertionStrategy": "A String", # The type of assertion to perform.
"condition": "A String", # Optional. Standard filter expression for ASSERT_CONDITION to succeed
"parameter": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Next available id: 4 # Optional. Key-value pair for ASSERT_EQUALS, ASSERT_NOT_EQUALS, ASSERT_CONTAINS to succeed
"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": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
"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.
},
},
"retryCount": 42, # Number of times given task should be retried in case of ASSERT_FAILED_EXECUTION
},
"failureMessage": "A String", # Details of the assertion failure
"status": "A String", # Status of assertion to signify if the assertion succeeded or failed
"taskName": "A String", # Task name of task where the assertion was run.
"taskNumber": "A String", # Task number of task where the assertion was run.
},
],
"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.
},
"testExecutionState": "A String", # State of the test case execution
}
get(name, x__xgafv=None)
Get a test case
Args:
name: string, Required. The ID of the test case to retrieve (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Defines the functional test case for Application Integration. Next available id: 15
"createTime": "A String", # Auto-generated.
"creatorEmail": "A String", # Optional. The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
"databasePersistencePolicy": "A String", # Optional. Various policies for how to persist the test execution info including execution info, execution export info, execution metadata index and execution param index..
"description": "A String", # Optional. Description of the test case.
"displayName": "A String", # Required. The display name of test case.
"lastModifierEmail": "A String", # The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
"lockHolderEmail": "A String", # Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
"name": "A String", # Output only. Auto-generated primary key.
"testInputParameters": [ # Optional. Parameters that are expected to be passed to the test case when the test case is triggered. This gives the user the ability to provide default values. This should include all the output variables of the trigger as input variables.
{ # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.
"containsLargeData": True or False, # Indicates whether this variable contains large data and need to be uploaded to Cloud Storage.
"dataType": "A String", # Type of the parameter.
"defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
"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.
},
"description": "A String", # Optional. Description of the parameter.
"displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
"inputOutputType": "A String", # Specifies the input/output type for the parameter.
"isTransient": True or False, # Whether this parameter is a transient parameter.
"jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this 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 integration definition.
"masked": True or False, # True if this parameter should be masked in the logs
"producer": "A String", # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
"searchable": True or False, # Searchable in the execution log or not.
},
],
"testTaskConfigs": [ # Optional. However, the test case doesn't mock or assert anything without test_task_configs.
{ # The task mock configuration details and assertions for functional tests. Next available id: 6
"assertions": [ # Optional. List of conditions or expressions which should be evaluated to true unless there is a bug/problem in the integration. These are evaluated one the task execution is completed as per the mock strategy in test case
{ # An assertion which will check for a condition over task execution status or an expression for task output variables Next available id: 5
"assertionStrategy": "A String", # The type of assertion to perform.
"condition": "A String", # Optional. Standard filter expression for ASSERT_CONDITION to succeed
"parameter": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Next available id: 4 # Optional. Key-value pair for ASSERT_EQUALS, ASSERT_NOT_EQUALS, ASSERT_CONTAINS to succeed
"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": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
"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.
},
},
"retryCount": 42, # Number of times given task should be retried in case of ASSERT_FAILED_EXECUTION
},
],
"mockConfig": { # The configuration for mocking of a task during test execution Next available id: 4 # Optional. Defines how to mock the given task during test execution
"failedExecutions": "A String", # Optional. Number of times the given task should fail for failure mock strategy
"mockStrategy": "A String", # Mockstrategy defines how the particular task should be mocked during test execution
"parameters": [ # Optional. List of key-value pairs for specific mock strategy
{ # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Next available id: 4
"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": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
"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.
},
},
],
},
"task": "A String", # Required. This defines in the test case, the task name in integration which will be mocked by this test task config
"taskConfig": { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. # Optional. Auto-generated.
"conditionalFailurePolicies": { # Conditional task failur retry strategies # Optional. The list of conditional failure policies that will be applied to the task in order.
"defaultFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # The default failure policy to be applied if no conditional failure policy matches.
"condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"failurePolicies": [ # The list of failure policies that will be applied to the task in order.
{ # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied).
"condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
],
},
"description": "A String", # Optional. User-provided description intended to give additional business context about the task.
"displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
"errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
"externalTaskType": "A String", # Optional. External task type of the task
"failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
"condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"jsonValidationOption": "A String", # Optional. If set, overrides the option configured in the Task implementation class.
"nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
{ # The task that is next in line to be executed, if the condition specified evaluated to true.
"condition": "A String", # Standard filter expression for this task to become an eligible next task.
"description": "A String", # User-provided description intended to give additional business context about the task.
"displayName": "A String", # User-provided label that is attached to this edge in the UI.
"taskConfigId": "A String", # ID of the next task.
"taskId": "A String", # Task number of the next task.
},
],
"nextTasksExecutionPolicy": "A String", # Optional. The policy dictating the execution of the next set of tasks for the current task.
"parameters": { # Optional. The customized parameters the user can pass to this task.
"a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Next available id: 4
"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": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
"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.
},
},
},
"position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI.
"x": 42, # Required. X axis of the coordinate
"y": 42, # Required. Y axis of the coordinate
},
"successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Optional. Determines what action to take upon successful task completion.
"finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
},
"synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
"condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"task": "A String", # Optional. The name for the task.
"taskExecutionStrategy": "A String", # Optional. The policy dictating the execution strategy of this task.
"taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
"taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template
},
"taskNumber": "A String", # Required. This defines in the test case, the task in integration which will be mocked by this test task config
},
],
"triggerConfig": { # Configuration detail of a trigger. # Optional. Auto-generated.
"alertConfig": [ # Optional. An alert threshold configuration for the [trigger + client + integration] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + integration] when published.
{ # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
"aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week). For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
"alertThreshold": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
"disableAlert": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this integration alert.
"displayName": "A String", # Name of the alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the integration.
"durationThreshold": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
"metricType": "A String", # The type of metric.
"onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
"thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
"thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. # The metric value, above or below which the alert should be triggered.
"absolute": "A String", # Absolute value threshold.
"percentage": 42, # Percentage threshold.
},
},
],
"cloudSchedulerConfig": { # Cloud Scheduler Trigger configuration # Optional. Cloud Scheduler Trigger related metadata
"cronTab": "A String", # Required. The cron tab of cloud scheduler trigger.
"errorMessage": "A String", # Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations
"location": "A String", # Required. The location where associated cloud scheduler job will be created
"serviceAccountEmail": "A String", # Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time
},
"description": "A String", # Optional. User-provided description intended to give additional business context about the task.
"errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
"inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger.
"names": [ # Optional. List of variable names.
"A String",
],
},
"label": "A String", # Optional. The user created label for a particular trigger.
"nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed.
"outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger.
"names": [ # Optional. List of variable names.
"A String",
],
},
"position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI.
"x": 42, # Required. X axis of the coordinate
"y": 42, # Required. Y axis of the coordinate
},
"properties": { # Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Pub/sub triggers.
"a_key": "A String",
},
"startTasks": [ # Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph).
{ # The task that is next in line to be executed, if the condition specified evaluated to true.
"condition": "A String", # Standard filter expression for this task to become an eligible next task.
"description": "A String", # User-provided description intended to give additional business context about the task.
"displayName": "A String", # User-provided label that is attached to this edge in the UI.
"taskConfigId": "A String", # ID of the next task.
"taskId": "A String", # Task number of the next task.
},
],
"trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose.
"triggerId": "A String", # Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format: api_trigger/TRIGGER_NAME Where trigger config has properties with value {"Trigger name": TRIGGER_NAME}
"triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI.
"triggerType": "A String", # Optional. Type of trigger
},
"triggerId": "A String", # Required. This defines the trigger ID in workflow which is considered to be executed as starting point of the test case
"updateTime": "A String", # Auto-generated.
}
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)
Lists all the test cases that satisfy the filters.
Args:
parent: string, Required. The parent resource where this TestCase was created. (required)
filter: string, Optional. Standard filter field. Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/list-filters.
orderBy: string, Optional. The results would be returned in order specified here. Currently supported sort keys are: Descending sort order for "last_modified_time", "created_time". Ascending sort order for "name".
pageSize: integer, Optional. The maximum number of test cases to return. The service may return fewer than this value. If unspecified, at most 100 test cases will be returned.
pageToken: string, Optional. A page token, received from a previous `ListTestCases` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTestCases` must match the call that provided the page token.
readMask: string, Optional. The mask which specifies fields that need to be returned in the TestCases's response.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for ListTestCases
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
"testCases": [ # The test cases corresponding to the specified filter
{ # Defines the functional test case for Application Integration. Next available id: 15
"createTime": "A String", # Auto-generated.
"creatorEmail": "A String", # Optional. The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
"databasePersistencePolicy": "A String", # Optional. Various policies for how to persist the test execution info including execution info, execution export info, execution metadata index and execution param index..
"description": "A String", # Optional. Description of the test case.
"displayName": "A String", # Required. The display name of test case.
"lastModifierEmail": "A String", # The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
"lockHolderEmail": "A String", # Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
"name": "A String", # Output only. Auto-generated primary key.
"testInputParameters": [ # Optional. Parameters that are expected to be passed to the test case when the test case is triggered. This gives the user the ability to provide default values. This should include all the output variables of the trigger as input variables.
{ # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.
"containsLargeData": True or False, # Indicates whether this variable contains large data and need to be uploaded to Cloud Storage.
"dataType": "A String", # Type of the parameter.
"defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
"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.
},
"description": "A String", # Optional. Description of the parameter.
"displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
"inputOutputType": "A String", # Specifies the input/output type for the parameter.
"isTransient": True or False, # Whether this parameter is a transient parameter.
"jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this 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 integration definition.
"masked": True or False, # True if this parameter should be masked in the logs
"producer": "A String", # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
"searchable": True or False, # Searchable in the execution log or not.
},
],
"testTaskConfigs": [ # Optional. However, the test case doesn't mock or assert anything without test_task_configs.
{ # The task mock configuration details and assertions for functional tests. Next available id: 6
"assertions": [ # Optional. List of conditions or expressions which should be evaluated to true unless there is a bug/problem in the integration. These are evaluated one the task execution is completed as per the mock strategy in test case
{ # An assertion which will check for a condition over task execution status or an expression for task output variables Next available id: 5
"assertionStrategy": "A String", # The type of assertion to perform.
"condition": "A String", # Optional. Standard filter expression for ASSERT_CONDITION to succeed
"parameter": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Next available id: 4 # Optional. Key-value pair for ASSERT_EQUALS, ASSERT_NOT_EQUALS, ASSERT_CONTAINS to succeed
"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": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
"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.
},
},
"retryCount": 42, # Number of times given task should be retried in case of ASSERT_FAILED_EXECUTION
},
],
"mockConfig": { # The configuration for mocking of a task during test execution Next available id: 4 # Optional. Defines how to mock the given task during test execution
"failedExecutions": "A String", # Optional. Number of times the given task should fail for failure mock strategy
"mockStrategy": "A String", # Mockstrategy defines how the particular task should be mocked during test execution
"parameters": [ # Optional. List of key-value pairs for specific mock strategy
{ # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Next available id: 4
"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": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
"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.
},
},
],
},
"task": "A String", # Required. This defines in the test case, the task name in integration which will be mocked by this test task config
"taskConfig": { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. # Optional. Auto-generated.
"conditionalFailurePolicies": { # Conditional task failur retry strategies # Optional. The list of conditional failure policies that will be applied to the task in order.
"defaultFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # The default failure policy to be applied if no conditional failure policy matches.
"condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"failurePolicies": [ # The list of failure policies that will be applied to the task in order.
{ # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied).
"condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
],
},
"description": "A String", # Optional. User-provided description intended to give additional business context about the task.
"displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
"errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
"externalTaskType": "A String", # Optional. External task type of the task
"failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
"condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"jsonValidationOption": "A String", # Optional. If set, overrides the option configured in the Task implementation class.
"nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
{ # The task that is next in line to be executed, if the condition specified evaluated to true.
"condition": "A String", # Standard filter expression for this task to become an eligible next task.
"description": "A String", # User-provided description intended to give additional business context about the task.
"displayName": "A String", # User-provided label that is attached to this edge in the UI.
"taskConfigId": "A String", # ID of the next task.
"taskId": "A String", # Task number of the next task.
},
],
"nextTasksExecutionPolicy": "A String", # Optional. The policy dictating the execution of the next set of tasks for the current task.
"parameters": { # Optional. The customized parameters the user can pass to this task.
"a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Next available id: 4
"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": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
"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.
},
},
},
"position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI.
"x": 42, # Required. X axis of the coordinate
"y": 42, # Required. Y axis of the coordinate
},
"successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Optional. Determines what action to take upon successful task completion.
"finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
},
"synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
"condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"task": "A String", # Optional. The name for the task.
"taskExecutionStrategy": "A String", # Optional. The policy dictating the execution strategy of this task.
"taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
"taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template
},
"taskNumber": "A String", # Required. This defines in the test case, the task in integration which will be mocked by this test task config
},
],
"triggerConfig": { # Configuration detail of a trigger. # Optional. Auto-generated.
"alertConfig": [ # Optional. An alert threshold configuration for the [trigger + client + integration] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + integration] when published.
{ # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
"aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week). For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
"alertThreshold": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
"disableAlert": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this integration alert.
"displayName": "A String", # Name of the alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the integration.
"durationThreshold": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
"metricType": "A String", # The type of metric.
"onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
"thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
"thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. # The metric value, above or below which the alert should be triggered.
"absolute": "A String", # Absolute value threshold.
"percentage": 42, # Percentage threshold.
},
},
],
"cloudSchedulerConfig": { # Cloud Scheduler Trigger configuration # Optional. Cloud Scheduler Trigger related metadata
"cronTab": "A String", # Required. The cron tab of cloud scheduler trigger.
"errorMessage": "A String", # Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations
"location": "A String", # Required. The location where associated cloud scheduler job will be created
"serviceAccountEmail": "A String", # Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time
},
"description": "A String", # Optional. User-provided description intended to give additional business context about the task.
"errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
"inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger.
"names": [ # Optional. List of variable names.
"A String",
],
},
"label": "A String", # Optional. The user created label for a particular trigger.
"nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed.
"outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger.
"names": [ # Optional. List of variable names.
"A String",
],
},
"position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI.
"x": 42, # Required. X axis of the coordinate
"y": 42, # Required. Y axis of the coordinate
},
"properties": { # Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Pub/sub triggers.
"a_key": "A String",
},
"startTasks": [ # Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph).
{ # The task that is next in line to be executed, if the condition specified evaluated to true.
"condition": "A String", # Standard filter expression for this task to become an eligible next task.
"description": "A String", # User-provided description intended to give additional business context about the task.
"displayName": "A String", # User-provided label that is attached to this edge in the UI.
"taskConfigId": "A String", # ID of the next task.
"taskId": "A String", # Task number of the next task.
},
],
"trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose.
"triggerId": "A String", # Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format: api_trigger/TRIGGER_NAME Where trigger config has properties with value {"Trigger name": TRIGGER_NAME}
"triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI.
"triggerType": "A String", # Optional. Type of trigger
},
"triggerId": "A String", # Required. This defines the trigger ID in workflow which is considered to be executed as starting point of the test case
"updateTime": "A String", # Auto-generated.
},
],
}
listExecutions(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, readMask=None, truncateParams=None, x__xgafv=None)
Lists the results of all functional test 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 test case execution. (required)
filter: string, Optional. Standard filter field, we support filtering on following fields: test_case_id: the ID of the test case. 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 test_case_id=\"testCaseId\"
orderBy: string, Optional. The results would be returned in order you specified here. Currently supporting "last_modified_time" and "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 event execution info will be filled and returned.
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:
{ # The response for listing the functional test execution data.
"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.
}
listExecutions_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.
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.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a test case
Args:
name: string, Output only. Auto-generated primary key. (required)
body: object, The request body.
The object takes the form of:
{ # Defines the functional test case for Application Integration. Next available id: 15
"createTime": "A String", # Auto-generated.
"creatorEmail": "A String", # Optional. The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
"databasePersistencePolicy": "A String", # Optional. Various policies for how to persist the test execution info including execution info, execution export info, execution metadata index and execution param index..
"description": "A String", # Optional. Description of the test case.
"displayName": "A String", # Required. The display name of test case.
"lastModifierEmail": "A String", # The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
"lockHolderEmail": "A String", # Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
"name": "A String", # Output only. Auto-generated primary key.
"testInputParameters": [ # Optional. Parameters that are expected to be passed to the test case when the test case is triggered. This gives the user the ability to provide default values. This should include all the output variables of the trigger as input variables.
{ # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.
"containsLargeData": True or False, # Indicates whether this variable contains large data and need to be uploaded to Cloud Storage.
"dataType": "A String", # Type of the parameter.
"defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
"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.
},
"description": "A String", # Optional. Description of the parameter.
"displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
"inputOutputType": "A String", # Specifies the input/output type for the parameter.
"isTransient": True or False, # Whether this parameter is a transient parameter.
"jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this 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 integration definition.
"masked": True or False, # True if this parameter should be masked in the logs
"producer": "A String", # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
"searchable": True or False, # Searchable in the execution log or not.
},
],
"testTaskConfigs": [ # Optional. However, the test case doesn't mock or assert anything without test_task_configs.
{ # The task mock configuration details and assertions for functional tests. Next available id: 6
"assertions": [ # Optional. List of conditions or expressions which should be evaluated to true unless there is a bug/problem in the integration. These are evaluated one the task execution is completed as per the mock strategy in test case
{ # An assertion which will check for a condition over task execution status or an expression for task output variables Next available id: 5
"assertionStrategy": "A String", # The type of assertion to perform.
"condition": "A String", # Optional. Standard filter expression for ASSERT_CONDITION to succeed
"parameter": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Next available id: 4 # Optional. Key-value pair for ASSERT_EQUALS, ASSERT_NOT_EQUALS, ASSERT_CONTAINS to succeed
"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": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
"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.
},
},
"retryCount": 42, # Number of times given task should be retried in case of ASSERT_FAILED_EXECUTION
},
],
"mockConfig": { # The configuration for mocking of a task during test execution Next available id: 4 # Optional. Defines how to mock the given task during test execution
"failedExecutions": "A String", # Optional. Number of times the given task should fail for failure mock strategy
"mockStrategy": "A String", # Mockstrategy defines how the particular task should be mocked during test execution
"parameters": [ # Optional. List of key-value pairs for specific mock strategy
{ # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Next available id: 4
"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": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
"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.
},
},
],
},
"task": "A String", # Required. This defines in the test case, the task name in integration which will be mocked by this test task config
"taskConfig": { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. # Optional. Auto-generated.
"conditionalFailurePolicies": { # Conditional task failur retry strategies # Optional. The list of conditional failure policies that will be applied to the task in order.
"defaultFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # The default failure policy to be applied if no conditional failure policy matches.
"condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"failurePolicies": [ # The list of failure policies that will be applied to the task in order.
{ # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied).
"condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
],
},
"description": "A String", # Optional. User-provided description intended to give additional business context about the task.
"displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
"errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
"externalTaskType": "A String", # Optional. External task type of the task
"failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
"condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"jsonValidationOption": "A String", # Optional. If set, overrides the option configured in the Task implementation class.
"nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
{ # The task that is next in line to be executed, if the condition specified evaluated to true.
"condition": "A String", # Standard filter expression for this task to become an eligible next task.
"description": "A String", # User-provided description intended to give additional business context about the task.
"displayName": "A String", # User-provided label that is attached to this edge in the UI.
"taskConfigId": "A String", # ID of the next task.
"taskId": "A String", # Task number of the next task.
},
],
"nextTasksExecutionPolicy": "A String", # Optional. The policy dictating the execution of the next set of tasks for the current task.
"parameters": { # Optional. The customized parameters the user can pass to this task.
"a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Next available id: 4
"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": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
"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.
},
},
},
"position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI.
"x": 42, # Required. X axis of the coordinate
"y": 42, # Required. Y axis of the coordinate
},
"successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Optional. Determines what action to take upon successful task completion.
"finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
},
"synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
"condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"task": "A String", # Optional. The name for the task.
"taskExecutionStrategy": "A String", # Optional. The policy dictating the execution strategy of this task.
"taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
"taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template
},
"taskNumber": "A String", # Required. This defines in the test case, the task in integration which will be mocked by this test task config
},
],
"triggerConfig": { # Configuration detail of a trigger. # Optional. Auto-generated.
"alertConfig": [ # Optional. An alert threshold configuration for the [trigger + client + integration] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + integration] when published.
{ # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
"aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week). For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
"alertThreshold": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
"disableAlert": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this integration alert.
"displayName": "A String", # Name of the alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the integration.
"durationThreshold": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
"metricType": "A String", # The type of metric.
"onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
"thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
"thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. # The metric value, above or below which the alert should be triggered.
"absolute": "A String", # Absolute value threshold.
"percentage": 42, # Percentage threshold.
},
},
],
"cloudSchedulerConfig": { # Cloud Scheduler Trigger configuration # Optional. Cloud Scheduler Trigger related metadata
"cronTab": "A String", # Required. The cron tab of cloud scheduler trigger.
"errorMessage": "A String", # Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations
"location": "A String", # Required. The location where associated cloud scheduler job will be created
"serviceAccountEmail": "A String", # Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time
},
"description": "A String", # Optional. User-provided description intended to give additional business context about the task.
"errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
"inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger.
"names": [ # Optional. List of variable names.
"A String",
],
},
"label": "A String", # Optional. The user created label for a particular trigger.
"nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed.
"outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger.
"names": [ # Optional. List of variable names.
"A String",
],
},
"position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI.
"x": 42, # Required. X axis of the coordinate
"y": 42, # Required. Y axis of the coordinate
},
"properties": { # Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Pub/sub triggers.
"a_key": "A String",
},
"startTasks": [ # Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph).
{ # The task that is next in line to be executed, if the condition specified evaluated to true.
"condition": "A String", # Standard filter expression for this task to become an eligible next task.
"description": "A String", # User-provided description intended to give additional business context about the task.
"displayName": "A String", # User-provided label that is attached to this edge in the UI.
"taskConfigId": "A String", # ID of the next task.
"taskId": "A String", # Task number of the next task.
},
],
"trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose.
"triggerId": "A String", # Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format: api_trigger/TRIGGER_NAME Where trigger config has properties with value {"Trigger name": TRIGGER_NAME}
"triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI.
"triggerType": "A String", # Optional. Type of trigger
},
"triggerId": "A String", # Required. This defines the trigger ID in workflow which is considered to be executed as starting point of the test case
"updateTime": "A String", # Auto-generated.
}
updateMask: string, Optional. Field mask specifying the fields in the above integration that have been modified and need to be updated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Defines the functional test case for Application Integration. Next available id: 15
"createTime": "A String", # Auto-generated.
"creatorEmail": "A String", # Optional. The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
"databasePersistencePolicy": "A String", # Optional. Various policies for how to persist the test execution info including execution info, execution export info, execution metadata index and execution param index..
"description": "A String", # Optional. Description of the test case.
"displayName": "A String", # Required. The display name of test case.
"lastModifierEmail": "A String", # The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
"lockHolderEmail": "A String", # Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
"name": "A String", # Output only. Auto-generated primary key.
"testInputParameters": [ # Optional. Parameters that are expected to be passed to the test case when the test case is triggered. This gives the user the ability to provide default values. This should include all the output variables of the trigger as input variables.
{ # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.
"containsLargeData": True or False, # Indicates whether this variable contains large data and need to be uploaded to Cloud Storage.
"dataType": "A String", # Type of the parameter.
"defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
"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.
},
"description": "A String", # Optional. Description of the parameter.
"displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
"inputOutputType": "A String", # Specifies the input/output type for the parameter.
"isTransient": True or False, # Whether this parameter is a transient parameter.
"jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this 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 integration definition.
"masked": True or False, # True if this parameter should be masked in the logs
"producer": "A String", # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
"searchable": True or False, # Searchable in the execution log or not.
},
],
"testTaskConfigs": [ # Optional. However, the test case doesn't mock or assert anything without test_task_configs.
{ # The task mock configuration details and assertions for functional tests. Next available id: 6
"assertions": [ # Optional. List of conditions or expressions which should be evaluated to true unless there is a bug/problem in the integration. These are evaluated one the task execution is completed as per the mock strategy in test case
{ # An assertion which will check for a condition over task execution status or an expression for task output variables Next available id: 5
"assertionStrategy": "A String", # The type of assertion to perform.
"condition": "A String", # Optional. Standard filter expression for ASSERT_CONDITION to succeed
"parameter": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Next available id: 4 # Optional. Key-value pair for ASSERT_EQUALS, ASSERT_NOT_EQUALS, ASSERT_CONTAINS to succeed
"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": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
"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.
},
},
"retryCount": 42, # Number of times given task should be retried in case of ASSERT_FAILED_EXECUTION
},
],
"mockConfig": { # The configuration for mocking of a task during test execution Next available id: 4 # Optional. Defines how to mock the given task during test execution
"failedExecutions": "A String", # Optional. Number of times the given task should fail for failure mock strategy
"mockStrategy": "A String", # Mockstrategy defines how the particular task should be mocked during test execution
"parameters": [ # Optional. List of key-value pairs for specific mock strategy
{ # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Next available id: 4
"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": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
"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.
},
},
],
},
"task": "A String", # Required. This defines in the test case, the task name in integration which will be mocked by this test task config
"taskConfig": { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. # Optional. Auto-generated.
"conditionalFailurePolicies": { # Conditional task failur retry strategies # Optional. The list of conditional failure policies that will be applied to the task in order.
"defaultFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # The default failure policy to be applied if no conditional failure policy matches.
"condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"failurePolicies": [ # The list of failure policies that will be applied to the task in order.
{ # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied).
"condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
],
},
"description": "A String", # Optional. User-provided description intended to give additional business context about the task.
"displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
"errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
"externalTaskType": "A String", # Optional. External task type of the task
"failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
"condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"jsonValidationOption": "A String", # Optional. If set, overrides the option configured in the Task implementation class.
"nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
{ # The task that is next in line to be executed, if the condition specified evaluated to true.
"condition": "A String", # Standard filter expression for this task to become an eligible next task.
"description": "A String", # User-provided description intended to give additional business context about the task.
"displayName": "A String", # User-provided label that is attached to this edge in the UI.
"taskConfigId": "A String", # ID of the next task.
"taskId": "A String", # Task number of the next task.
},
],
"nextTasksExecutionPolicy": "A String", # Optional. The policy dictating the execution of the next set of tasks for the current task.
"parameters": { # Optional. The customized parameters the user can pass to this task.
"a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Next available id: 4
"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": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
"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.
},
},
},
"position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI.
"x": 42, # Required. X axis of the coordinate
"y": 42, # Required. Y axis of the coordinate
},
"successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Optional. Determines what action to take upon successful task completion.
"finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
},
"synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
"condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"task": "A String", # Optional. The name for the task.
"taskExecutionStrategy": "A String", # Optional. The policy dictating the execution strategy of this task.
"taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
"taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template
},
"taskNumber": "A String", # Required. This defines in the test case, the task in integration which will be mocked by this test task config
},
],
"triggerConfig": { # Configuration detail of a trigger. # Optional. Auto-generated.
"alertConfig": [ # Optional. An alert threshold configuration for the [trigger + client + integration] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + integration] when published.
{ # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
"aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week). For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
"alertThreshold": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
"disableAlert": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this integration alert.
"displayName": "A String", # Name of the alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the integration.
"durationThreshold": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
"metricType": "A String", # The type of metric.
"onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
"thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
"thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. # The metric value, above or below which the alert should be triggered.
"absolute": "A String", # Absolute value threshold.
"percentage": 42, # Percentage threshold.
},
},
],
"cloudSchedulerConfig": { # Cloud Scheduler Trigger configuration # Optional. Cloud Scheduler Trigger related metadata
"cronTab": "A String", # Required. The cron tab of cloud scheduler trigger.
"errorMessage": "A String", # Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations
"location": "A String", # Required. The location where associated cloud scheduler job will be created
"serviceAccountEmail": "A String", # Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time
},
"description": "A String", # Optional. User-provided description intended to give additional business context about the task.
"errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
"inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger.
"names": [ # Optional. List of variable names.
"A String",
],
},
"label": "A String", # Optional. The user created label for a particular trigger.
"nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed.
"outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger.
"names": [ # Optional. List of variable names.
"A String",
],
},
"position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI.
"x": 42, # Required. X axis of the coordinate
"y": 42, # Required. Y axis of the coordinate
},
"properties": { # Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Pub/sub triggers.
"a_key": "A String",
},
"startTasks": [ # Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph).
{ # The task that is next in line to be executed, if the condition specified evaluated to true.
"condition": "A String", # Standard filter expression for this task to become an eligible next task.
"description": "A String", # User-provided description intended to give additional business context about the task.
"displayName": "A String", # User-provided label that is attached to this edge in the UI.
"taskConfigId": "A String", # ID of the next task.
"taskId": "A String", # Task number of the next task.
},
],
"trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose.
"triggerId": "A String", # Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format: api_trigger/TRIGGER_NAME Where trigger config has properties with value {"Trigger name": TRIGGER_NAME}
"triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI.
"triggerType": "A String", # Optional. Type of trigger
},
"triggerId": "A String", # Required. This defines the trigger ID in workflow which is considered to be executed as starting point of the test case
"updateTime": "A String", # Auto-generated.
}
takeoverEditLock(name, body=None, x__xgafv=None)
Clear the lock fields and assign them to current user
Args:
name: string, Required. The ID of test case to takeover edit lock. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{integration_version}/testCases/{test_case_id} (required)
body: object, The request body.
The object takes the form of:
{ # Request for TakeoverTestCaseEditLock.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Defines the functional test case for Application Integration. Next available id: 15
"createTime": "A String", # Auto-generated.
"creatorEmail": "A String", # Optional. The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
"databasePersistencePolicy": "A String", # Optional. Various policies for how to persist the test execution info including execution info, execution export info, execution metadata index and execution param index..
"description": "A String", # Optional. Description of the test case.
"displayName": "A String", # Required. The display name of test case.
"lastModifierEmail": "A String", # The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
"lockHolderEmail": "A String", # Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
"name": "A String", # Output only. Auto-generated primary key.
"testInputParameters": [ # Optional. Parameters that are expected to be passed to the test case when the test case is triggered. This gives the user the ability to provide default values. This should include all the output variables of the trigger as input variables.
{ # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.
"containsLargeData": True or False, # Indicates whether this variable contains large data and need to be uploaded to Cloud Storage.
"dataType": "A String", # Type of the parameter.
"defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
"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.
},
"description": "A String", # Optional. Description of the parameter.
"displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
"inputOutputType": "A String", # Specifies the input/output type for the parameter.
"isTransient": True or False, # Whether this parameter is a transient parameter.
"jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this 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 integration definition.
"masked": True or False, # True if this parameter should be masked in the logs
"producer": "A String", # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
"searchable": True or False, # Searchable in the execution log or not.
},
],
"testTaskConfigs": [ # Optional. However, the test case doesn't mock or assert anything without test_task_configs.
{ # The task mock configuration details and assertions for functional tests. Next available id: 6
"assertions": [ # Optional. List of conditions or expressions which should be evaluated to true unless there is a bug/problem in the integration. These are evaluated one the task execution is completed as per the mock strategy in test case
{ # An assertion which will check for a condition over task execution status or an expression for task output variables Next available id: 5
"assertionStrategy": "A String", # The type of assertion to perform.
"condition": "A String", # Optional. Standard filter expression for ASSERT_CONDITION to succeed
"parameter": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Next available id: 4 # Optional. Key-value pair for ASSERT_EQUALS, ASSERT_NOT_EQUALS, ASSERT_CONTAINS to succeed
"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": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
"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.
},
},
"retryCount": 42, # Number of times given task should be retried in case of ASSERT_FAILED_EXECUTION
},
],
"mockConfig": { # The configuration for mocking of a task during test execution Next available id: 4 # Optional. Defines how to mock the given task during test execution
"failedExecutions": "A String", # Optional. Number of times the given task should fail for failure mock strategy
"mockStrategy": "A String", # Mockstrategy defines how the particular task should be mocked during test execution
"parameters": [ # Optional. List of key-value pairs for specific mock strategy
{ # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Next available id: 4
"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": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
"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.
},
},
],
},
"task": "A String", # Required. This defines in the test case, the task name in integration which will be mocked by this test task config
"taskConfig": { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. # Optional. Auto-generated.
"conditionalFailurePolicies": { # Conditional task failur retry strategies # Optional. The list of conditional failure policies that will be applied to the task in order.
"defaultFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # The default failure policy to be applied if no conditional failure policy matches.
"condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"failurePolicies": [ # The list of failure policies that will be applied to the task in order.
{ # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied).
"condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
],
},
"description": "A String", # Optional. User-provided description intended to give additional business context about the task.
"displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
"errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
"externalTaskType": "A String", # Optional. External task type of the task
"failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
"condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"jsonValidationOption": "A String", # Optional. If set, overrides the option configured in the Task implementation class.
"nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
{ # The task that is next in line to be executed, if the condition specified evaluated to true.
"condition": "A String", # Standard filter expression for this task to become an eligible next task.
"description": "A String", # User-provided description intended to give additional business context about the task.
"displayName": "A String", # User-provided label that is attached to this edge in the UI.
"taskConfigId": "A String", # ID of the next task.
"taskId": "A String", # Task number of the next task.
},
],
"nextTasksExecutionPolicy": "A String", # Optional. The policy dictating the execution of the next set of tasks for the current task.
"parameters": { # Optional. The customized parameters the user can pass to this task.
"a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Next available id: 4
"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": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
"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.
},
},
},
"position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI.
"x": 42, # Required. X axis of the coordinate
"y": 42, # Required. Y axis of the coordinate
},
"successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Optional. Determines what action to take upon successful task completion.
"finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
},
"synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
"condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"task": "A String", # Optional. The name for the task.
"taskExecutionStrategy": "A String", # Optional. The policy dictating the execution strategy of this task.
"taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
"taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template
},
"taskNumber": "A String", # Required. This defines in the test case, the task in integration which will be mocked by this test task config
},
],
"triggerConfig": { # Configuration detail of a trigger. # Optional. Auto-generated.
"alertConfig": [ # Optional. An alert threshold configuration for the [trigger + client + integration] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + integration] when published.
{ # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
"aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week). For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
"alertThreshold": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
"disableAlert": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this integration alert.
"displayName": "A String", # Name of the alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the integration.
"durationThreshold": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
"metricType": "A String", # The type of metric.
"onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
"thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
"thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. # The metric value, above or below which the alert should be triggered.
"absolute": "A String", # Absolute value threshold.
"percentage": 42, # Percentage threshold.
},
},
],
"cloudSchedulerConfig": { # Cloud Scheduler Trigger configuration # Optional. Cloud Scheduler Trigger related metadata
"cronTab": "A String", # Required. The cron tab of cloud scheduler trigger.
"errorMessage": "A String", # Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations
"location": "A String", # Required. The location where associated cloud scheduler job will be created
"serviceAccountEmail": "A String", # Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time
},
"description": "A String", # Optional. User-provided description intended to give additional business context about the task.
"errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
"inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger.
"names": [ # Optional. List of variable names.
"A String",
],
},
"label": "A String", # Optional. The user created label for a particular trigger.
"nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed.
"outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger.
"names": [ # Optional. List of variable names.
"A String",
],
},
"position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI.
"x": 42, # Required. X axis of the coordinate
"y": 42, # Required. Y axis of the coordinate
},
"properties": { # Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Pub/sub triggers.
"a_key": "A String",
},
"startTasks": [ # Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph).
{ # The task that is next in line to be executed, if the condition specified evaluated to true.
"condition": "A String", # Standard filter expression for this task to become an eligible next task.
"description": "A String", # User-provided description intended to give additional business context about the task.
"displayName": "A String", # User-provided label that is attached to this edge in the UI.
"taskConfigId": "A String", # ID of the next task.
"taskId": "A String", # Task number of the next task.
},
],
"trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose.
"triggerId": "A String", # Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format: api_trigger/TRIGGER_NAME Where trigger config has properties with value {"Trigger name": TRIGGER_NAME}
"triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI.
"triggerType": "A String", # Optional. Type of trigger
},
"triggerId": "A String", # Required. This defines the trigger ID in workflow which is considered to be executed as starting point of the test case
"updateTime": "A String", # Auto-generated.
}
upload(parent, body=None, x__xgafv=None)
Uploads a test case. The content can be a previously downloaded test case. Performs the same function as CreateTestCase, but accepts input in a string format, which holds the complete representation of the TestCase content.
Args:
parent: string, Required. The test case to upload. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{integration_version} (required)
body: object, The request body.
The object takes the form of:
{ # Request for UploadTestCase.
"content": "A String", # The textproto of the test case.
"fileFormat": "A String", # File format for upload request.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for UploadTestCase.
"testCase": { # Defines the functional test case for Application Integration. Next available id: 15 # The uploaded TestCase
"createTime": "A String", # Auto-generated.
"creatorEmail": "A String", # Optional. The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
"databasePersistencePolicy": "A String", # Optional. Various policies for how to persist the test execution info including execution info, execution export info, execution metadata index and execution param index..
"description": "A String", # Optional. Description of the test case.
"displayName": "A String", # Required. The display name of test case.
"lastModifierEmail": "A String", # The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
"lockHolderEmail": "A String", # Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
"name": "A String", # Output only. Auto-generated primary key.
"testInputParameters": [ # Optional. Parameters that are expected to be passed to the test case when the test case is triggered. This gives the user the ability to provide default values. This should include all the output variables of the trigger as input variables.
{ # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.
"containsLargeData": True or False, # Indicates whether this variable contains large data and need to be uploaded to Cloud Storage.
"dataType": "A String", # Type of the parameter.
"defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
"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.
},
"description": "A String", # Optional. Description of the parameter.
"displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
"inputOutputType": "A String", # Specifies the input/output type for the parameter.
"isTransient": True or False, # Whether this parameter is a transient parameter.
"jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this 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 integration definition.
"masked": True or False, # True if this parameter should be masked in the logs
"producer": "A String", # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
"searchable": True or False, # Searchable in the execution log or not.
},
],
"testTaskConfigs": [ # Optional. However, the test case doesn't mock or assert anything without test_task_configs.
{ # The task mock configuration details and assertions for functional tests. Next available id: 6
"assertions": [ # Optional. List of conditions or expressions which should be evaluated to true unless there is a bug/problem in the integration. These are evaluated one the task execution is completed as per the mock strategy in test case
{ # An assertion which will check for a condition over task execution status or an expression for task output variables Next available id: 5
"assertionStrategy": "A String", # The type of assertion to perform.
"condition": "A String", # Optional. Standard filter expression for ASSERT_CONDITION to succeed
"parameter": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Next available id: 4 # Optional. Key-value pair for ASSERT_EQUALS, ASSERT_NOT_EQUALS, ASSERT_CONTAINS to succeed
"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": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
"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.
},
},
"retryCount": 42, # Number of times given task should be retried in case of ASSERT_FAILED_EXECUTION
},
],
"mockConfig": { # The configuration for mocking of a task during test execution Next available id: 4 # Optional. Defines how to mock the given task during test execution
"failedExecutions": "A String", # Optional. Number of times the given task should fail for failure mock strategy
"mockStrategy": "A String", # Mockstrategy defines how the particular task should be mocked during test execution
"parameters": [ # Optional. List of key-value pairs for specific mock strategy
{ # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Next available id: 4
"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": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
"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.
},
},
],
},
"task": "A String", # Required. This defines in the test case, the task name in integration which will be mocked by this test task config
"taskConfig": { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. # Optional. Auto-generated.
"conditionalFailurePolicies": { # Conditional task failur retry strategies # Optional. The list of conditional failure policies that will be applied to the task in order.
"defaultFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # The default failure policy to be applied if no conditional failure policy matches.
"condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"failurePolicies": [ # The list of failure policies that will be applied to the task in order.
{ # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied).
"condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
],
},
"description": "A String", # Optional. User-provided description intended to give additional business context about the task.
"displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
"errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
"externalTaskType": "A String", # Optional. External task type of the task
"failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
"condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"jsonValidationOption": "A String", # Optional. If set, overrides the option configured in the Task implementation class.
"nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
{ # The task that is next in line to be executed, if the condition specified evaluated to true.
"condition": "A String", # Standard filter expression for this task to become an eligible next task.
"description": "A String", # User-provided description intended to give additional business context about the task.
"displayName": "A String", # User-provided label that is attached to this edge in the UI.
"taskConfigId": "A String", # ID of the next task.
"taskId": "A String", # Task number of the next task.
},
],
"nextTasksExecutionPolicy": "A String", # Optional. The policy dictating the execution of the next set of tasks for the current task.
"parameters": { # Optional. The customized parameters the user can pass to this task.
"a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Next available id: 4
"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": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
"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.
},
},
},
"position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI.
"x": 42, # Required. X axis of the coordinate
"y": 42, # Required. Y axis of the coordinate
},
"successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Optional. Determines what action to take upon successful task completion.
"finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
},
"synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
"condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"task": "A String", # Optional. The name for the task.
"taskExecutionStrategy": "A String", # Optional. The policy dictating the execution strategy of this task.
"taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
"taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template
},
"taskNumber": "A String", # Required. This defines in the test case, the task in integration which will be mocked by this test task config
},
],
"triggerConfig": { # Configuration detail of a trigger. # Optional. Auto-generated.
"alertConfig": [ # Optional. An alert threshold configuration for the [trigger + client + integration] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + integration] when published.
{ # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
"aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week). For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
"alertThreshold": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
"disableAlert": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this integration alert.
"displayName": "A String", # Name of the alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the integration.
"durationThreshold": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
"metricType": "A String", # The type of metric.
"onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
"thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
"thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. # The metric value, above or below which the alert should be triggered.
"absolute": "A String", # Absolute value threshold.
"percentage": 42, # Percentage threshold.
},
},
],
"cloudSchedulerConfig": { # Cloud Scheduler Trigger configuration # Optional. Cloud Scheduler Trigger related metadata
"cronTab": "A String", # Required. The cron tab of cloud scheduler trigger.
"errorMessage": "A String", # Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations
"location": "A String", # Required. The location where associated cloud scheduler job will be created
"serviceAccountEmail": "A String", # Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time
},
"description": "A String", # Optional. User-provided description intended to give additional business context about the task.
"errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
"inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger.
"names": [ # Optional. List of variable names.
"A String",
],
},
"label": "A String", # Optional. The user created label for a particular trigger.
"nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed.
"outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger.
"names": [ # Optional. List of variable names.
"A String",
],
},
"position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI.
"x": 42, # Required. X axis of the coordinate
"y": 42, # Required. Y axis of the coordinate
},
"properties": { # Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Pub/sub triggers.
"a_key": "A String",
},
"startTasks": [ # Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph).
{ # The task that is next in line to be executed, if the condition specified evaluated to true.
"condition": "A String", # Standard filter expression for this task to become an eligible next task.
"description": "A String", # User-provided description intended to give additional business context about the task.
"displayName": "A String", # User-provided label that is attached to this edge in the UI.
"taskConfigId": "A String", # ID of the next task.
"taskId": "A String", # Task number of the next task.
},
],
"trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose.
"triggerId": "A String", # Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format: api_trigger/TRIGGER_NAME Where trigger config has properties with value {"Trigger name": TRIGGER_NAME}
"triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI.
"triggerType": "A String", # Optional. Type of trigger
},
"triggerId": "A String", # Required. This defines the trigger ID in workflow which is considered to be executed as starting point of the test case
"updateTime": "A String", # Auto-generated.
},
}