diff --git a/docs/dyn/integrations_v1alpha.projects.locations.html b/docs/dyn/integrations_v1alpha.projects.locations.html index 49a90bff4a2..86a70776507 100644 --- a/docs/dyn/integrations_v1alpha.projects.locations.html +++ b/docs/dyn/integrations_v1alpha.projects.locations.html @@ -112,176 +112,10 @@

Instance Methods

close()

Close httplib2 connections.

-

- listTaskEntities(parent, x__xgafv=None)

-

This is a UI only method and will be moved away. Returns a list of common tasks.

Method Details

close()
Close httplib2 connections.
-
- listTaskEntities(parent, x__xgafv=None) -
This is a UI only method and will be moved away. Returns a list of common tasks.
-
-Args:
-  parent: string, Required. The location resource of the request. This is not going to be used but preserve the field for future. (required)
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # This is a UI only method and will be moved away. Response for ListTaskEntities.
-  "taskEntities": [ # The list of the tasks.
-    { # Contains a task's metadata and associated information. Next available id: 7
-      "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc
-      "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on.
-        "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name.
-        "admins": [
-          { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar.
-            "googleGroupEmail": "A String",
-            "userEmail": "A String",
-          },
-        ],
-        "category": "A String",
-        "codeSearchLink": "A String", # The Code Search link to the Task Java file.
-        "defaultJsonValidationOption": "A String", # Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution.
-        "defaultSpec": "A String", # Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format.
-        "description": "A String", # In a few sentences, describe the purpose and usage of the task.
-        "descriptiveName": "A String", # The string name to show on the task list on the Workflow editor screen. This should be a very short, one to two words name for the task. (e.g. "Send Mail")
-        "docMarkdown": "A String", # Snippet of markdown documentation to embed in the RHP for this task.
-        "externalCategory": "A String",
-        "externalCategorySequence": 42, # Sequence with which the task in specific category to be displayed in task discovery panel for external users.
-        "externalDocHtml": "A String", # External-facing documention embedded in the RHP for this task.
-        "externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc).
-        "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html.
-        "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available
-        "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons.
-        "isDeprecated": True or False, # The deprecation status of the current task. Default value is false;
-        "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class.
-        "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html
-        "status": "A String", # Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE.
-        "system": "A String",
-        "tags": [ # A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names ("REST Caller" vs. "Call REST Endpoint") or to help users find tasks based on related words.
-          "A String",
-        ],
-      },
-      "paramSpecs": { # Declarations for inputs/outputs for a TypedTask. This is also associated with the METADATA mask.
-        "parameters": [
-          { # Key-value pair of EventBus task parameters. Next id: 13
-            "className": "A String", # The FQCN of the Java object this represents. A string, for example, would be "java.lang.String". If this is "java.lang.Object", the parameter can be of any type.
-            "collectionElementClassName": "A String", # If it is a collection of objects, this would be the FCQN of every individual element in the collection. If this is "java.lang.Object", the parameter is a collection of any type.
-            "config": { # Optional fields, such as help text and other useful info.
-              "descriptivePhrase": "A String", # A short phrase to describe what this parameter contains.
-              "helpText": "A String", # Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter.
-              "hideDefaultValue": True or False, # Whether the default value is hidden in the UI.
-              "inputDisplayOption": "A String",
-              "isHidden": True or False, # Whether this field is hidden in the UI.
-              "label": "A String", # A user-friendly label for the parameter.
-              "parameterNameOption": "A String",
-              "subSectionLabel": "A String", # A user-friendly label for subSection under which the parameter will be displayed.
-              "uiPlaceholderText": "A String", # Placeholder text which will appear in the UI input form for this parameter.
-            },
-            "dataType": "A String", # The data type of the parameter.
-            "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
-              "booleanArray": {
-                "booleanValues": [
-                  True or False,
-                ],
-              },
-              "booleanValue": True or False,
-              "doubleArray": {
-                "doubleValues": [
-                  3.14,
-                ],
-              },
-              "doubleValue": 3.14,
-              "intArray": {
-                "intValues": [
-                  "A String",
-                ],
-              },
-              "intValue": "A String",
-              "jsonValue": "A String",
-              "protoArray": {
-                "protoValues": [
-                  {
-                    "a_key": "", # Properties of the object. Contains field @type with type URL.
-                  },
-                ],
-              },
-              "protoValue": {
-                "a_key": "", # Properties of the object. Contains field @type with type URL.
-              },
-              "serializedObjectValue": {
-                "objectValue": "A String",
-              },
-              "stringArray": {
-                "stringValues": [
-                  "A String",
-                ],
-              },
-              "stringValue": "A String",
-            },
-            "isDeprecated": True or False, # If set, this entry is deprecated, so further use of this parameter should be prohibited.
-            "isOutput": True or False,
-            "jsonSchema": "A String", # If the data_type is JSON_VALUE, then this will define its schema.
-            "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given task. These parameters must be predefined in the workflow definition.
-            "protoDef": { # Populated if this represents a proto or proto array.
-              "fullName": "A String", # The fully-qualified proto name. This message, for example, would be "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition".
-              "path": "A String", # Path to the proto file that contains the message type's definition.
-            },
-            "required": True or False, # If set, the user must provide an input value for this parameter.
-            "validationRule": { # Rule used to validate inputs (individual values and collection elements) for this parameter.
-              "doubleRange": { # Range used to validate doubles and floats.
-                "max": 3.14, # The inclusive maximum of the acceptable range.
-                "min": 3.14, # The inclusive minimum of the acceptable range.
-              },
-              "intRange": { # Range used to validate longs and ints.
-                "max": "A String", # The inclusive maximum of the acceptable range.
-                "min": "A String", # The inclusive minimum of the acceptable range.
-              },
-              "stringRegex": { # Rule used to validate strings.
-                "exclusive": True or False, # Whether the regex matcher is applied exclusively (if true, matching values will be rejected).
-                "regex": "A String", # The regex applied to the input value(s).
-              },
-            },
-          },
-        ],
-      },
-      "stats": { # Stats for the requested dimensions: QPS, duration, and error/warning rate # Deprecated - statistics from the Monarch query.
-        "dimensions": { # Dimensions that these stats have been aggregated on.
-          "clientId": "A String",
-          "enumFilterType": "A String", # Whether to include or exclude the enums matching the regex.
-          "errorEnumString": "A String",
-          "retryAttempt": "A String",
-          "taskName": "A String",
-          "taskNumber": "A String",
-          "triggerId": "A String", # Stats have been or will be aggregated on set fields for any semantically-meaningful combination.
-          "warningEnumString": "A String",
-          "workflowId": "A String",
-          "workflowName": "A String",
-        },
-        "durationInSeconds": 3.14, # Average duration in seconds.
-        "errorRate": 3.14, # Average error rate.
-        "qps": 3.14, # Queries per second.
-        "warningRate": 3.14, # Average warning rate.
-      },
-      "taskType": "A String", # Defines the type of the task
-      "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask.
-        "taskUiModuleConfigs": [ # Configurations of included config modules.
-          { # Task author would use this type to configure a config module.
-            "moduleId": "A String", # ID of the config module.
-          },
-        ],
-      },
-    },
-  ],
-}
-
- \ No newline at end of file diff --git a/docs/dyn/integrations_v1alpha.projects.locations.integrations.executions.html b/docs/dyn/integrations_v1alpha.projects.locations.integrations.executions.html index 328c8fc7537..b4921b54468 100644 --- a/docs/dyn/integrations_v1alpha.projects.locations.integrations.executions.html +++ b/docs/dyn/integrations_v1alpha.projects.locations.integrations.executions.html @@ -162,7 +162,7 @@

Method Details

"result": True or False, # the result comes out after evaluate the combined condition. True if there's no combined condition specified. }, ], - "diffParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters in Event object that differs from last snapshot. + "diffParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # The parameters in Event object that differs from last snapshot. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution. { # Key-value pair of EventBus parameters. "dataType": "A String", # Explicitly getting the type of the parameter. @@ -218,7 +218,7 @@

Method Details

"taskName": "A String", # the task name associated with this snapshot. Could be empty. "taskNumber": "A String", # The task number associated with this snapshot. Could be empty. }, - "eventParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters in Event object. + "eventParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # The parameters in Event object. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution. { # Key-value pair of EventBus parameters. "dataType": "A String", # Explicitly getting the type of the parameter. @@ -298,7 +298,7 @@

Method Details

"postMethod": "A String", # The ways user posts this event. "product": "A String", # Which Google product the execution_info belongs to. If not set, the execution_info belongs to Integration Platform by default. "requestId": "A String", # Optional. This is used to de-dup incoming request. - "requestParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Event parameters come in as part of the request. + "requestParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Event parameters come in as part of the request. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution. { # Key-value pair of EventBus parameters. "dataType": "A String", # Explicitly getting the type of the parameter. @@ -346,7 +346,7 @@

Method Details

}, ], }, - "responseParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Event parameters come out as part of the response. + "responseParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Event parameters come out as part of the response. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution. { # Key-value pair of EventBus parameters. "dataType": "A String", # Explicitly getting the type of the parameter. @@ -425,7 +425,7 @@

Method Details

"result": True or False, # the result comes out after evaluate the combined condition. True if there's no combined condition specified. }, ], - "diffParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters in Event object that differs from last snapshot. + "diffParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # The parameters in Event object that differs from last snapshot. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. @@ -479,7 +479,7 @@

Method Details

"taskName": "A String", # the task name associated with this snapshot. Could be empty. "taskNumber": "A String", # The task number associated with this snapshot. Could be empty. }, - "eventParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters in Event object. + "eventParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # The parameters in Event object. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. diff --git a/docs/dyn/integrations_v1alpha.projects.locations.integrations.executions.suspensions.html b/docs/dyn/integrations_v1alpha.projects.locations.integrations.executions.suspensions.html index e0dbc1b2fb4..8638095f55d 100644 --- a/docs/dyn/integrations_v1alpha.projects.locations.integrations.executions.suspensions.html +++ b/docs/dyn/integrations_v1alpha.projects.locations.integrations.executions.suspensions.html @@ -190,7 +190,7 @@

Method Details

"postToQueueWithTriggerIdRequest": { # Use this request to post all workflows associated with a given trigger id. Next available id: 10 # Request to fire an event containing the SuspensionInfo message. "clientId": "A String", # Optional. If the client id is provided, then the combination of trigger id and client id is matched across all the workflows. If the client id is not provided, then workflows with matching trigger id are executed for each client id in the {@link TriggerConfig}. For Api Trigger, the client id is required and will be validated against the allowed clients. "ignoreErrorIfNoActiveWorkflow": True or False, # Optional. Flag to determine whether clients would suppress a warning when no ACTIVE workflows are not found. If this flag is set to be true, an error will not be thrown if the requested trigger_id or client_id is not found in any ACTIVE workflow. Otherwise, the error is always thrown. The flag is set to be false by default. - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Passed in as parameters to each workflow execution. Optional. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Passed in as parameters to each workflow execution. Optional. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. @@ -345,7 +345,7 @@

Method Details

"postToQueueWithTriggerIdRequest": { # Use this request to post all workflows associated with a given trigger id. Next available id: 10 # Request to fire an event containing the SuspensionInfo message. "clientId": "A String", # Optional. If the client id is provided, then the combination of trigger id and client id is matched across all the workflows. If the client id is not provided, then workflows with matching trigger id are executed for each client id in the {@link TriggerConfig}. For Api Trigger, the client id is required and will be validated against the allowed clients. "ignoreErrorIfNoActiveWorkflow": True or False, # Optional. Flag to determine whether clients would suppress a warning when no ACTIVE workflows are not found. If this flag is set to be true, an error will not be thrown if the requested trigger_id or client_id is not found in any ACTIVE workflow. Otherwise, the error is always thrown. The flag is set to be false by default. - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Passed in as parameters to each workflow execution. Optional. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Passed in as parameters to each workflow execution. Optional. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. diff --git a/docs/dyn/integrations_v1alpha.projects.locations.integrations.html b/docs/dyn/integrations_v1alpha.projects.locations.integrations.html index 2510230cab9..c9d17188ae2 100644 --- a/docs/dyn/integrations_v1alpha.projects.locations.integrations.html +++ b/docs/dyn/integrations_v1alpha.projects.locations.integrations.html @@ -213,7 +213,7 @@

Method Details

}, }, ], - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. Passed in as parameters to each integration execution. Redacted + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Optional. Passed in as parameters to each integration execution. Redacted "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution. { # Key-value pair of EventBus parameters. "dataType": "A String", # Explicitly getting the type of the parameter. @@ -274,7 +274,7 @@

Method Details

An object of the form: { # The response for executing an integration. - "eventParameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Details for the integration that were executed. + "eventParameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Details for the integration that were executed. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution. { # Key-value pair of EventBus parameters. "dataType": "A String", # Explicitly getting the type of the parameter. @@ -506,7 +506,7 @@

Method Details

}, }, ], - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Passed in as parameters to each integration execution. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Passed in as parameters to each integration execution. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. diff --git a/docs/dyn/integrations_v1alpha.projects.locations.integrations.versions.html b/docs/dyn/integrations_v1alpha.projects.locations.integrations.versions.html index f704a0fc210..fda9386d553 100644 --- a/docs/dyn/integrations_v1alpha.projects.locations.integrations.versions.html +++ b/docs/dyn/integrations_v1alpha.projects.locations.integrations.versions.html @@ -74,18 +74,12 @@

Application Integration API . projects . locations . integrations . versions

Instance Methods

-

- archive(name, body=None, x__xgafv=None)

-

Soft-deletes the integration. Changes the status of the integration to ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag is removed from this snapshot and set to the previous non-ARCHIVED snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. This RPC throws an exception if the version being archived is DRAFT, and if the `locked_by` user is not the same as the user performing the Archive. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Archiving a integration. Currently, there is no unarchive mechanism.

close()

Close httplib2 connections.

create(parent, body=None, newIntegration=None, x__xgafv=None)

Create a integration with a draft version in the specified project.

-

- deactivate(name, body=None, x__xgafv=None)

-

Sets the status of the ACTIVE integration to SNAPSHOT with a new tag "PREVIOUSLY_PUBLISHED" after validating it. The "HEAD" and "PUBLISH_REQUESTED" tags do not change. This RPC throws an exception if the version being snapshot is not ACTIVE. Audit fields added include action, action_by, action_timestamp.

delete(name, x__xgafv=None)

Soft-deletes the integration. Changes the status of the integration to ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag is removed from this snapshot and set to the previous non-ARCHIVED snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. This RPC throws an exception if the version being deleted is DRAFT, and if the `locked_by` user is not the same as the user performing the Delete. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Deleting a integration. Currently, there is no undelete mechanism.

@@ -116,34 +110,7 @@

Instance Methods

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

Uploads an integration. The content can be a previously downloaded integration. Performs the same function as CreateDraftIntegrationVersion, but accepts input in a string format, which holds the complete representation of the IntegrationVersion content.

-

