| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="integrations_v1.html">Application Integration API</a> . <a href="integrations_v1.projects.html">projects</a> . <a href="integrations_v1.projects.locations.html">locations</a> . <a href="integrations_v1.projects.locations.integrations.html">integrations</a> . <a href="integrations_v1.projects.locations.integrations.versions.html">versions</a> . <a href="integrations_v1.projects.locations.integrations.versions.testCases.html">testCases</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#create">create(parent, body=None, testCaseId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates a new test case</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes a test case</p> |
| <p class="toc_element"> |
| <code><a href="#download">download(name, fileFormat=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Downloads a test case. Retrieves the `TestCase` for a given `test_case_id` and returns the response as a string.</p> |
| <p class="toc_element"> |
| <code><a href="#execute">execute(parent, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Executes all test cases in an integration version.</p> |
| <p class="toc_element"> |
| <code><a href="#executeTest">executeTest(testCaseName, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Executes functional test</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Get a test case</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists all the test cases that satisfy the filters.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next()</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Updates a test case</p> |
| <p class="toc_element"> |
| <code><a href="#takeoverEditLock">takeoverEditLock(name, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Clear the lock fields and assign them to current user</p> |
| <p class="toc_element"> |
| <code><a href="#upload">upload(parent, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">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.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="create">create(parent, body=None, testCaseId=None, x__xgafv=None)</code> |
| <pre>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 |
| "assertionStrategy": "A String", # Optional. 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 |
| "assertionStrategy": "A String", # Optional. 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. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| <pre>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); } |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="download">download(name, fileFormat=None, x__xgafv=None)</code> |
| <pre>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. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="execute">execute(parent, body=None, x__xgafv=None)</code> |
| <pre>Executes all test cases in an integration version. |
| |
| Args: |
| parent: string, Required. The parent resource whose test cases are executed. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{integration_version} (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request for ExecuteTestCases. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response for ExecuteTestCases. |
| "executeTestCaseResponses": [ # Results of each execution of test cases in an integration version. |
| { # 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 # Assertion that was run. |
| "assertionStrategy": "A String", # Optional. 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 |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="executeTest">executeTest(testCaseName, body=None, x__xgafv=None)</code> |
| <pre>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 # Assertion that was run. |
| "assertionStrategy": "A String", # Optional. 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 |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>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 |
| "assertionStrategy": "A String", # Optional. 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. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)</code> |
| <pre>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 |
| "assertionStrategy": "A String", # Optional. 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. |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next()</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| <pre>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 |
| "assertionStrategy": "A String", # Optional. 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 |
| "assertionStrategy": "A String", # Optional. 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. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="takeoverEditLock">takeoverEditLock(name, body=None, x__xgafv=None)</code> |
| <pre>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 |
| "assertionStrategy": "A String", # Optional. 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. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="upload">upload(parent, body=None, x__xgafv=None)</code> |
| <pre>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 |
| "assertionStrategy": "A String", # Optional. 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. |
| }, |
| }</pre> |
| </div> |
| |
| </body></html> |