- validate(name, body=None, x__xgafv=None)

-

Validates the given integration. If the id doesn't exist, a NotFoundException is thrown. If validation fails a CanonicalCodeException is thrown. If there was no failure an empty response is returned.

Method Details

-
- archive(name, body=None, x__xgafv=None) -
Soft-deletes the integration. Changes the status of the integration to ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag is removed from this snapshot and set to the previous non-ARCHIVED snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. This RPC throws an exception if the version being archived is DRAFT, and if the `locked_by` user is not the same as the user performing the Archive. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Archiving a integration. Currently, there is no unarchive mechanism.
-
-Args:
-  name: string, Required. The version to archive. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version} (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Request for ArchiveIntegrationVersion.
-}
-
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Response for ArchiveIntegrationVersion.
-}
-
-
close()
Close httplib2 connections.
@@ -204,7 +171,7 @@

Method Details

"integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { - "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters. + "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...) "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults. "booleanValue": True or False, @@ -232,7 +199,7 @@

Method Details

}, "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered. "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. - "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details. + "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. @@ -304,7 +271,7 @@

Method Details

"stringValue": "A String", }, "inOutType": "A String", # Specifies the input/output type for the parameter. - "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters + "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 workflow definition. "name": "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". @@ -395,7 +362,7 @@

Method Details

"taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. - { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured. + { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in 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). "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert. "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow. @@ -412,7 +379,7 @@

Method Details

"onlyFinalAttempt": True or False, # Only count final task attempts, not retries. "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert. "thresholdType": "A String", # The threshold type 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. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. + "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", "percentage": 42, }, @@ -534,7 +501,7 @@

Method Details

"precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task. "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI. "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times). - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Optional. The customized parameters the user can pass to this task. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution. { # Key-value pair of EventBus parameters. "dataType": "A String", # Explicitly getting the type of the parameter. @@ -597,7 +564,7 @@

Method Details

}, "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of. "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc - "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on. + "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. # Metadata inclueds the task name, author and so on. "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name. "admins": [ { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar. @@ -618,7 +585,7 @@

Method Details

"externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc). "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html. "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available - "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons. + "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. "isDeprecated": True or False, # The deprecation status of the current task. Default value is false; "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class. "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html @@ -730,7 +697,7 @@

Method Details

"warningRate": 3.14, # Average warning rate. }, "taskType": "A String", # Defines the type of the task - "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask. + "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: # UI configuration for this task Also associated with the METADATA mask. "taskUiModuleConfigs": [ # Configurations of included config modules. { # Task author would use this type to configure a config module. "moduleId": "A String", # ID of the config module. @@ -754,7 +721,7 @@

Method Details

"nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching). "name": "A String", # Required. Name of the next teardown task. }, - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # The parameters the user can pass to this task. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. @@ -800,7 +767,7 @@

Method Details

}, ], }, - "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details. + "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. "properties": [ # An unordered list of property entries. { # Key-value pair of EventBus property. "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values. @@ -882,7 +849,7 @@

Method Details

"triggerConfigsInternal": [ # Optional. Trigger configurations. { # Configuration detail of a trigger. Next available id: 17 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] 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 + workflow] when published. - { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured. + { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours. "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert. "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow. @@ -899,7 +866,7 @@

Method Details

"onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries. "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert. "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. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples. + "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", "percentage": 42, }, @@ -976,7 +943,7 @@

Method Details

], "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true. "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly. - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Optional. To be used in TaskConfig for the implementation class. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. @@ -1088,7 +1055,7 @@

Method Details

"integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { - "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters. + "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...) "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults. "booleanValue": True or False, @@ -1116,7 +1083,7 @@

Method Details

}, "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered. "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. - "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details. + "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. @@ -1188,7 +1155,7 @@

Method Details

"stringValue": "A String", }, "inOutType": "A String", # Specifies the input/output type for the parameter. - "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters + "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 workflow definition. "name": "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". @@ -1279,7 +1246,7 @@

Method Details

"taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. - { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured. + { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in 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). "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert. "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow. @@ -1296,7 +1263,7 @@

Method Details

"onlyFinalAttempt": True or False, # Only count final task attempts, not retries. "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert. "thresholdType": "A String", # The threshold type 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. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. + "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", "percentage": 42, }, @@ -1418,7 +1385,7 @@

Method Details

"precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task. "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI. "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times). - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Optional. The customized parameters the user can pass to this task. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution. { # Key-value pair of EventBus parameters. "dataType": "A String", # Explicitly getting the type of the parameter. @@ -1481,7 +1448,7 @@

Method Details

}, "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of. "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc - "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on. + "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. # Metadata inclueds the task name, author and so on. "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name. "admins": [ { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar. @@ -1502,7 +1469,7 @@

Method Details

"externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc). "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html. "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available - "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons. + "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. "isDeprecated": True or False, # The deprecation status of the current task. Default value is false; "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class. "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html @@ -1614,7 +1581,7 @@

Method Details

"warningRate": 3.14, # Average warning rate. }, "taskType": "A String", # Defines the type of the task - "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask. + "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: # UI configuration for this task Also associated with the METADATA mask. "taskUiModuleConfigs": [ # Configurations of included config modules. { # Task author would use this type to configure a config module. "moduleId": "A String", # ID of the config module. @@ -1638,7 +1605,7 @@

Method Details

"nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching). "name": "A String", # Required. Name of the next teardown task. }, - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # The parameters the user can pass to this task. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. @@ -1684,7 +1651,7 @@

Method Details

}, ], }, - "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details. + "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. "properties": [ # An unordered list of property entries. { # Key-value pair of EventBus property. "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values. @@ -1766,7 +1733,7 @@

Method Details

"triggerConfigsInternal": [ # Optional. Trigger configurations. { # Configuration detail of a trigger. Next available id: 17 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] 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 + workflow] when published. - { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured. + { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours. "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert. "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow. @@ -1783,7 +1750,7 @@

Method Details

"onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries. "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert. "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. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples. + "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", "percentage": 42, }, @@ -1860,7 +1827,7 @@

Method Details

], "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true. "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly. - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Optional. To be used in TaskConfig for the implementation class. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. @@ -1918,30 +1885,6 @@

Method Details

}
-
- deactivate(name, body=None, x__xgafv=None) -
Sets the status of the ACTIVE integration to SNAPSHOT with a new tag "PREVIOUSLY_PUBLISHED" after validating it. The "HEAD" and "PUBLISH_REQUESTED" tags do not change. This RPC throws an exception if the version being snapshot is not ACTIVE. Audit fields added include action, action_by, action_timestamp.
-
-Args:
-  name: string, Required. The version to deactivate. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version} (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Request for DeactivateIntegrationVersion.
-}
-
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Response for DeactivateIntegrationVersion.
-}
-
-
delete(name, x__xgafv=None)
Soft-deletes the integration. Changes the status of the integration to ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag is removed from this snapshot and set to the previous non-ARCHIVED snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. This RPC throws an exception if the version being deleted is DRAFT, and if the `locked_by` user is not the same as the user performing the Delete. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Deleting a integration. Currently, there is no undelete mechanism.
@@ -2044,7 +1987,7 @@ 

Method Details

"integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { - "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters. + "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...) "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults. "booleanValue": True or False, @@ -2072,7 +2015,7 @@

Method Details

}, "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered. "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. - "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details. + "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. @@ -2144,7 +2087,7 @@

Method Details

"stringValue": "A String", }, "inOutType": "A String", # Specifies the input/output type for the parameter. - "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters + "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 workflow definition. "name": "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". @@ -2235,7 +2178,7 @@

Method Details

"taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. - { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured. + { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in 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). "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert. "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow. @@ -2252,7 +2195,7 @@

Method Details

"onlyFinalAttempt": True or False, # Only count final task attempts, not retries. "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert. "thresholdType": "A String", # The threshold type 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. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. + "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", "percentage": 42, }, @@ -2374,7 +2317,7 @@

Method Details

"precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task. "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI. "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times). - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Optional. The customized parameters the user can pass to this task. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution. { # Key-value pair of EventBus parameters. "dataType": "A String", # Explicitly getting the type of the parameter. @@ -2437,7 +2380,7 @@

Method Details

}, "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of. "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc - "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on. + "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. # Metadata inclueds the task name, author and so on. "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name. "admins": [ { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar. @@ -2458,7 +2401,7 @@

Method Details

"externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc). "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html. "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available - "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons. + "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. "isDeprecated": True or False, # The deprecation status of the current task. Default value is false; "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class. "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html @@ -2570,7 +2513,7 @@

Method Details

"warningRate": 3.14, # Average warning rate. }, "taskType": "A String", # Defines the type of the task - "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask. + "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: # UI configuration for this task Also associated with the METADATA mask. "taskUiModuleConfigs": [ # Configurations of included config modules. { # Task author would use this type to configure a config module. "moduleId": "A String", # ID of the config module. @@ -2594,7 +2537,7 @@

Method Details

"nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching). "name": "A String", # Required. Name of the next teardown task. }, - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # The parameters the user can pass to this task. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. @@ -2640,7 +2583,7 @@

Method Details

}, ], }, - "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details. + "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. "properties": [ # An unordered list of property entries. { # Key-value pair of EventBus property. "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values. @@ -2722,7 +2665,7 @@

Method Details

"triggerConfigsInternal": [ # Optional. Trigger configurations. { # Configuration detail of a trigger. Next available id: 17 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] 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 + workflow] when published. - { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured. + { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours. "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert. "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow. @@ -2739,7 +2682,7 @@

Method Details

"onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries. "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert. "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. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples. + "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", "percentage": 42, }, @@ -2816,7 +2759,7 @@

Method Details

], "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true. "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly. - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Optional. To be used in TaskConfig for the implementation class. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. @@ -2941,7 +2884,7 @@

Method Details

"integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { - "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters. + "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...) "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults. "booleanValue": True or False, @@ -2969,7 +2912,7 @@

Method Details

}, "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered. "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. - "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details. + "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. @@ -3041,7 +2984,7 @@

Method Details

"stringValue": "A String", }, "inOutType": "A String", # Specifies the input/output type for the parameter. - "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters + "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 workflow definition. "name": "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". @@ -3132,7 +3075,7 @@

Method Details

"taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. - { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured. + { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in 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). "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert. "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow. @@ -3149,7 +3092,7 @@

Method Details

"onlyFinalAttempt": True or False, # Only count final task attempts, not retries. "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert. "thresholdType": "A String", # The threshold type 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. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. + "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", "percentage": 42, }, @@ -3271,7 +3214,7 @@

Method Details

"precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task. "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI. "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times). - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Optional. The customized parameters the user can pass to this task. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution. { # Key-value pair of EventBus parameters. "dataType": "A String", # Explicitly getting the type of the parameter. @@ -3334,7 +3277,7 @@

Method Details

}, "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of. "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc - "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on. + "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. # Metadata inclueds the task name, author and so on. "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name. "admins": [ { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar. @@ -3355,7 +3298,7 @@

Method Details

"externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc). "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html. "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available - "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons. + "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. "isDeprecated": True or False, # The deprecation status of the current task. Default value is false; "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class. "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html @@ -3467,7 +3410,7 @@

Method Details

"warningRate": 3.14, # Average warning rate. }, "taskType": "A String", # Defines the type of the task - "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask. + "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: # UI configuration for this task Also associated with the METADATA mask. "taskUiModuleConfigs": [ # Configurations of included config modules. { # Task author would use this type to configure a config module. "moduleId": "A String", # ID of the config module. @@ -3491,7 +3434,7 @@

Method Details

"nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching). "name": "A String", # Required. Name of the next teardown task. }, - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # The parameters the user can pass to this task. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. @@ -3537,7 +3480,7 @@

Method Details

}, ], }, - "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details. + "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. "properties": [ # An unordered list of property entries. { # Key-value pair of EventBus property. "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values. @@ -3619,7 +3562,7 @@

Method Details

"triggerConfigsInternal": [ # Optional. Trigger configurations. { # Configuration detail of a trigger. Next available id: 17 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] 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 + workflow] when published. - { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured. + { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours. "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert. "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow. @@ -3636,7 +3579,7 @@

Method Details

"onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries. "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert. "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. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples. + "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", "percentage": 42, }, @@ -3713,7 +3656,7 @@

Method Details

], "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true. "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly. - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Optional. To be used in TaskConfig for the implementation class. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. @@ -3844,7 +3787,7 @@

Method Details

"integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { - "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters. + "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...) "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults. "booleanValue": True or False, @@ -3872,7 +3815,7 @@

Method Details

}, "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered. "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. - "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details. + "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. @@ -3944,7 +3887,7 @@

Method Details

"stringValue": "A String", }, "inOutType": "A String", # Specifies the input/output type for the parameter. - "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters + "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 workflow definition. "name": "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". @@ -4035,7 +3978,7 @@

Method Details

"taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. - { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured. + { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in 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). "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert. "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow. @@ -4052,7 +3995,7 @@

Method Details

"onlyFinalAttempt": True or False, # Only count final task attempts, not retries. "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert. "thresholdType": "A String", # The threshold type 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. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. + "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", "percentage": 42, }, @@ -4174,7 +4117,7 @@

Method Details

"precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task. "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI. "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times). - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Optional. The customized parameters the user can pass to this task. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution. { # Key-value pair of EventBus parameters. "dataType": "A String", # Explicitly getting the type of the parameter. @@ -4237,7 +4180,7 @@

Method Details

}, "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of. "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc - "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on. + "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. # Metadata inclueds the task name, author and so on. "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name. "admins": [ { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar. @@ -4258,7 +4201,7 @@

Method Details

"externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc). "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html. "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available - "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons. + "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. "isDeprecated": True or False, # The deprecation status of the current task. Default value is false; "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class. "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html @@ -4370,7 +4313,7 @@

Method Details

"warningRate": 3.14, # Average warning rate. }, "taskType": "A String", # Defines the type of the task - "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask. + "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: # UI configuration for this task Also associated with the METADATA mask. "taskUiModuleConfigs": [ # Configurations of included config modules. { # Task author would use this type to configure a config module. "moduleId": "A String", # ID of the config module. @@ -4394,7 +4337,7 @@

Method Details

"nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching). "name": "A String", # Required. Name of the next teardown task. }, - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # The parameters the user can pass to this task. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. @@ -4440,7 +4383,7 @@

Method Details

}, ], }, - "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details. + "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. "properties": [ # An unordered list of property entries. { # Key-value pair of EventBus property. "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values. @@ -4522,7 +4465,7 @@

Method Details

"triggerConfigsInternal": [ # Optional. Trigger configurations. { # Configuration detail of a trigger. Next available id: 17 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] 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 + workflow] when published. - { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured. + { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours. "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert. "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow. @@ -4539,7 +4482,7 @@

Method Details

"onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries. "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert. "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. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples. + "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", "percentage": 42, }, @@ -4616,7 +4559,7 @@

Method Details

], "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true. "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly. - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Optional. To be used in TaskConfig for the implementation class. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. @@ -4728,7 +4671,7 @@

Method Details

"integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { - "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters. + "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...) "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults. "booleanValue": True or False, @@ -4756,7 +4699,7 @@

Method Details

}, "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered. "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. - "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details. + "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. @@ -4828,7 +4771,7 @@

Method Details

"stringValue": "A String", }, "inOutType": "A String", # Specifies the input/output type for the parameter. - "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters + "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 workflow definition. "name": "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". @@ -4919,7 +4862,7 @@

Method Details

"taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. - { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured. + { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in 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). "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert. "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow. @@ -4936,7 +4879,7 @@

Method Details

"onlyFinalAttempt": True or False, # Only count final task attempts, not retries. "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert. "thresholdType": "A String", # The threshold type 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. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. + "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", "percentage": 42, }, @@ -5058,7 +5001,7 @@

Method Details

"precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task. "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI. "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times). - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Optional. The customized parameters the user can pass to this task. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution. { # Key-value pair of EventBus parameters. "dataType": "A String", # Explicitly getting the type of the parameter. @@ -5121,7 +5064,7 @@

Method Details

}, "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of. "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc - "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on. + "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. # Metadata inclueds the task name, author and so on. "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name. "admins": [ { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar. @@ -5142,7 +5085,7 @@

Method Details

"externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc). "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html. "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available - "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons. + "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. "isDeprecated": True or False, # The deprecation status of the current task. Default value is false; "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class. "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html @@ -5254,7 +5197,7 @@

Method Details

"warningRate": 3.14, # Average warning rate. }, "taskType": "A String", # Defines the type of the task - "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask. + "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: # UI configuration for this task Also associated with the METADATA mask. "taskUiModuleConfigs": [ # Configurations of included config modules. { # Task author would use this type to configure a config module. "moduleId": "A String", # ID of the config module. @@ -5278,7 +5221,7 @@

Method Details

"nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching). "name": "A String", # Required. Name of the next teardown task. }, - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # The parameters the user can pass to this task. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. @@ -5324,7 +5267,7 @@

Method Details

}, ], }, - "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details. + "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. "properties": [ # An unordered list of property entries. { # Key-value pair of EventBus property. "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values. @@ -5406,7 +5349,7 @@

Method Details

"triggerConfigsInternal": [ # Optional. Trigger configurations. { # Configuration detail of a trigger. Next available id: 17 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] 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 + workflow] when published. - { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured. + { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours. "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert. "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow. @@ -5423,7 +5366,7 @@

Method Details

"onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries. "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert. "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. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples. + "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", "percentage": 42, }, @@ -5500,7 +5443,7 @@

Method Details

], "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true. "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly. - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Optional. To be used in TaskConfig for the implementation class. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. @@ -5649,7 +5592,7 @@

Method Details

"integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { - "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters. + "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...) "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults. "booleanValue": True or False, @@ -5677,7 +5620,7 @@

Method Details

}, "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered. "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. - "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details. + "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. @@ -5749,7 +5692,7 @@

Method Details

"stringValue": "A String", }, "inOutType": "A String", # Specifies the input/output type for the parameter. - "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters + "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 workflow definition. "name": "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". @@ -5840,7 +5783,7 @@

Method Details

"taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. - { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured. + { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in 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). "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert. "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow. @@ -5857,7 +5800,7 @@

Method Details

"onlyFinalAttempt": True or False, # Only count final task attempts, not retries. "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert. "thresholdType": "A String", # The threshold type 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. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. + "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", "percentage": 42, }, @@ -5979,7 +5922,7 @@

Method Details

"precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task. "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI. "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times). - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Optional. The customized parameters the user can pass to this task. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution. { # Key-value pair of EventBus parameters. "dataType": "A String", # Explicitly getting the type of the parameter. @@ -6042,7 +5985,7 @@

Method Details

}, "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of. "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc - "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on. + "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. # Metadata inclueds the task name, author and so on. "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name. "admins": [ { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar. @@ -6063,7 +6006,7 @@

Method Details

"externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc). "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html. "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available - "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons. + "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. "isDeprecated": True or False, # The deprecation status of the current task. Default value is false; "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class. "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html @@ -6175,7 +6118,7 @@

Method Details

"warningRate": 3.14, # Average warning rate. }, "taskType": "A String", # Defines the type of the task - "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask. + "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: # UI configuration for this task Also associated with the METADATA mask. "taskUiModuleConfigs": [ # Configurations of included config modules. { # Task author would use this type to configure a config module. "moduleId": "A String", # ID of the config module. @@ -6199,7 +6142,7 @@

Method Details

"nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching). "name": "A String", # Required. Name of the next teardown task. }, - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # The parameters the user can pass to this task. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. @@ -6245,7 +6188,7 @@

Method Details

}, ], }, - "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details. + "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. "properties": [ # An unordered list of property entries. { # Key-value pair of EventBus property. "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values. @@ -6327,7 +6270,7 @@

Method Details

"triggerConfigsInternal": [ # Optional. Trigger configurations. { # Configuration detail of a trigger. Next available id: 17 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] 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 + workflow] when published. - { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured. + { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours. "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert. "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow. @@ -6344,7 +6287,7 @@

Method Details

"onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries. "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert. "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. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples. + "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", "percentage": 42, }, @@ -6421,7 +6364,7 @@

Method Details

], "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true. "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly. - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Optional. To be used in TaskConfig for the implementation class. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. @@ -6573,7 +6516,7 @@

Method Details

"integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { - "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters. + "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...) "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults. "booleanValue": True or False, @@ -6601,7 +6544,7 @@

Method Details

}, "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered. "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. - "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details. + "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. @@ -6673,7 +6616,7 @@

Method Details

"stringValue": "A String", }, "inOutType": "A String", # Specifies the input/output type for the parameter. - "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters + "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 workflow definition. "name": "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". @@ -6764,7 +6707,7 @@

Method Details

"taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. - { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured. + { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in 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). "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert. "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow. @@ -6781,7 +6724,7 @@

Method Details

"onlyFinalAttempt": True or False, # Only count final task attempts, not retries. "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert. "thresholdType": "A String", # The threshold type 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. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. + "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", "percentage": 42, }, @@ -6903,7 +6846,7 @@

Method Details

"precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task. "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI. "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times). - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Optional. The customized parameters the user can pass to this task. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution. { # Key-value pair of EventBus parameters. "dataType": "A String", # Explicitly getting the type of the parameter. @@ -6966,7 +6909,7 @@

Method Details

}, "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of. "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc - "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on. + "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. # Metadata inclueds the task name, author and so on. "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name. "admins": [ { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar. @@ -6987,7 +6930,7 @@

Method Details

"externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc). "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html. "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available - "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons. + "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. "isDeprecated": True or False, # The deprecation status of the current task. Default value is false; "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class. "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html @@ -7099,7 +7042,7 @@

Method Details

"warningRate": 3.14, # Average warning rate. }, "taskType": "A String", # Defines the type of the task - "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask. + "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: # UI configuration for this task Also associated with the METADATA mask. "taskUiModuleConfigs": [ # Configurations of included config modules. { # Task author would use this type to configure a config module. "moduleId": "A String", # ID of the config module. @@ -7123,7 +7066,7 @@

Method Details

"nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching). "name": "A String", # Required. Name of the next teardown task. }, - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # The parameters the user can pass to this task. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. @@ -7169,7 +7112,7 @@

Method Details

}, ], }, - "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details. + "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. "properties": [ # An unordered list of property entries. { # Key-value pair of EventBus property. "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values. @@ -7251,7 +7194,7 @@

Method Details

"triggerConfigsInternal": [ # Optional. Trigger configurations. { # Configuration detail of a trigger. Next available id: 17 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] 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 + workflow] when published. - { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured. + { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours. "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert. "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow. @@ -7268,7 +7211,7 @@

Method Details

"onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries. "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert. "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. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples. + "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", "percentage": 42, }, @@ -7345,7 +7288,7 @@

Method Details

], "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true. "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly. - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Optional. To be used in TaskConfig for the implementation class. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. @@ -7404,28 +7347,4 @@

Method Details

}
-
- validate(name, body=None, x__xgafv=None) -
Validates the given integration. If the id doesn't exist, a NotFoundException is thrown. If validation fails a CanonicalCodeException is thrown. If there was no failure an empty response is returned.
-
-Args:
-  name: string, Required. The version to validate. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version} (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Request for ValidateIntegrationVersion.
-}
-
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Response for ValidateIntegrationVersion.
-}
-
- \ No newline at end of file diff --git a/docs/dyn/integrations_v1alpha.projects.locations.products.html b/docs/dyn/integrations_v1alpha.projects.locations.products.html index 87b6991b8b2..ab9f1d98b2c 100644 --- a/docs/dyn/integrations_v1alpha.projects.locations.products.html +++ b/docs/dyn/integrations_v1alpha.projects.locations.products.html @@ -102,215 +102,10 @@

Instance Methods

close()

Close httplib2 connections.

-

- createBundle(parent, body=None, x__xgafv=None)

-

PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. Create a bundle.

-

- listTaskEntities(parent, x__xgafv=None)

-

This is a UI only method and will be moved away. Returns a list of common tasks.

Method Details

close()
Close httplib2 connections.
-
- createBundle(parent, body=None, x__xgafv=None) -
PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. Create a bundle.
-
-Args:
-  parent: string, Required. The location resource of the request. (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. Request to create a new Bundle.
-  "bundleId": "A String", # Required. name of the bundle that will be created
-  "integrations": [ # A list of integrations that can be executed by the bundle
-    "A String",
-  ],
-  "secondaryCustomerOrgId": "A String", # Optional. The prefix for the SA, it should be in the format "o". This is an optional field, and if empty service account will be created per project, where we are creating bundle. This should only be used as the org ID for which we want to run the integrations in the bundle.
-}
-
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Response for create bundle.
-  "config": { # This proto holds the core runner data in the bundle task. It is not expected to be directly edited by the user. Instead, a default value will be provided at the task creation time. # It contains the bundle data
-    "integrations": [ # A bundle of integrations that can be executed by the task at runtime.
-      "A String",
-    ],
-    "serviceAccount": "A String", # Output only. The service account created and owned by IP and added to the customers GCP project.
-  },
-  "triggerId": "A String", # trigger_id of the bundle task
-}
-
- -
- listTaskEntities(parent, x__xgafv=None) -
This is a UI only method and will be moved away. Returns a list of common tasks.
-
-Args:
-  parent: string, Required. The location resource of the request. This is not going to be used but preserve the field for future. (required)
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # This is a UI only method and will be moved away. Response for ListTaskEntities.
-  "taskEntities": [ # The list of the tasks.
-    { # Contains a task's metadata and associated information. Next available id: 7
-      "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc
-      "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on.
-        "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name.
-        "admins": [
-          { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar.
-            "googleGroupEmail": "A String",
-            "userEmail": "A String",
-          },
-        ],
-        "category": "A String",
-        "codeSearchLink": "A String", # The Code Search link to the Task Java file.
-        "defaultJsonValidationOption": "A String", # Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution.
-        "defaultSpec": "A String", # Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format.
-        "description": "A String", # In a few sentences, describe the purpose and usage of the task.
-        "descriptiveName": "A String", # The string name to show on the task list on the Workflow editor screen. This should be a very short, one to two words name for the task. (e.g. "Send Mail")
-        "docMarkdown": "A String", # Snippet of markdown documentation to embed in the RHP for this task.
-        "externalCategory": "A String",
-        "externalCategorySequence": 42, # Sequence with which the task in specific category to be displayed in task discovery panel for external users.
-        "externalDocHtml": "A String", # External-facing documention embedded in the RHP for this task.
-        "externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc).
-        "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html.
-        "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available
-        "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons.
-        "isDeprecated": True or False, # The deprecation status of the current task. Default value is false;
-        "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class.
-        "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html
-        "status": "A String", # Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE.
-        "system": "A String",
-        "tags": [ # A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names ("REST Caller" vs. "Call REST Endpoint") or to help users find tasks based on related words.
-          "A String",
-        ],
-      },
-      "paramSpecs": { # Declarations for inputs/outputs for a TypedTask. This is also associated with the METADATA mask.
-        "parameters": [
-          { # Key-value pair of EventBus task parameters. Next id: 13
-            "className": "A String", # The FQCN of the Java object this represents. A string, for example, would be "java.lang.String". If this is "java.lang.Object", the parameter can be of any type.
-            "collectionElementClassName": "A String", # If it is a collection of objects, this would be the FCQN of every individual element in the collection. If this is "java.lang.Object", the parameter is a collection of any type.
-            "config": { # Optional fields, such as help text and other useful info.
-              "descriptivePhrase": "A String", # A short phrase to describe what this parameter contains.
-              "helpText": "A String", # Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter.
-              "hideDefaultValue": True or False, # Whether the default value is hidden in the UI.
-              "inputDisplayOption": "A String",
-              "isHidden": True or False, # Whether this field is hidden in the UI.
-              "label": "A String", # A user-friendly label for the parameter.
-              "parameterNameOption": "A String",
-              "subSectionLabel": "A String", # A user-friendly label for subSection under which the parameter will be displayed.
-              "uiPlaceholderText": "A String", # Placeholder text which will appear in the UI input form for this parameter.
-            },
-            "dataType": "A String", # The data type of the parameter.
-            "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
-              "booleanArray": {
-                "booleanValues": [
-                  True or False,
-                ],
-              },
-              "booleanValue": True or False,
-              "doubleArray": {
-                "doubleValues": [
-                  3.14,
-                ],
-              },
-              "doubleValue": 3.14,
-              "intArray": {
-                "intValues": [
-                  "A String",
-                ],
-              },
-              "intValue": "A String",
-              "jsonValue": "A String",
-              "protoArray": {
-                "protoValues": [
-                  {
-                    "a_key": "", # Properties of the object. Contains field @type with type URL.
-                  },
-                ],
-              },
-              "protoValue": {
-                "a_key": "", # Properties of the object. Contains field @type with type URL.
-              },
-              "serializedObjectValue": {
-                "objectValue": "A String",
-              },
-              "stringArray": {
-                "stringValues": [
-                  "A String",
-                ],
-              },
-              "stringValue": "A String",
-            },
-            "isDeprecated": True or False, # If set, this entry is deprecated, so further use of this parameter should be prohibited.
-            "isOutput": True or False,
-            "jsonSchema": "A String", # If the data_type is JSON_VALUE, then this will define its schema.
-            "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given task. These parameters must be predefined in the workflow definition.
-            "protoDef": { # Populated if this represents a proto or proto array.
-              "fullName": "A String", # The fully-qualified proto name. This message, for example, would be "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition".
-              "path": "A String", # Path to the proto file that contains the message type's definition.
-            },
-            "required": True or False, # If set, the user must provide an input value for this parameter.
-            "validationRule": { # Rule used to validate inputs (individual values and collection elements) for this parameter.
-              "doubleRange": { # Range used to validate doubles and floats.
-                "max": 3.14, # The inclusive maximum of the acceptable range.
-                "min": 3.14, # The inclusive minimum of the acceptable range.
-              },
-              "intRange": { # Range used to validate longs and ints.
-                "max": "A String", # The inclusive maximum of the acceptable range.
-                "min": "A String", # The inclusive minimum of the acceptable range.
-              },
-              "stringRegex": { # Rule used to validate strings.
-                "exclusive": True or False, # Whether the regex matcher is applied exclusively (if true, matching values will be rejected).
-                "regex": "A String", # The regex applied to the input value(s).
-              },
-            },
-          },
-        ],
-      },
-      "stats": { # Stats for the requested dimensions: QPS, duration, and error/warning rate # Deprecated - statistics from the Monarch query.
-        "dimensions": { # Dimensions that these stats have been aggregated on.
-          "clientId": "A String",
-          "enumFilterType": "A String", # Whether to include or exclude the enums matching the regex.
-          "errorEnumString": "A String",
-          "retryAttempt": "A String",
-          "taskName": "A String",
-          "taskNumber": "A String",
-          "triggerId": "A String", # Stats have been or will be aggregated on set fields for any semantically-meaningful combination.
-          "warningEnumString": "A String",
-          "workflowId": "A String",
-          "workflowName": "A String",
-        },
-        "durationInSeconds": 3.14, # Average duration in seconds.
-        "errorRate": 3.14, # Average error rate.
-        "qps": 3.14, # Queries per second.
-        "warningRate": 3.14, # Average warning rate.
-      },
-      "taskType": "A String", # Defines the type of the task
-      "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask.
-        "taskUiModuleConfigs": [ # Configurations of included config modules.
-          { # Task author would use this type to configure a config module.
-            "moduleId": "A String", # ID of the config module.
-          },
-        ],
-      },
-    },
-  ],
-}
-
- \ No newline at end of file diff --git a/docs/dyn/integrations_v1alpha.projects.locations.products.integrations.executions.html b/docs/dyn/integrations_v1alpha.projects.locations.products.integrations.executions.html index 1f568fe49fe..330f4e76722 100644 --- a/docs/dyn/integrations_v1alpha.projects.locations.products.integrations.executions.html +++ b/docs/dyn/integrations_v1alpha.projects.locations.products.integrations.executions.html @@ -161,7 +161,7 @@

Method Details

"result": True or False, # the result comes out after evaluate the combined condition. True if there's no combined condition specified. }, ], - "diffParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters in Event object that differs from last snapshot. + "diffParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # The parameters in Event object that differs from last snapshot. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. @@ -215,7 +215,7 @@

Method Details

"taskName": "A String", # the task name associated with this snapshot. Could be empty. "taskNumber": "A String", # The task number associated with this snapshot. Could be empty. }, - "eventParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters in Event object. + "eventParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # The parameters in Event object. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. @@ -571,7 +571,7 @@

Method Details

"result": True or False, # the result comes out after evaluate the combined condition. True if there's no combined condition specified. }, ], - "diffParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters in Event object that differs from last snapshot. + "diffParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # The parameters in Event object that differs from last snapshot. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution. { # Key-value pair of EventBus parameters. "dataType": "A String", # Explicitly getting the type of the parameter. @@ -627,7 +627,7 @@

Method Details

"taskName": "A String", # the task name associated with this snapshot. Could be empty. "taskNumber": "A String", # The task number associated with this snapshot. Could be empty. }, - "eventParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters in Event object. + "eventParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # The parameters in Event object. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution. { # Key-value pair of EventBus parameters. "dataType": "A String", # Explicitly getting the type of the parameter. @@ -707,7 +707,7 @@

Method Details

"postMethod": "A String", # The ways user posts this event. "product": "A String", # Which Google product the execution_info belongs to. If not set, the execution_info belongs to Integration Platform by default. "requestId": "A String", # Optional. This is used to de-dup incoming request. - "requestParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Event parameters come in as part of the request. + "requestParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Event parameters come in as part of the request. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution. { # Key-value pair of EventBus parameters. "dataType": "A String", # Explicitly getting the type of the parameter. @@ -755,7 +755,7 @@

Method Details

}, ], }, - "responseParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Event parameters come out as part of the response. + "responseParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Event parameters come out as part of the response. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution. { # Key-value pair of EventBus parameters. "dataType": "A String", # Explicitly getting the type of the parameter. @@ -834,7 +834,7 @@

Method Details

"result": True or False, # the result comes out after evaluate the combined condition. True if there's no combined condition specified. }, ], - "diffParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters in Event object that differs from last snapshot. + "diffParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # The parameters in Event object that differs from last snapshot. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. @@ -888,7 +888,7 @@

Method Details

"taskName": "A String", # the task name associated with this snapshot. Could be empty. "taskNumber": "A String", # The task number associated with this snapshot. Could be empty. }, - "eventParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters in Event object. + "eventParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # The parameters in Event object. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. diff --git a/docs/dyn/integrations_v1alpha.projects.locations.products.integrations.executions.suspensions.html b/docs/dyn/integrations_v1alpha.projects.locations.products.integrations.executions.suspensions.html index 01ec8350e9d..d242c967b52 100644 --- a/docs/dyn/integrations_v1alpha.projects.locations.products.integrations.executions.suspensions.html +++ b/docs/dyn/integrations_v1alpha.projects.locations.products.integrations.executions.suspensions.html @@ -190,7 +190,7 @@

Method Details

"postToQueueWithTriggerIdRequest": { # Use this request to post all workflows associated with a given trigger id. Next available id: 10 # Request to fire an event containing the SuspensionInfo message. "clientId": "A String", # Optional. If the client id is provided, then the combination of trigger id and client id is matched across all the workflows. If the client id is not provided, then workflows with matching trigger id are executed for each client id in the {@link TriggerConfig}. For Api Trigger, the client id is required and will be validated against the allowed clients. "ignoreErrorIfNoActiveWorkflow": True or False, # Optional. Flag to determine whether clients would suppress a warning when no ACTIVE workflows are not found. If this flag is set to be true, an error will not be thrown if the requested trigger_id or client_id is not found in any ACTIVE workflow. Otherwise, the error is always thrown. The flag is set to be false by default. - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Passed in as parameters to each workflow execution. Optional. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Passed in as parameters to each workflow execution. Optional. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. @@ -345,7 +345,7 @@

Method Details

"postToQueueWithTriggerIdRequest": { # Use this request to post all workflows associated with a given trigger id. Next available id: 10 # Request to fire an event containing the SuspensionInfo message. "clientId": "A String", # Optional. If the client id is provided, then the combination of trigger id and client id is matched across all the workflows. If the client id is not provided, then workflows with matching trigger id are executed for each client id in the {@link TriggerConfig}. For Api Trigger, the client id is required and will be validated against the allowed clients. "ignoreErrorIfNoActiveWorkflow": True or False, # Optional. Flag to determine whether clients would suppress a warning when no ACTIVE workflows are not found. If this flag is set to be true, an error will not be thrown if the requested trigger_id or client_id is not found in any ACTIVE workflow. Otherwise, the error is always thrown. The flag is set to be false by default. - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Passed in as parameters to each workflow execution. Optional. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Passed in as parameters to each workflow execution. Optional. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. diff --git a/docs/dyn/integrations_v1alpha.projects.locations.products.integrations.html b/docs/dyn/integrations_v1alpha.projects.locations.products.integrations.html index 15950f3b9cb..3324cce065d 100644 --- a/docs/dyn/integrations_v1alpha.projects.locations.products.integrations.html +++ b/docs/dyn/integrations_v1alpha.projects.locations.products.integrations.html @@ -79,19 +79,11 @@

Instance Methods

Returns the executions Resource.

-

- executionsnapshots() -

-

Returns the executionsnapshots Resource.

-

versions()

Returns the versions Resource.

-

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

-

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

close()

Close httplib2 connections.

@@ -108,30 +100,6 @@

Instance Methods

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

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

Method Details

-
- archiveBundle(name, body=None, x__xgafv=None) -
PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. Soft-deletes the bundle.
-
-Args:
-  name: string, Required. The bundle to archive. Format: projects/{project}/locations/{location}/integrations/{integration} (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Request for ArchiveBundle.
-}
-
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Response for ArchiveBundle.
-}
-
-
close()
Close httplib2 connections.
@@ -224,7 +192,7 @@

Method Details

}, }, ], - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. Passed in as parameters to each integration execution. Redacted + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Optional. Passed in as parameters to each integration execution. Redacted "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution. { # Key-value pair of EventBus parameters. "dataType": "A String", # Explicitly getting the type of the parameter. @@ -285,7 +253,7 @@

Method Details

An object of the form: { # The response for executing an integration. - "eventParameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Details for the integration that were executed. + "eventParameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Details for the integration that were executed. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution. { # Key-value pair of EventBus parameters. "dataType": "A String", # Explicitly getting the type of the parameter. @@ -517,7 +485,7 @@

Method Details

}, }, ], - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Passed in as parameters to each integration execution. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Passed in as parameters to each integration execution. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. diff --git a/docs/dyn/integrations_v1alpha.projects.locations.products.integrations.versions.html b/docs/dyn/integrations_v1alpha.projects.locations.products.integrations.versions.html index 3986378e890..17427720761 100644 --- a/docs/dyn/integrations_v1alpha.projects.locations.products.integrations.versions.html +++ b/docs/dyn/integrations_v1alpha.projects.locations.products.integrations.versions.html @@ -74,18 +74,12 @@

Application Integration API . projects . locations . products . integrations . versions

Instance Methods

-

- archive(name, body=None, x__xgafv=None)

-

Soft-deletes the integration. Changes the status of the integration to ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag is removed from this snapshot and set to the previous non-ARCHIVED snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. This RPC throws an exception if the version being archived is DRAFT, and if the `locked_by` user is not the same as the user performing the Archive. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Archiving a integration. Currently, there is no unarchive mechanism.

close()

Close httplib2 connections.

create(parent, body=None, newIntegration=None, x__xgafv=None)

Create a integration with a draft version in the specified project.

-

- deactivate(name, body=None, x__xgafv=None)

-

Sets the status of the ACTIVE integration to SNAPSHOT with a new tag "PREVIOUSLY_PUBLISHED" after validating it. The "HEAD" and "PUBLISH_REQUESTED" tags do not change. This RPC throws an exception if the version being snapshot is not ACTIVE. Audit fields added include action, action_by, action_timestamp.

delete(name, x__xgafv=None)

Soft-deletes the integration. Changes the status of the integration to ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag is removed from this snapshot and set to the previous non-ARCHIVED snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. This RPC throws an exception if the version being deleted is DRAFT, and if the `locked_by` user is not the same as the user performing the Delete. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Deleting a integration. Currently, there is no undelete mechanism.

@@ -95,9 +89,6 @@

Instance Methods

get(name, x__xgafv=None)

Get a integration in the specified project.

-

- getBundle(name, x__xgafv=None)

-

PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. RPC to get details of the Bundle

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

Returns the list of all integration versions in the specified project.

@@ -116,40 +107,10 @@

Instance Methods

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

Sets the status of the ACTIVE integration to SNAPSHOT with a new tag "PREVIOUSLY_PUBLISHED" after validating it. The "HEAD" and "PUBLISH_REQUESTED" tags do not change. This RPC throws an exception if the version being snapshot is not ACTIVE. Audit fields added include action, action_by, action_timestamp.

-

- updateBundle(name, body=None, x__xgafv=None)

-

THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. RPC to update the Bundle

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

Uploads an integration. The content can be a previously downloaded integration. Performs the same function as CreateDraftIntegrationVersion, but accepts input in a string format, which holds the complete representation of the IntegrationVersion content.

-

- validate(name, body=None, x__xgafv=None)

-

Validates the given integration. If the id doesn't exist, a NotFoundException is thrown. If validation fails a CanonicalCodeException is thrown. If there was no failure an empty response is returned.

Method Details

-
- archive(name, body=None, x__xgafv=None) -
Soft-deletes the integration. Changes the status of the integration to ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag is removed from this snapshot and set to the previous non-ARCHIVED snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. This RPC throws an exception if the version being archived is DRAFT, and if the `locked_by` user is not the same as the user performing the Archive. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Archiving a integration. Currently, there is no unarchive mechanism.
-
-Args:
-  name: string, Required. The version to archive. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version} (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Request for ArchiveIntegrationVersion.
-}
-
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Response for ArchiveIntegrationVersion.
-}
-
-
close()
Close httplib2 connections.
@@ -210,7 +171,7 @@

Method Details

"integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { - "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters. + "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...) "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults. "booleanValue": True or False, @@ -238,7 +199,7 @@

Method Details

}, "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered. "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. - "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details. + "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. @@ -310,7 +271,7 @@

Method Details

"stringValue": "A String", }, "inOutType": "A String", # Specifies the input/output type for the parameter. - "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters + "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 workflow definition. "name": "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". @@ -401,7 +362,7 @@

Method Details

"taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. - { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured. + { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in 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). "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert. "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow. @@ -418,7 +379,7 @@

Method Details

"onlyFinalAttempt": True or False, # Only count final task attempts, not retries. "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert. "thresholdType": "A String", # The threshold type 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. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. + "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", "percentage": 42, }, @@ -540,7 +501,7 @@

Method Details

"precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task. "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI. "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times). - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Optional. The customized parameters the user can pass to this task. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution. { # Key-value pair of EventBus parameters. "dataType": "A String", # Explicitly getting the type of the parameter. @@ -603,7 +564,7 @@

Method Details

}, "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of. "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc - "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on. + "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. # Metadata inclueds the task name, author and so on. "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name. "admins": [ { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar. @@ -624,7 +585,7 @@

Method Details

"externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc). "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html. "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available - "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons. + "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. "isDeprecated": True or False, # The deprecation status of the current task. Default value is false; "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class. "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html @@ -736,7 +697,7 @@

Method Details

"warningRate": 3.14, # Average warning rate. }, "taskType": "A String", # Defines the type of the task - "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask. + "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: # UI configuration for this task Also associated with the METADATA mask. "taskUiModuleConfigs": [ # Configurations of included config modules. { # Task author would use this type to configure a config module. "moduleId": "A String", # ID of the config module. @@ -760,7 +721,7 @@

Method Details

"nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching). "name": "A String", # Required. Name of the next teardown task. }, - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # The parameters the user can pass to this task. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. @@ -806,7 +767,7 @@

Method Details

}, ], }, - "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details. + "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. "properties": [ # An unordered list of property entries. { # Key-value pair of EventBus property. "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values. @@ -888,7 +849,7 @@

Method Details

"triggerConfigsInternal": [ # Optional. Trigger configurations. { # Configuration detail of a trigger. Next available id: 17 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] 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 + workflow] when published. - { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured. + { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours. "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert. "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow. @@ -905,7 +866,7 @@

Method Details

"onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries. "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert. "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. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples. + "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", "percentage": 42, }, @@ -982,7 +943,7 @@

Method Details

], "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true. "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly. - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Optional. To be used in TaskConfig for the implementation class. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. @@ -1094,7 +1055,7 @@

Method Details

"integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { - "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters. + "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...) "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults. "booleanValue": True or False, @@ -1122,7 +1083,7 @@

Method Details

}, "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered. "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. - "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details. + "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. @@ -1194,7 +1155,7 @@

Method Details

"stringValue": "A String", }, "inOutType": "A String", # Specifies the input/output type for the parameter. - "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters + "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 workflow definition. "name": "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". @@ -1285,7 +1246,7 @@

Method Details

"taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. - { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured. + { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in 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). "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert. "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow. @@ -1302,7 +1263,7 @@

Method Details

"onlyFinalAttempt": True or False, # Only count final task attempts, not retries. "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert. "thresholdType": "A String", # The threshold type 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. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. + "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", "percentage": 42, }, @@ -1424,7 +1385,7 @@

Method Details

"precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task. "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI. "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times). - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Optional. The customized parameters the user can pass to this task. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution. { # Key-value pair of EventBus parameters. "dataType": "A String", # Explicitly getting the type of the parameter. @@ -1487,7 +1448,7 @@

Method Details

}, "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of. "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc - "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on. + "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. # Metadata inclueds the task name, author and so on. "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name. "admins": [ { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar. @@ -1508,7 +1469,7 @@

Method Details

"externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc). "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html. "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available - "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons. + "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. "isDeprecated": True or False, # The deprecation status of the current task. Default value is false; "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class. "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html @@ -1620,7 +1581,7 @@

Method Details

"warningRate": 3.14, # Average warning rate. }, "taskType": "A String", # Defines the type of the task - "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask. + "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: # UI configuration for this task Also associated with the METADATA mask. "taskUiModuleConfigs": [ # Configurations of included config modules. { # Task author would use this type to configure a config module. "moduleId": "A String", # ID of the config module. @@ -1644,7 +1605,7 @@

Method Details

"nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching). "name": "A String", # Required. Name of the next teardown task. }, - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # The parameters the user can pass to this task. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. @@ -1690,7 +1651,7 @@

Method Details

}, ], }, - "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details. + "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. "properties": [ # An unordered list of property entries. { # Key-value pair of EventBus property. "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values. @@ -1772,7 +1733,7 @@

Method Details

"triggerConfigsInternal": [ # Optional. Trigger configurations. { # Configuration detail of a trigger. Next available id: 17 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] 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 + workflow] when published. - { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured. + { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours. "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert. "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow. @@ -1789,7 +1750,7 @@

Method Details

"onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries. "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert. "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. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples. + "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", "percentage": 42, }, @@ -1866,7 +1827,7 @@

Method Details

], "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true. "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly. - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Optional. To be used in TaskConfig for the implementation class. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. @@ -1924,30 +1885,6 @@

Method Details

}
-
- deactivate(name, body=None, x__xgafv=None) -
Sets the status of the ACTIVE integration to SNAPSHOT with a new tag "PREVIOUSLY_PUBLISHED" after validating it. The "HEAD" and "PUBLISH_REQUESTED" tags do not change. This RPC throws an exception if the version being snapshot is not ACTIVE. Audit fields added include action, action_by, action_timestamp.
-
-Args:
-  name: string, Required. The version to deactivate. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version} (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Request for DeactivateIntegrationVersion.
-}
-
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Response for DeactivateIntegrationVersion.
-}
-
-
delete(name, x__xgafv=None)
Soft-deletes the integration. Changes the status of the integration to ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag is removed from this snapshot and set to the previous non-ARCHIVED snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. This RPC throws an exception if the version being deleted is DRAFT, and if the `locked_by` user is not the same as the user performing the Delete. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Deleting a integration. Currently, there is no undelete mechanism.
@@ -2050,7 +1987,7 @@ 

Method Details

"integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { - "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters. + "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...) "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults. "booleanValue": True or False, @@ -2078,7 +2015,7 @@

Method Details

}, "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered. "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. - "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details. + "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. @@ -2150,7 +2087,7 @@

Method Details

"stringValue": "A String", }, "inOutType": "A String", # Specifies the input/output type for the parameter. - "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters + "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 workflow definition. "name": "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". @@ -2241,7 +2178,7 @@

Method Details

"taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. - { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured. + { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in 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). "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert. "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow. @@ -2258,7 +2195,7 @@

Method Details

"onlyFinalAttempt": True or False, # Only count final task attempts, not retries. "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert. "thresholdType": "A String", # The threshold type 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. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. + "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", "percentage": 42, }, @@ -2380,7 +2317,7 @@

Method Details

"precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task. "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI. "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times). - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Optional. The customized parameters the user can pass to this task. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution. { # Key-value pair of EventBus parameters. "dataType": "A String", # Explicitly getting the type of the parameter. @@ -2443,7 +2380,7 @@

Method Details

}, "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of. "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc - "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on. + "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. # Metadata inclueds the task name, author and so on. "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name. "admins": [ { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar. @@ -2464,7 +2401,7 @@

Method Details

"externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc). "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html. "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available - "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons. + "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. "isDeprecated": True or False, # The deprecation status of the current task. Default value is false; "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class. "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html @@ -2576,7 +2513,7 @@

Method Details

"warningRate": 3.14, # Average warning rate. }, "taskType": "A String", # Defines the type of the task - "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask. + "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: # UI configuration for this task Also associated with the METADATA mask. "taskUiModuleConfigs": [ # Configurations of included config modules. { # Task author would use this type to configure a config module. "moduleId": "A String", # ID of the config module. @@ -2600,7 +2537,7 @@

Method Details

"nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching). "name": "A String", # Required. Name of the next teardown task. }, - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # The parameters the user can pass to this task. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. @@ -2646,7 +2583,7 @@

Method Details

}, ], }, - "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details. + "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. "properties": [ # An unordered list of property entries. { # Key-value pair of EventBus property. "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values. @@ -2728,7 +2665,7 @@

Method Details

"triggerConfigsInternal": [ # Optional. Trigger configurations. { # Configuration detail of a trigger. Next available id: 17 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] 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 + workflow] when published. - { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured. + { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours. "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert. "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow. @@ -2745,7 +2682,7 @@

Method Details

"onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries. "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert. "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. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples. + "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", "percentage": 42, }, @@ -2822,7 +2759,7 @@

Method Details

], "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true. "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly. - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Optional. To be used in TaskConfig for the implementation class. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. @@ -2880,30 +2817,6 @@

Method Details

}
-
- getBundle(name, x__xgafv=None) -
PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. RPC to get details of the Bundle
-
-Args:
-  name: string, Required. The bundle name. (required)
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Response for GetBundle.
-  "config": { # This proto holds the core runner data in the bundle task. It is not expected to be directly edited by the user. Instead, a default value will be provided at the task creation time. # It contains the bundle data
-    "integrations": [ # A bundle of integrations that can be executed by the task at runtime.
-      "A String",
-    ],
-    "serviceAccount": "A String", # Output only. The service account created and owned by IP and added to the customers GCP project.
-  },
-}
-
-
list(parent, fieldMask=None, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Returns the list of all integration versions in the specified project.
@@ -2971,7 +2884,7 @@ 

Method Details

"integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { - "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters. + "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...) "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults. "booleanValue": True or False, @@ -2999,7 +2912,7 @@

Method Details

}, "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered. "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. - "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details. + "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. @@ -3071,7 +2984,7 @@

Method Details

"stringValue": "A String", }, "inOutType": "A String", # Specifies the input/output type for the parameter. - "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters + "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 workflow definition. "name": "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". @@ -3162,7 +3075,7 @@

Method Details

"taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. - { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured. + { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in 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). "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert. "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow. @@ -3179,7 +3092,7 @@

Method Details

"onlyFinalAttempt": True or False, # Only count final task attempts, not retries. "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert. "thresholdType": "A String", # The threshold type 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. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. + "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", "percentage": 42, }, @@ -3301,7 +3214,7 @@

Method Details

"precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task. "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI. "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times). - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Optional. The customized parameters the user can pass to this task. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution. { # Key-value pair of EventBus parameters. "dataType": "A String", # Explicitly getting the type of the parameter. @@ -3364,7 +3277,7 @@

Method Details

}, "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of. "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc - "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on. + "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. # Metadata inclueds the task name, author and so on. "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name. "admins": [ { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar. @@ -3385,7 +3298,7 @@

Method Details

"externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc). "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html. "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available - "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons. + "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. "isDeprecated": True or False, # The deprecation status of the current task. Default value is false; "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class. "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html @@ -3497,7 +3410,7 @@

Method Details

"warningRate": 3.14, # Average warning rate. }, "taskType": "A String", # Defines the type of the task - "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask. + "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: # UI configuration for this task Also associated with the METADATA mask. "taskUiModuleConfigs": [ # Configurations of included config modules. { # Task author would use this type to configure a config module. "moduleId": "A String", # ID of the config module. @@ -3521,7 +3434,7 @@

Method Details

"nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching). "name": "A String", # Required. Name of the next teardown task. }, - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # The parameters the user can pass to this task. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. @@ -3567,7 +3480,7 @@

Method Details

}, ], }, - "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details. + "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. "properties": [ # An unordered list of property entries. { # Key-value pair of EventBus property. "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values. @@ -3649,7 +3562,7 @@

Method Details

"triggerConfigsInternal": [ # Optional. Trigger configurations. { # Configuration detail of a trigger. Next available id: 17 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] 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 + workflow] when published. - { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured. + { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours. "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert. "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow. @@ -3666,7 +3579,7 @@

Method Details

"onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries. "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert. "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. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples. + "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", "percentage": 42, }, @@ -3743,7 +3656,7 @@

Method Details

], "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true. "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly. - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Optional. To be used in TaskConfig for the implementation class. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. @@ -3874,7 +3787,7 @@

Method Details

"integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { - "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters. + "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...) "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults. "booleanValue": True or False, @@ -3902,7 +3815,7 @@

Method Details

}, "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered. "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. - "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details. + "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. @@ -3974,7 +3887,7 @@

Method Details

"stringValue": "A String", }, "inOutType": "A String", # Specifies the input/output type for the parameter. - "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters + "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 workflow definition. "name": "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". @@ -4065,7 +3978,7 @@

Method Details

"taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. - { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured. + { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in 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). "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert. "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow. @@ -4082,7 +3995,7 @@

Method Details

"onlyFinalAttempt": True or False, # Only count final task attempts, not retries. "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert. "thresholdType": "A String", # The threshold type 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. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. + "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", "percentage": 42, }, @@ -4204,7 +4117,7 @@

Method Details

"precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task. "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI. "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times). - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Optional. The customized parameters the user can pass to this task. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution. { # Key-value pair of EventBus parameters. "dataType": "A String", # Explicitly getting the type of the parameter. @@ -4267,7 +4180,7 @@

Method Details

}, "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of. "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc - "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on. + "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. # Metadata inclueds the task name, author and so on. "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name. "admins": [ { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar. @@ -4288,7 +4201,7 @@

Method Details

"externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc). "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html. "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available - "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons. + "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. "isDeprecated": True or False, # The deprecation status of the current task. Default value is false; "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class. "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html @@ -4400,7 +4313,7 @@

Method Details

"warningRate": 3.14, # Average warning rate. }, "taskType": "A String", # Defines the type of the task - "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask. + "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: # UI configuration for this task Also associated with the METADATA mask. "taskUiModuleConfigs": [ # Configurations of included config modules. { # Task author would use this type to configure a config module. "moduleId": "A String", # ID of the config module. @@ -4424,7 +4337,7 @@

Method Details

"nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching). "name": "A String", # Required. Name of the next teardown task. }, - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # The parameters the user can pass to this task. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. @@ -4470,7 +4383,7 @@

Method Details

}, ], }, - "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details. + "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. "properties": [ # An unordered list of property entries. { # Key-value pair of EventBus property. "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values. @@ -4552,7 +4465,7 @@

Method Details

"triggerConfigsInternal": [ # Optional. Trigger configurations. { # Configuration detail of a trigger. Next available id: 17 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] 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 + workflow] when published. - { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured. + { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours. "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert. "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow. @@ -4569,7 +4482,7 @@

Method Details

"onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries. "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert. "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. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples. + "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", "percentage": 42, }, @@ -4646,7 +4559,7 @@

Method Details

], "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true. "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly. - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Optional. To be used in TaskConfig for the implementation class. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. @@ -4758,7 +4671,7 @@

Method Details

"integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { - "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters. + "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...) "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults. "booleanValue": True or False, @@ -4786,7 +4699,7 @@

Method Details

}, "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered. "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. - "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details. + "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. @@ -4858,7 +4771,7 @@

Method Details

"stringValue": "A String", }, "inOutType": "A String", # Specifies the input/output type for the parameter. - "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters + "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 workflow definition. "name": "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". @@ -4949,7 +4862,7 @@

Method Details

"taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. - { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured. + { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in 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). "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert. "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow. @@ -4966,7 +4879,7 @@

Method Details

"onlyFinalAttempt": True or False, # Only count final task attempts, not retries. "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert. "thresholdType": "A String", # The threshold type 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. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. + "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", "percentage": 42, }, @@ -5088,7 +5001,7 @@

Method Details

"precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task. "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI. "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times). - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Optional. The customized parameters the user can pass to this task. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution. { # Key-value pair of EventBus parameters. "dataType": "A String", # Explicitly getting the type of the parameter. @@ -5151,7 +5064,7 @@

Method Details

}, "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of. "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc - "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on. + "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. # Metadata inclueds the task name, author and so on. "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name. "admins": [ { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar. @@ -5172,7 +5085,7 @@

Method Details

"externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc). "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html. "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available - "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons. + "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. "isDeprecated": True or False, # The deprecation status of the current task. Default value is false; "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class. "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html @@ -5284,7 +5197,7 @@

Method Details

"warningRate": 3.14, # Average warning rate. }, "taskType": "A String", # Defines the type of the task - "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask. + "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: # UI configuration for this task Also associated with the METADATA mask. "taskUiModuleConfigs": [ # Configurations of included config modules. { # Task author would use this type to configure a config module. "moduleId": "A String", # ID of the config module. @@ -5308,7 +5221,7 @@

Method Details

"nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching). "name": "A String", # Required. Name of the next teardown task. }, - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # The parameters the user can pass to this task. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. @@ -5354,7 +5267,7 @@

Method Details

}, ], }, - "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details. + "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. "properties": [ # An unordered list of property entries. { # Key-value pair of EventBus property. "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values. @@ -5436,7 +5349,7 @@

Method Details

"triggerConfigsInternal": [ # Optional. Trigger configurations. { # Configuration detail of a trigger. Next available id: 17 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] 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 + workflow] when published. - { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured. + { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours. "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert. "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow. @@ -5453,7 +5366,7 @@

Method Details

"onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries. "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert. "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. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples. + "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", "percentage": 42, }, @@ -5530,7 +5443,7 @@

Method Details

], "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true. "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly. - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Optional. To be used in TaskConfig for the implementation class. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. @@ -5679,7 +5592,7 @@

Method Details

"integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { - "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters. + "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...) "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults. "booleanValue": True or False, @@ -5707,7 +5620,7 @@

Method Details

}, "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered. "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. - "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details. + "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. @@ -5779,7 +5692,7 @@

Method Details

"stringValue": "A String", }, "inOutType": "A String", # Specifies the input/output type for the parameter. - "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters + "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 workflow definition. "name": "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". @@ -5870,7 +5783,7 @@

Method Details

"taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. - { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured. + { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in 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). "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert. "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow. @@ -5887,7 +5800,7 @@

Method Details

"onlyFinalAttempt": True or False, # Only count final task attempts, not retries. "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert. "thresholdType": "A String", # The threshold type 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. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. + "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", "percentage": 42, }, @@ -6009,7 +5922,7 @@

Method Details

"precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task. "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI. "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times). - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Optional. The customized parameters the user can pass to this task. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution. { # Key-value pair of EventBus parameters. "dataType": "A String", # Explicitly getting the type of the parameter. @@ -6072,7 +5985,7 @@

Method Details

}, "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of. "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc - "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on. + "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. # Metadata inclueds the task name, author and so on. "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name. "admins": [ { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar. @@ -6093,7 +6006,7 @@

Method Details

"externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc). "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html. "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available - "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons. + "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. "isDeprecated": True or False, # The deprecation status of the current task. Default value is false; "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class. "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html @@ -6205,7 +6118,7 @@

Method Details

"warningRate": 3.14, # Average warning rate. }, "taskType": "A String", # Defines the type of the task - "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask. + "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: # UI configuration for this task Also associated with the METADATA mask. "taskUiModuleConfigs": [ # Configurations of included config modules. { # Task author would use this type to configure a config module. "moduleId": "A String", # ID of the config module. @@ -6229,7 +6142,7 @@

Method Details

"nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching). "name": "A String", # Required. Name of the next teardown task. }, - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # The parameters the user can pass to this task. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. @@ -6275,7 +6188,7 @@

Method Details

}, ], }, - "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details. + "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. "properties": [ # An unordered list of property entries. { # Key-value pair of EventBus property. "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values. @@ -6357,7 +6270,7 @@

Method Details

"triggerConfigsInternal": [ # Optional. Trigger configurations. { # Configuration detail of a trigger. Next available id: 17 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] 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 + workflow] when published. - { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured. + { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours. "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert. "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow. @@ -6374,7 +6287,7 @@

Method Details

"onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries. "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert. "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. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples. + "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", "percentage": 42, }, @@ -6451,7 +6364,7 @@

Method Details

], "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true. "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly. - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Optional. To be used in TaskConfig for the implementation class. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. @@ -6534,42 +6447,6 @@

Method Details

}
-
- updateBundle(name, body=None, x__xgafv=None) -
THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. RPC to update the Bundle
-
-Args:
-  name: string, Required. Bundle name (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. Request message for Bundle update
-  "config": { # This proto holds the core runner data in the bundle task. It is not expected to be directly edited by the user. Instead, a default value will be provided at the task creation time. # It contains the updated bundle data
-    "integrations": [ # A bundle of integrations that can be executed by the task at runtime.
-      "A String",
-    ],
-    "serviceAccount": "A String", # Output only. The service account created and owned by IP and added to the customers GCP project.
-  },
-}
-
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Response message for Bundle update
-  "config": { # This proto holds the core runner data in the bundle task. It is not expected to be directly edited by the user. Instead, a default value will be provided at the task creation time. # Contains updated bundle config
-    "integrations": [ # A bundle of integrations that can be executed by the task at runtime.
-      "A String",
-    ],
-    "serviceAccount": "A String", # Output only. The service account created and owned by IP and added to the customers GCP project.
-  },
-}
-
-
upload(parent, body=None, x__xgafv=None)
Uploads an integration. The content can be a previously downloaded integration. Performs the same function as CreateDraftIntegrationVersion, but accepts input in a string format, which holds the complete representation of the IntegrationVersion content.
@@ -6639,7 +6516,7 @@ 

Method Details

"integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { - "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters. + "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...) "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults. "booleanValue": True or False, @@ -6667,7 +6544,7 @@

Method Details

}, "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered. "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. - "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details. + "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. @@ -6739,7 +6616,7 @@

Method Details

"stringValue": "A String", }, "inOutType": "A String", # Specifies the input/output type for the parameter. - "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters + "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 workflow definition. "name": "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". @@ -6830,7 +6707,7 @@

Method Details

"taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. - { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured. + { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in 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). "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert. "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow. @@ -6847,7 +6724,7 @@

Method Details

"onlyFinalAttempt": True or False, # Only count final task attempts, not retries. "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert. "thresholdType": "A String", # The threshold type 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. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. + "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", "percentage": 42, }, @@ -6969,7 +6846,7 @@

Method Details

"precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task. "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI. "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times). - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Optional. The customized parameters the user can pass to this task. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution. { # Key-value pair of EventBus parameters. "dataType": "A String", # Explicitly getting the type of the parameter. @@ -7032,7 +6909,7 @@

Method Details

}, "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of. "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc - "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on. + "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. # Metadata inclueds the task name, author and so on. "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name. "admins": [ { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar. @@ -7053,7 +6930,7 @@

Method Details

"externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc). "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html. "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available - "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons. + "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. "isDeprecated": True or False, # The deprecation status of the current task. Default value is false; "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class. "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html @@ -7165,7 +7042,7 @@

Method Details

"warningRate": 3.14, # Average warning rate. }, "taskType": "A String", # Defines the type of the task - "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask. + "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: # UI configuration for this task Also associated with the METADATA mask. "taskUiModuleConfigs": [ # Configurations of included config modules. { # Task author would use this type to configure a config module. "moduleId": "A String", # ID of the config module. @@ -7189,7 +7066,7 @@

Method Details

"nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching). "name": "A String", # Required. Name of the next teardown task. }, - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # The parameters the user can pass to this task. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. @@ -7235,7 +7112,7 @@

Method Details

}, ], }, - "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details. + "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. "properties": [ # An unordered list of property entries. { # Key-value pair of EventBus property. "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values. @@ -7317,7 +7194,7 @@

Method Details

"triggerConfigsInternal": [ # Optional. Trigger configurations. { # Configuration detail of a trigger. Next available id: 17 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] 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 + workflow] when published. - { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured. + { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours. "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert. "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow. @@ -7334,7 +7211,7 @@

Method Details

"onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries. "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert. "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. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples. + "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", "percentage": 42, }, @@ -7411,7 +7288,7 @@

Method Details

], "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true. "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly. - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Optional. To be used in TaskConfig for the implementation class. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. @@ -7470,28 +7347,4 @@

Method Details

}
-
- validate(name, body=None, x__xgafv=None) -
Validates the given integration. If the id doesn't exist, a NotFoundException is thrown. If validation fails a CanonicalCodeException is thrown. If there was no failure an empty response is returned.
-
-Args:
-  name: string, Required. The version to validate. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version} (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Request for ValidateIntegrationVersion.
-}
-
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Response for ValidateIntegrationVersion.
-}
-
- \ No newline at end of file diff --git a/docs/dyn/integrations_v1alpha.projects.locations.products.integrationtemplates.versions.html b/docs/dyn/integrations_v1alpha.projects.locations.products.integrationtemplates.versions.html index 089ce5d7a41..bb70c88fd13 100644 --- a/docs/dyn/integrations_v1alpha.projects.locations.products.integrationtemplates.versions.html +++ b/docs/dyn/integrations_v1alpha.projects.locations.products.integrationtemplates.versions.html @@ -116,7 +116,7 @@

Method Details

"taskConfigs": [ # Optional. Task configuration for the IntegrationTemplateVersion. It's optional, but the IntegrationTemplateVersion doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. - { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured. + { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in 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). "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert. "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow. @@ -133,7 +133,7 @@

Method Details

"onlyFinalAttempt": True or False, # Only count final task attempts, not retries. "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert. "thresholdType": "A String", # The threshold type 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. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. + "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", "percentage": 42, }, @@ -255,7 +255,7 @@

Method Details

"precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task. "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI. "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times). - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Optional. The customized parameters the user can pass to this task. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution. { # Key-value pair of EventBus parameters. "dataType": "A String", # Explicitly getting the type of the parameter. @@ -318,7 +318,7 @@

Method Details

}, "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of. "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc - "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on. + "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. # Metadata inclueds the task name, author and so on. "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name. "admins": [ { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar. @@ -339,7 +339,7 @@

Method Details

"externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc). "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html. "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available - "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons. + "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. "isDeprecated": True or False, # The deprecation status of the current task. Default value is false; "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class. "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html @@ -451,7 +451,7 @@

Method Details

"warningRate": 3.14, # Average warning rate. }, "taskType": "A String", # Defines the type of the task - "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask. + "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: # UI configuration for this task Also associated with the METADATA mask. "taskUiModuleConfigs": [ # Configurations of included config modules. { # Task author would use this type to configure a config module. "moduleId": "A String", # ID of the config module. @@ -475,7 +475,7 @@

Method Details

"nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching). "name": "A String", # Required. Name of the next teardown task. }, - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # The parameters the user can pass to this task. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. @@ -521,7 +521,7 @@

Method Details

}, ], }, - "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details. + "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. "properties": [ # An unordered list of property entries. { # Key-value pair of EventBus property. "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values. @@ -559,7 +559,7 @@

Method Details

"templateParameters": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the IntegrationTemplateVersion when an event is triggered. This consists of all the parameters that are expected in the IntegrationTemplateVersion execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { - "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters. + "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...) "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults. "booleanValue": True or False, @@ -587,7 +587,7 @@

Method Details

}, "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered. "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. - "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details. + "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. @@ -659,7 +659,7 @@

Method Details

"stringValue": "A String", }, "inOutType": "A String", # Specifies the input/output type for the parameter. - "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters + "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 workflow definition. "name": "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". @@ -676,7 +676,7 @@

Method Details

"triggerConfigs": [ # Optional. Trigger configurations. { # Configuration detail of a trigger. Next available id: 17 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] 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 + workflow] when published. - { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured. + { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours. "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert. "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow. @@ -693,7 +693,7 @@

Method Details

"onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries. "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert. "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. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples. + "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", "percentage": 42, }, @@ -770,7 +770,7 @@

Method Details

], "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true. "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly. - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Optional. To be used in TaskConfig for the implementation class. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. @@ -847,7 +847,7 @@

Method Details

"taskConfigs": [ # Optional. Task configuration for the IntegrationTemplateVersion. It's optional, but the IntegrationTemplateVersion doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. - { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured. + { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in 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). "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert. "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow. @@ -864,7 +864,7 @@

Method Details

"onlyFinalAttempt": True or False, # Only count final task attempts, not retries. "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert. "thresholdType": "A String", # The threshold type 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. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. + "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", "percentage": 42, }, @@ -986,7 +986,7 @@

Method Details

"precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task. "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI. "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times). - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Optional. The customized parameters the user can pass to this task. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution. { # Key-value pair of EventBus parameters. "dataType": "A String", # Explicitly getting the type of the parameter. @@ -1049,7 +1049,7 @@

Method Details

}, "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of. "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc - "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on. + "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. # Metadata inclueds the task name, author and so on. "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name. "admins": [ { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar. @@ -1070,7 +1070,7 @@

Method Details

"externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc). "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html. "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available - "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons. + "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. "isDeprecated": True or False, # The deprecation status of the current task. Default value is false; "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class. "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html @@ -1182,7 +1182,7 @@

Method Details

"warningRate": 3.14, # Average warning rate. }, "taskType": "A String", # Defines the type of the task - "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask. + "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: # UI configuration for this task Also associated with the METADATA mask. "taskUiModuleConfigs": [ # Configurations of included config modules. { # Task author would use this type to configure a config module. "moduleId": "A String", # ID of the config module. @@ -1206,7 +1206,7 @@

Method Details

"nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching). "name": "A String", # Required. Name of the next teardown task. }, - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # The parameters the user can pass to this task. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. @@ -1252,7 +1252,7 @@

Method Details

}, ], }, - "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details. + "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. "properties": [ # An unordered list of property entries. { # Key-value pair of EventBus property. "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values. @@ -1290,7 +1290,7 @@

Method Details

"templateParameters": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the IntegrationTemplateVersion when an event is triggered. This consists of all the parameters that are expected in the IntegrationTemplateVersion execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { - "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters. + "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...) "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults. "booleanValue": True or False, @@ -1318,7 +1318,7 @@

Method Details

}, "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered. "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. - "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details. + "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. @@ -1390,7 +1390,7 @@

Method Details

"stringValue": "A String", }, "inOutType": "A String", # Specifies the input/output type for the parameter. - "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters + "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 workflow definition. "name": "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". @@ -1407,7 +1407,7 @@

Method Details

"triggerConfigs": [ # Optional. Trigger configurations. { # Configuration detail of a trigger. Next available id: 17 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] 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 + workflow] when published. - { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured. + { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours. "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert. "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow. @@ -1424,7 +1424,7 @@

Method Details

"onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries. "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert. "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. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples. + "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", "percentage": 42, }, @@ -1501,7 +1501,7 @@

Method Details

], "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true. "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly. - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Optional. To be used in TaskConfig for the implementation class. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. @@ -1585,7 +1585,7 @@

Method Details

"taskConfigs": [ # Optional. Task configuration for the IntegrationTemplateVersion. It's optional, but the IntegrationTemplateVersion doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. - { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured. + { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in 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). "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert. "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow. @@ -1602,7 +1602,7 @@

Method Details

"onlyFinalAttempt": True or False, # Only count final task attempts, not retries. "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert. "thresholdType": "A String", # The threshold type 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. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. + "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", "percentage": 42, }, @@ -1724,7 +1724,7 @@

Method Details

"precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task. "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI. "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times). - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Optional. The customized parameters the user can pass to this task. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution. { # Key-value pair of EventBus parameters. "dataType": "A String", # Explicitly getting the type of the parameter. @@ -1787,7 +1787,7 @@

Method Details

}, "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of. "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc - "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on. + "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. # Metadata inclueds the task name, author and so on. "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name. "admins": [ { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar. @@ -1808,7 +1808,7 @@

Method Details

"externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc). "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html. "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available - "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons. + "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. "isDeprecated": True or False, # The deprecation status of the current task. Default value is false; "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class. "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html @@ -1920,7 +1920,7 @@

Method Details

"warningRate": 3.14, # Average warning rate. }, "taskType": "A String", # Defines the type of the task - "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask. + "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: # UI configuration for this task Also associated with the METADATA mask. "taskUiModuleConfigs": [ # Configurations of included config modules. { # Task author would use this type to configure a config module. "moduleId": "A String", # ID of the config module. @@ -1944,7 +1944,7 @@

Method Details

"nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching). "name": "A String", # Required. Name of the next teardown task. }, - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # The parameters the user can pass to this task. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. @@ -1990,7 +1990,7 @@

Method Details

}, ], }, - "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details. + "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. "properties": [ # An unordered list of property entries. { # Key-value pair of EventBus property. "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values. @@ -2028,7 +2028,7 @@

Method Details

"templateParameters": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the IntegrationTemplateVersion when an event is triggered. This consists of all the parameters that are expected in the IntegrationTemplateVersion execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { - "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters. + "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...) "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults. "booleanValue": True or False, @@ -2056,7 +2056,7 @@

Method Details

}, "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered. "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. - "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details. + "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. @@ -2128,7 +2128,7 @@

Method Details

"stringValue": "A String", }, "inOutType": "A String", # Specifies the input/output type for the parameter. - "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters + "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 workflow definition. "name": "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". @@ -2145,7 +2145,7 @@

Method Details

"triggerConfigs": [ # Optional. Trigger configurations. { # Configuration detail of a trigger. Next available id: 17 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] 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 + workflow] when published. - { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured. + { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours. "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert. "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow. @@ -2162,7 +2162,7 @@

Method Details

"onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries. "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert. "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. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples. + "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", "percentage": 42, }, @@ -2239,7 +2239,7 @@

Method Details

], "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true. "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly. - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Optional. To be used in TaskConfig for the implementation class. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. @@ -2328,7 +2328,7 @@

Method Details

"taskConfigs": [ # Optional. Task configuration for the IntegrationTemplateVersion. It's optional, but the IntegrationTemplateVersion doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. - { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured. + { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in 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). "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert. "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow. @@ -2345,7 +2345,7 @@

Method Details

"onlyFinalAttempt": True or False, # Only count final task attempts, not retries. "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert. "thresholdType": "A String", # The threshold type 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. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. + "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", "percentage": 42, }, @@ -2467,7 +2467,7 @@

Method Details

"precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task. "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI. "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times). - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Optional. The customized parameters the user can pass to this task. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution. { # Key-value pair of EventBus parameters. "dataType": "A String", # Explicitly getting the type of the parameter. @@ -2530,7 +2530,7 @@

Method Details

}, "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of. "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc - "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on. + "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. # Metadata inclueds the task name, author and so on. "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name. "admins": [ { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar. @@ -2551,7 +2551,7 @@

Method Details

"externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc). "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html. "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available - "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons. + "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. "isDeprecated": True or False, # The deprecation status of the current task. Default value is false; "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class. "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html @@ -2663,7 +2663,7 @@

Method Details

"warningRate": 3.14, # Average warning rate. }, "taskType": "A String", # Defines the type of the task - "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask. + "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: # UI configuration for this task Also associated with the METADATA mask. "taskUiModuleConfigs": [ # Configurations of included config modules. { # Task author would use this type to configure a config module. "moduleId": "A String", # ID of the config module. @@ -2687,7 +2687,7 @@

Method Details

"nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching). "name": "A String", # Required. Name of the next teardown task. }, - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # The parameters the user can pass to this task. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. @@ -2733,7 +2733,7 @@

Method Details

}, ], }, - "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details. + "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. "properties": [ # An unordered list of property entries. { # Key-value pair of EventBus property. "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values. @@ -2771,7 +2771,7 @@

Method Details

"templateParameters": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the IntegrationTemplateVersion when an event is triggered. This consists of all the parameters that are expected in the IntegrationTemplateVersion execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { - "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters. + "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...) "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults. "booleanValue": True or False, @@ -2799,7 +2799,7 @@

Method Details

}, "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered. "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. - "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details. + "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. @@ -2871,7 +2871,7 @@

Method Details

"stringValue": "A String", }, "inOutType": "A String", # Specifies the input/output type for the parameter. - "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters + "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 workflow definition. "name": "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". @@ -2888,7 +2888,7 @@

Method Details

"triggerConfigs": [ # Optional. Trigger configurations. { # Configuration detail of a trigger. Next available id: 17 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] 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 + workflow] when published. - { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured. + { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours. "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert. "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow. @@ -2905,7 +2905,7 @@

Method Details

"onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries. "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert. "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. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples. + "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", "percentage": 42, }, @@ -2982,7 +2982,7 @@

Method Details

], "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true. "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly. - "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class. + "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Optional. To be used in TaskConfig for the implementation class. "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. { # Key-value pair of EventBus parameters. "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. diff --git a/googleapiclient/discovery_cache/documents/integrations.v1alpha.json b/googleapiclient/discovery_cache/documents/integrations.v1alpha.json index bf9504e5399..6e3dbbc3ef2 100644 --- a/googleapiclient/discovery_cache/documents/integrations.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/integrations.v1alpha.json @@ -184,33 +184,6 @@ "projects": { "resources": { "locations": { - "methods": { - "listTaskEntities": { - "description": "This is a UI only method and will be moved away. Returns a list of common tasks.", - "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}:listTaskEntities", - "httpMethod": "GET", - "id": "integrations.projects.locations.listTaskEntities", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The location resource of the request. This is not going to be used but preserve the field for future.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+parent}:listTaskEntities", - "response": { - "$ref": "GoogleCloudIntegrationsV1alphaListTaskEntitiesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, "resources": { "appsScriptProjects": { "methods": { @@ -1032,34 +1005,6 @@ }, "versions": { "methods": { - "archive": { - "description": "Soft-deletes the integration. Changes the status of the integration to ARCHIVED. If the integration being ARCHIVED is tagged as \"HEAD\", the tag is removed from this snapshot and set to the previous non-ARCHIVED snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. This RPC throws an exception if the version being archived is DRAFT, and if the `locked_by` user is not the same as the user performing the Archive. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Archiving a integration. Currently, there is no unarchive mechanism.", - "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:archive", - "httpMethod": "POST", - "id": "integrations.projects.locations.integrations.versions.archive", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The version to archive. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+name}:archive", - "request": { - "$ref": "GoogleCloudIntegrationsV1alphaArchiveIntegrationVersionRequest" - }, - "response": { - "$ref": "GoogleCloudIntegrationsV1alphaArchiveIntegrationVersionResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "create": { "description": "Create a integration with a draft version in the specified project.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions", @@ -1093,34 +1038,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "deactivate": { - "description": "Sets the status of the ACTIVE integration to SNAPSHOT with a new tag \"PREVIOUSLY_PUBLISHED\" after validating it. The \"HEAD\" and \"PUBLISH_REQUESTED\" tags do not change. This RPC throws an exception if the version being snapshot is not ACTIVE. Audit fields added include action, action_by, action_timestamp.", - "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:deactivate", - "httpMethod": "POST", - "id": "integrations.projects.locations.integrations.versions.deactivate", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The version to deactivate. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+name}:deactivate", - "request": { - "$ref": "GoogleCloudIntegrationsV1alphaDeactivateIntegrationVersionRequest" - }, - "response": { - "$ref": "GoogleCloudIntegrationsV1alphaDeactivateIntegrationVersionResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "delete": { "description": "Soft-deletes the integration. Changes the status of the integration to ARCHIVED. If the integration being ARCHIVED is tagged as \"HEAD\", the tag is removed from this snapshot and set to the previous non-ARCHIVED snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. This RPC throws an exception if the version being deleted is DRAFT, and if the `locked_by` user is not the same as the user performing the Delete. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Deleting a integration. Currently, there is no undelete mechanism.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}", @@ -1408,95 +1325,12 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - }, - "validate": { - "description": "Validates the given integration. If the id doesn't exist, a NotFoundException is thrown. If validation fails a CanonicalCodeException is thrown. If there was no failure an empty response is returned.", - "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:validate", - "httpMethod": "POST", - "id": "integrations.projects.locations.integrations.versions.validate", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The version to validate. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+name}:validate", - "request": { - "$ref": "GoogleCloudIntegrationsV1alphaValidateIntegrationVersionRequest" - }, - "response": { - "$ref": "GoogleCloudIntegrationsV1alphaValidateIntegrationVersionResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] } } } } }, "products": { - "methods": { - "createBundle": { - "description": "PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. Create a bundle.", - "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}:createBundle", - "httpMethod": "POST", - "id": "integrations.projects.locations.products.createBundle", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The location resource of the request.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+parent}:createBundle", - "request": { - "$ref": "GoogleCloudIntegrationsV1alphaCreateBundleRequest" - }, - "response": { - "$ref": "GoogleCloudIntegrationsV1alphaCreateBundleResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "listTaskEntities": { - "description": "This is a UI only method and will be moved away. Returns a list of common tasks.", - "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}:listTaskEntities", - "httpMethod": "GET", - "id": "integrations.projects.locations.products.listTaskEntities", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The location resource of the request. This is not going to be used but preserve the field for future.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+parent}:listTaskEntities", - "response": { - "$ref": "GoogleCloudIntegrationsV1alphaListTaskEntitiesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, "resources": { "authConfigs": { "methods": { @@ -1856,34 +1690,6 @@ }, "integrations": { "methods": { - "archiveBundle": { - "description": "PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. Soft-deletes the bundle.", - "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:archiveBundle", - "httpMethod": "POST", - "id": "integrations.projects.locations.products.integrations.archiveBundle", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The bundle to archive. Format: projects/{project}/locations/{location}/integrations/{integration}", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+name}:archiveBundle", - "request": { - "$ref": "GoogleCloudIntegrationsV1alphaArchiveBundleRequest" - }, - "response": { - "$ref": "GoogleCloudIntegrationsV1alphaArchiveBundleResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "execute": { "description": "Executes integrations synchronously by passing the trigger id in the request body. The request is not returned until the requested executions are either fulfilled or experienced an error. If the integration name is not specified (passing `-`), all of the associated integration under the given trigger_id will be executed. Otherwise only the specified integration for the given `trigger_id` is executed. This is helpful for execution the integration from UI.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:execute", @@ -2279,87 +2085,8 @@ } } }, - "executionsnapshots": { - "methods": { - "list": { - "description": "Lists the snapshots of a given integration executions. This RPC is not being used.", - "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executionsnapshots", - "httpMethod": "GET", - "id": "integrations.projects.locations.products.integrations.executionsnapshots.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Currently supports filter by `execution_info_id` or `execution_snapshot_id`.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Number of entries to be returned in a page.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The token used to retrieve the next page results.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent resource name of the integration execution.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$", - "required": true, - "type": "string" - }, - "readMask": { - "description": "View mask for the response data. If set, only the field specified will be returned as part of the result. If not set, all fields in event execution snapshot will be filled and returned.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1alpha/{+parent}/executionsnapshots", - "response": { - "$ref": "GoogleCloudIntegrationsV1alphaListExecutionSnapshotsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, "versions": { "methods": { - "archive": { - "description": "Soft-deletes the integration. Changes the status of the integration to ARCHIVED. If the integration being ARCHIVED is tagged as \"HEAD\", the tag is removed from this snapshot and set to the previous non-ARCHIVED snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. This RPC throws an exception if the version being archived is DRAFT, and if the `locked_by` user is not the same as the user performing the Archive. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Archiving a integration. Currently, there is no unarchive mechanism.", - "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:archive", - "httpMethod": "POST", - "id": "integrations.projects.locations.products.integrations.versions.archive", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The version to archive. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+name}:archive", - "request": { - "$ref": "GoogleCloudIntegrationsV1alphaArchiveIntegrationVersionRequest" - }, - "response": { - "$ref": "GoogleCloudIntegrationsV1alphaArchiveIntegrationVersionResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "create": { "description": "Create a integration with a draft version in the specified project.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions", @@ -2393,34 +2120,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "deactivate": { - "description": "Sets the status of the ACTIVE integration to SNAPSHOT with a new tag \"PREVIOUSLY_PUBLISHED\" after validating it. The \"HEAD\" and \"PUBLISH_REQUESTED\" tags do not change. This RPC throws an exception if the version being snapshot is not ACTIVE. Audit fields added include action, action_by, action_timestamp.", - "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:deactivate", - "httpMethod": "POST", - "id": "integrations.projects.locations.products.integrations.versions.deactivate", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The version to deactivate. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+name}:deactivate", - "request": { - "$ref": "GoogleCloudIntegrationsV1alphaDeactivateIntegrationVersionRequest" - }, - "response": { - "$ref": "GoogleCloudIntegrationsV1alphaDeactivateIntegrationVersionResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "delete": { "description": "Soft-deletes the integration. Changes the status of the integration to ARCHIVED. If the integration being ARCHIVED is tagged as \"HEAD\", the tag is removed from this snapshot and set to the previous non-ARCHIVED snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. This RPC throws an exception if the version being deleted is DRAFT, and if the `locked_by` user is not the same as the user performing the Delete. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Deleting a integration. Currently, there is no undelete mechanism.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}", @@ -2511,31 +2210,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "getBundle": { - "description": "PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. RPC to get details of the Bundle", - "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:getBundle", - "httpMethod": "GET", - "id": "integrations.projects.locations.products.integrations.versions.getBundle", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The bundle name.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+name}:getBundle", - "response": { - "$ref": "GoogleCloudIntegrationsV1alphaGetBundleResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "list": { "description": "Returns the list of all integration versions in the specified project.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions", @@ -2706,34 +2380,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "updateBundle": { - "description": "THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. RPC to update the Bundle", - "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:updateBundle", - "httpMethod": "PATCH", - "id": "integrations.projects.locations.products.integrations.versions.updateBundle", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. Bundle name", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+name}:updateBundle", - "request": { - "$ref": "GoogleCloudIntegrationsV1alphaUpdateBundleRequest" - }, - "response": { - "$ref": "GoogleCloudIntegrationsV1alphaUpdateBundleResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "upload": { "description": "Uploads an integration. The content can be a previously downloaded integration. Performs the same function as CreateDraftIntegrationVersion, but accepts input in a string format, which holds the complete representation of the IntegrationVersion content.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions:upload", @@ -2761,34 +2407,6 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - }, - "validate": { - "description": "Validates the given integration. If the id doesn't exist, a NotFoundException is thrown. If validation fails a CanonicalCodeException is thrown. If there was no failure an empty response is returned.", - "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:validate", - "httpMethod": "POST", - "id": "integrations.projects.locations.products.integrations.versions.validate", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The version to validate. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+name}:validate", - "request": { - "$ref": "GoogleCloudIntegrationsV1alphaValidateIntegrationVersionRequest" - }, - "response": { - "$ref": "GoogleCloudIntegrationsV1alphaValidateIntegrationVersionResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] } } } @@ -3559,7 +3177,7 @@ } } }, - "revision": "20230117", + "revision": "20230124", "rootUrl": "https://integrations.googleapis.com/", "schemas": { "CrmlogErrorCode": { @@ -3776,7 +3394,7 @@ "type": "object" }, "EnterpriseCrmEventbusProtoAttributes": { - "description": "Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8", + "description": "Attributes are additional options that can be associated with each event property. For more information, see", "id": "EnterpriseCrmEventbusProtoAttributes", "properties": { "dataType": { @@ -3813,7 +3431,7 @@ }, "logSettings": { "$ref": "EnterpriseCrmEventbusProtoLogSettings", - "description": "See go/integration-platform/analytics/logging_task.md for details." + "description": "See" }, "searchable": { "enum": [ @@ -3863,7 +3481,7 @@ "type": "object" }, "EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue": { - "description": "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. See go/eventbus-alert-config-examples", + "description": "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.", "id": "EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue", "properties": { "absolute": { @@ -4369,7 +3987,7 @@ "type": "object" }, "EnterpriseCrmEventbusProtoEventBusProperties": { - "description": "LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details.", + "description": "LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus.", "id": "EnterpriseCrmEventbusProtoEventBusProperties", "properties": { "properties": { @@ -4545,7 +4163,7 @@ "type": "object" }, "EnterpriseCrmEventbusProtoEventParameters": { - "description": "LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4", + "description": "LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see", "id": "EnterpriseCrmEventbusProtoEventParameters", "properties": { "parameters": { @@ -4648,7 +4266,7 @@ "type": "object" }, "EnterpriseCrmEventbusProtoField": { - "description": "Information about the value and type of the field. Next Id: 8", + "description": "Information about the value and type of the field.", "id": "EnterpriseCrmEventbusProtoField", "properties": { "cardinality": { @@ -4665,7 +4283,7 @@ }, "defaultValue": { "$ref": "EnterpriseCrmEventbusProtoParameterValueType", - "description": "This holds the default values for the fields. This value is supplied by user so may or may not contain PII or SPII data. This field will be scrubbed using DatapolScrubber#maybeScrub() with go/proto-sanitizer#level3" + "description": "This holds the default values for the fields. This value is supplied by user so may or may not contain PII or SPII data." }, "fieldType": { "description": "Specifies the data type of the field.", @@ -4721,13 +4339,13 @@ }, "transformExpression": { "$ref": "EnterpriseCrmEventbusProtoTransformExpression", - "description": "This is the transform expression to fetch the input field value. for e.g. $param1$.CONCAT('test'). See go/transform-functions-design for more details. Keep points - 1. Only input field can have a transform expression. 2. If a transform expression is provided, reference_key will be ignored. 3. If no value is returned after evaluation of transform expression, default_value can be mapped if provided. 4. The field_type should be the type of the final object returned after the transform expression is evaluated. Scrubs the transform expression before logging as value provided by user so may or may not contain PII or SPII data." + "description": "This is the transform expression to fetch the input field value. for e.g. $param1$.CONCAT('test'). Keep points - 1. Only input field can have a transform expression. 2. If a transform expression is provided, reference_key will be ignored. 3. If no value is returned after evaluation of transform expression, default_value can be mapped if provided. 4. The field_type should be the type of the final object returned after the transform expression is evaluated. Scrubs the transform expression before logging as value provided by user so may or may not contain PII or SPII data." } }, "type": "object" }, "EnterpriseCrmEventbusProtoFieldMappingConfig": { - "description": "Field Mapping Config to map multiple output fields values from input fields values. Next id: 2", + "description": "Field Mapping Config to map multiple output fields values from input fields values.", "id": "EnterpriseCrmEventbusProtoFieldMappingConfig", "properties": { "mappedFields": { @@ -4980,7 +4598,7 @@ "type": "object" }, "EnterpriseCrmEventbusProtoLogSettings": { - "description": "The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details.", + "description": "The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information.", "id": "EnterpriseCrmEventbusProtoLogSettings", "properties": { "logFieldName": { @@ -5072,7 +4690,7 @@ "type": "object" }, "EnterpriseCrmEventbusProtoMappedField": { - "description": "Mapped field is a pair of input field and output field. Next Id: 3", + "description": "Mapped field is a pair of input field and output field.", "id": "EnterpriseCrmEventbusProtoMappedField", "properties": { "inputField": { @@ -5963,7 +5581,7 @@ "type": "object" }, "EnterpriseCrmEventbusProtoTaskAlertConfig": { - "description": "Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.", + "description": "Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event.", "id": "EnterpriseCrmEventbusProtoTaskAlertConfig", "properties": { "aggregationPeriod": { @@ -6113,7 +5731,7 @@ "type": "object" }, "EnterpriseCrmEventbusProtoTaskMetadata": { - "description": "TaskMetadata are attributes that are associated to every common Task we have. Next available: 26", + "description": "TaskMetadata are attributes that are associated to every common Task we have.", "id": "EnterpriseCrmEventbusProtoTaskMetadata", "properties": { "activeTaskName": { @@ -6224,7 +5842,7 @@ "type": "string" }, "iconLink": { - "description": "URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons.", + "description": "URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format.", "type": "string" }, "isDeprecated": { @@ -6306,7 +5924,7 @@ "type": "object" }, "EnterpriseCrmEventbusProtoTaskUiConfig": { - "description": "Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework", + "description": "Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework:", "id": "EnterpriseCrmEventbusProtoTaskUiConfig", "properties": { "taskUiModuleConfigs": { @@ -6500,7 +6118,7 @@ "type": "object" }, "EnterpriseCrmEventbusProtoWorkflowAlertConfig": { - "description": "Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.", + "description": "Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.", "id": "EnterpriseCrmEventbusProtoWorkflowAlertConfig", "properties": { "aggregationPeriod": { @@ -6585,7 +6203,7 @@ }, "thresholdValue": { "$ref": "EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue", - "description": "The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples." + "description": "The metric value, above or below which the alert should be triggered." }, "warningEnumList": { "$ref": "EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList" @@ -6945,7 +6563,7 @@ "type": "object" }, "EnterpriseCrmFrontendsEventbusProtoEventParameters": { - "description": "LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4", + "description": "LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see", "id": "EnterpriseCrmFrontendsEventbusProtoEventParameters", "properties": { "parameters": { @@ -7773,7 +7391,7 @@ "type": "string" }, "isTransient": { - "description": "Whether this parameter is a transient parameter. go/ip-transient-parameters", + "description": "Whether this parameter is a transient parameter.", "type": "boolean" }, "jsonSchema": { @@ -8362,30 +7980,6 @@ }, "type": "object" }, - "GoogleCloudIntegrationsV1alphaArchiveBundleRequest": { - "description": "Request for ArchiveBundle.", - "id": "GoogleCloudIntegrationsV1alphaArchiveBundleRequest", - "properties": {}, - "type": "object" - }, - "GoogleCloudIntegrationsV1alphaArchiveBundleResponse": { - "description": "Response for ArchiveBundle.", - "id": "GoogleCloudIntegrationsV1alphaArchiveBundleResponse", - "properties": {}, - "type": "object" - }, - "GoogleCloudIntegrationsV1alphaArchiveIntegrationVersionRequest": { - "description": "Request for ArchiveIntegrationVersion.", - "id": "GoogleCloudIntegrationsV1alphaArchiveIntegrationVersionRequest", - "properties": {}, - "type": "object" - }, - "GoogleCloudIntegrationsV1alphaArchiveIntegrationVersionResponse": { - "description": "Response for ArchiveIntegrationVersion.", - "id": "GoogleCloudIntegrationsV1alphaArchiveIntegrationVersionResponse", - "properties": {}, - "type": "object" - }, "GoogleCloudIntegrationsV1alphaAttemptStats": { "description": "Status for the execution attempt.", "id": "GoogleCloudIntegrationsV1alphaAttemptStats", @@ -8738,43 +8332,6 @@ }, "type": "object" }, - "GoogleCloudIntegrationsV1alphaCreateBundleRequest": { - "description": "PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. Request to create a new Bundle.", - "id": "GoogleCloudIntegrationsV1alphaCreateBundleRequest", - "properties": { - "bundleId": { - "description": "Required. name of the bundle that will be created", - "type": "string" - }, - "integrations": { - "description": "A list of integrations that can be executed by the bundle", - "items": { - "type": "string" - }, - "type": "array" - }, - "secondaryCustomerOrgId": { - "description": "Optional. The prefix for the SA, it should be in the format \"o\". This is an optional field, and if empty service account will be created per project, where we are creating bundle. This should only be used as the org ID for which we want to run the integrations in the bundle.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudIntegrationsV1alphaCreateBundleResponse": { - "description": "Response for create bundle.", - "id": "GoogleCloudIntegrationsV1alphaCreateBundleResponse", - "properties": { - "config": { - "$ref": "GoogleCloudIntegrationsV1alphaIntegrationBundleConfig", - "description": "It contains the bundle data" - }, - "triggerId": { - "description": "trigger_id of the bundle task", - "type": "string" - } - }, - "type": "object" - }, "GoogleCloudIntegrationsV1alphaCredential": { "description": "Defines parameters for a single, canonical credential.", "id": "GoogleCloudIntegrationsV1alphaCredential", @@ -8846,18 +8403,6 @@ }, "type": "object" }, - "GoogleCloudIntegrationsV1alphaDeactivateIntegrationVersionRequest": { - "description": "Request for DeactivateIntegrationVersion.", - "id": "GoogleCloudIntegrationsV1alphaDeactivateIntegrationVersionRequest", - "properties": {}, - "type": "object" - }, - "GoogleCloudIntegrationsV1alphaDeactivateIntegrationVersionResponse": { - "description": "Response for DeactivateIntegrationVersion.", - "id": "GoogleCloudIntegrationsV1alphaDeactivateIntegrationVersionResponse", - "properties": {}, - "type": "object" - }, "GoogleCloudIntegrationsV1alphaDoubleParameterArray": { "description": "This message only contains a field of double number array.", "id": "GoogleCloudIntegrationsV1alphaDoubleParameterArray", @@ -9225,17 +8770,6 @@ }, "type": "object" }, - "GoogleCloudIntegrationsV1alphaGetBundleResponse": { - "description": "Response for GetBundle.", - "id": "GoogleCloudIntegrationsV1alphaGetBundleResponse", - "properties": { - "config": { - "$ref": "GoogleCloudIntegrationsV1alphaIntegrationBundleConfig", - "description": "It contains the bundle data" - } - }, - "type": "object" - }, "GoogleCloudIntegrationsV1alphaIntParameterArray": { "description": "This message only contains a field of integer array.", "id": "GoogleCloudIntegrationsV1alphaIntParameterArray", @@ -9374,25 +8908,6 @@ }, "type": "object" }, - "GoogleCloudIntegrationsV1alphaIntegrationBundleConfig": { - "description": "This proto holds the core runner data in the bundle task. It is not expected to be directly edited by the user. Instead, a default value will be provided at the task creation time.", - "id": "GoogleCloudIntegrationsV1alphaIntegrationBundleConfig", - "properties": { - "integrations": { - "description": "A bundle of integrations that can be executed by the task at runtime.", - "items": { - "type": "string" - }, - "type": "array" - }, - "serviceAccount": { - "description": "Output only. The service account created and owned by IP and added to the customers GCP project.", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, "GoogleCloudIntegrationsV1alphaIntegrationParameter": { "description": "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.", "id": "GoogleCloudIntegrationsV1alphaIntegrationParameter", @@ -9855,24 +9370,6 @@ }, "type": "object" }, - "GoogleCloudIntegrationsV1alphaListExecutionSnapshotsResponse": { - "description": "Response for listing the integration execution snapshot.", - "id": "GoogleCloudIntegrationsV1alphaListExecutionSnapshotsResponse", - "properties": { - "executionSnapshots": { - "description": "Required. The detailed information for the execution snapshot.", - "items": { - "$ref": "EnterpriseCrmEventbusProtoEventExecutionSnapshot" - }, - "type": "array" - }, - "nextPageToken": { - "description": "The token returned in the previous response.", - "type": "string" - } - }, - "type": "object" - }, "GoogleCloudIntegrationsV1alphaListExecutionsResponse": { "description": "Response for listing the integration execution data.", "id": "GoogleCloudIntegrationsV1alphaListExecutionsResponse", @@ -10046,20 +9543,6 @@ }, "type": "object" }, - "GoogleCloudIntegrationsV1alphaListTaskEntitiesResponse": { - "description": "This is a UI only method and will be moved away. Response for ListTaskEntities.", - "id": "GoogleCloudIntegrationsV1alphaListTaskEntitiesResponse", - "properties": { - "taskEntities": { - "description": "The list of the tasks.", - "items": { - "$ref": "EnterpriseCrmFrontendsEventbusProtoTaskEntity" - }, - "type": "array" - } - }, - "type": "object" - }, "GoogleCloudIntegrationsV1alphaNextTask": { "description": "The task that is next in line to be executed, if the condition specified evaluated to true.", "id": "GoogleCloudIntegrationsV1alphaNextTask", @@ -11037,28 +10520,6 @@ "properties": {}, "type": "object" }, - "GoogleCloudIntegrationsV1alphaUpdateBundleRequest": { - "description": "THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. Request message for Bundle update", - "id": "GoogleCloudIntegrationsV1alphaUpdateBundleRequest", - "properties": { - "config": { - "$ref": "GoogleCloudIntegrationsV1alphaIntegrationBundleConfig", - "description": "It contains the updated bundle data" - } - }, - "type": "object" - }, - "GoogleCloudIntegrationsV1alphaUpdateBundleResponse": { - "description": "Response message for Bundle update", - "id": "GoogleCloudIntegrationsV1alphaUpdateBundleResponse", - "properties": { - "config": { - "$ref": "GoogleCloudIntegrationsV1alphaIntegrationBundleConfig", - "description": "Contains updated bundle config" - } - }, - "type": "object" - }, "GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest": { "description": "Request for UploadIntegrationVersion.", "id": "GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest", @@ -11110,18 +10571,6 @@ }, "type": "object" }, - "GoogleCloudIntegrationsV1alphaValidateIntegrationVersionRequest": { - "description": "Request for ValidateIntegrationVersion.", - "id": "GoogleCloudIntegrationsV1alphaValidateIntegrationVersionRequest", - "properties": {}, - "type": "object" - }, - "GoogleCloudIntegrationsV1alphaValidateIntegrationVersionResponse": { - "description": "Response for ValidateIntegrationVersion.", - "id": "GoogleCloudIntegrationsV1alphaValidateIntegrationVersionResponse", - "properties": {}, - "type": "object" - }, "GoogleCloudIntegrationsV1alphaValueType": { "description": "The type of the parameter.", "id": "GoogleCloudIntegrationsV1alphaValueType",