View Source API Reference google_api_integrations v0.12.0
Modules
API client metadata for GoogleApi.Integrations.V1.
API calls for all endpoints tagged Callback
.
API calls for all endpoints tagged ConnectorPlatformRegions
.
API calls for all endpoints tagged Projects
.
Handle Tesla connections for GoogleApi.Integrations.V1.
Registered ids for errors, as "oneof" enums. Each task or logical grouping of tasks may share the same enum.
Attributes
-
allowedCredentialTypes
(type:list(String.t)
, default:nil
) - Defines the credential types to be supported as Task may restrict specific types to use, e.g. Cloud SQL Task will use username/password type only. -
allowedServiceAccountInContext
(type:boolean()
, default:nil
) - -
authConfigId
(type:String.t
, default:nil
) - UUID of the AuthConfig. -
scope
(type:String.t
, default:nil
) - A space-delimited list of requested scope permissions. -
useServiceAccountInContext
(type:boolean()
, default:nil
) -
Email address along with optional name and tokens. These tokens will be substituted for the variables in the form of [{var_name}], where var_name could be any string of no more than 32 bytes.
Attributes are additional options that can be associated with each event property. For more information, see
List of error enums for alerts.
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.
Attributes
-
baseFunction
(type:GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoFunction.t
, default:nil
) - Start with a function that does not build on existing values. Eg. CurrentTime, Min, Max, Exists, etc. -
literalValue
(type:GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoParameterValueType.t
, default:nil
) - Start with a literal value. -
referenceValue
(type:String.t
, default:nil
) - Start with a reference value to dereference.
Attributes
-
assigneeEmailAddress
(type:String.t
, default:nil
) - Whom to assign the new bug. Optional. -
componentId
(type:String.t
, default:nil
) - ID of the buganizer component within which to create a new issue. Required. -
templateId
(type:String.t
, default:nil
) - ID of the buganizer template to use. Optional. -
title
(type:String.t
, default:nil
) - Title of the issue to be created. Required.
Attributes
-
gcpProjectId
(type:String.t
, default:nil
) - Optional. The id of GCP project where the KMS key is stored. If not provided, assume the key is stored in the same GCP project defined in Client (tag 14). -
keyName
(type:String.t
, default:nil
) - A Cloud KMS key is a named object containing one or more key versions, along with metadata for the key. A key exists on exactly one key ring tied to a specific location. -
keyRingName
(type:String.t
, default:nil
) - A key ring organizes keys in a specific Google Cloud location and allows you to manage access control on groups of keys. A key ring's name does not need to be unique across a Google Cloud project, but must be unique within a given location. -
keyVersionName
(type:String.t
, default:nil
) - Optional. Each version of a key contains key material used for encryption or signing. A key's version is represented by an integer, starting at 1. To decrypt data or verify a signature, you must use the same key version that was used to encrypt or sign the data. -
locationName
(type:String.t
, default:nil
) - Location name of the key ring, e.g. "us-west1". -
serviceAccount
(type:String.t
, default:nil
) - Optional. The service account used for authentication of this KMS key. If this is not provided, the service account in Client.clientSource will be used.
Cloud Logging details, selected by the user for the integration version (workflow). This message field will be also used in ExecutionInfo, to indicate the CloudLoggingDetails config at the time of workflow (integration version) execution, since this field value can be changed for an unpublished workflow.
Cloud Scheduler Trigger configuration
This message recursively combines constituent conditions using logical AND.
Condition that uses operator
to evaluate the key against the value.
Contains the combined condition calculation results.
Attributes
-
defaultFailurePolicy
(type:GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoFailurePolicy.t
, default:nil
) - The default failure policy to be applied if no conditional failure policy matches -
failurePolicies
(type:list(GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoFailurePolicy.t)
, default:nil
) - The list of failure policies that will be applied to the task in order.
Attributes
-
connectionName
(type:String.t
, default:nil
) - Connection name Format: projects/{project}/locations/{location}/connections/{connection} -
connectorVersion
(type:String.t
, default:nil
) - Connector version Format: projects/{project}/locations/{location}/providers/{provider}/connectors/{connector}/versions/{version} -
host
(type:String.t
, default:nil
) - The name of the Hostname of the Service Directory service with TLS if used. -
serviceName
(type:String.t
, default:nil
) - Service name Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}
Represents two-dimensional positions.
Attributes
-
postToQueueWithTriggerIdRequest
(type:GoogleApi.Integrations.V1.Model.GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest.t
, default:nil
) - Request to fire an event containing the SuspensionInfo message. -
suspensionInfoEventParameterKey
(type:String.t
, default:nil
) - In the fired event, set the SuspensionInfo message as the value for this key.
An error, warning, or information message associated with a workflow.
LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus.
Contains the details of the execution info of this event: this includes the tasks execution details plus the event execution statistics. Next available id: 12
Contains the snapshot of the event execution for a given checkpoint. Next available id: 15
Attributes
-
ancestorIterationNumbers
(type:list(String.t)
, default:nil
) - Ancestor iteration number for the task(it will only be non-empty if the task is under 'private workflow') -
ancestorTaskNumbers
(type:list(String.t)
, default:nil
) - Ancestor task number for the task(it will only be non-empty if the task is under 'private workflow') -
eventAttemptNum
(type:integer()
, default:nil
) - the event attempt number this snapshot belongs to. -
integrationName
(type:String.t
, default:nil
) - The direct integration which the event execution snapshots belongs to -
taskAttemptNum
(type:integer()
, default:nil
) - the task attempt number this snapshot belongs to. Could be empty. -
taskLabel
(type:String.t
, default:nil
) - the task label associated with this snapshot. Could be empty. -
taskName
(type:String.t
, default:nil
) - the task name associated with this snapshot. Could be empty. -
taskNumber
(type:String.t
, default:nil
) - The task number associated with this snapshot. Could be empty.
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
Message that helps aggregate all sub-executions triggered by one execution and keeps track of child-parent relationships.
Represents external traffic type and id.
Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a retry_strategy
of NONE will be applied).
Information about the value and type of the field.
Field Mapping Config to map multiple output fields values from input fields values.
Attributes
-
functionType
(type:GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoFunctionType.t
, default:nil
) - The name of the function to perform. -
parameters
(type:list(GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoTransformExpression.t)
, default:nil
) - List of parameters required for the transformation.
Attributes
-
baseFunction
(type:GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoBaseFunction.t
, default:nil
) - LINT.IfChange -
booleanArrayFunction
(type:GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoBooleanArrayFunction.t
, default:nil
) - -
booleanFunction
(type:GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoBooleanFunction.t
, default:nil
) - -
doubleArrayFunction
(type:GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoDoubleArrayFunction.t
, default:nil
) - -
doubleFunction
(type:GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoDoubleFunction.t
, default:nil
) - -
intArrayFunction
(type:GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoIntArrayFunction.t
, default:nil
) - -
intFunction
(type:GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoIntFunction.t
, default:nil
) - -
jsonFunction
(type:GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoJsonFunction.t
, default:nil
) - -
protoArrayFunction
(type:GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoProtoArrayFunction.t
, default:nil
) - -
protoFunction
(type:GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoProtoFunction.t
, default:nil
) - -
stringArrayFunction
(type:GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoStringArrayFunction.t
, default:nil
) - -
stringFunction
(type:GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoStringFunction.t
, default:nil
) -
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.
Attributes
-
currentIterationCount
(type:String.t
, default:nil
) - Starting from 1, not 0. -
currentIterationDetail
(type:String.t
, default:nil
) - Needs to be set by the loop impl class before each iteration. The abstract loop class will append the request and response to it. Eg. The foreach Loop will clean up and set it as the current iteration element at the start of each loop. The post request and response will be appended to the value once they are available. -
errorMsg
(type:String.t
, default:nil
) - Add the error message when loops fail. -
failureLocation
(type:String.t
, default:nil
) - Indicates where in the loop logic did it error out.
Mapped field is a pair of input field and output field.
The task that is next in line to be executed, if the condition specified evaluated to true.
The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching).
Represents a node identifier (type + id). Next highest id: 3
Attributes
-
buganizerNotification
(type:GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoBuganizerNotification.t
, default:nil
) - -
emailAddress
(type:GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoAddress.t
, default:nil
) - -
escalatorQueue
(type:String.t
, default:nil
) - -
pubsubTopic
(type:String.t
, default:nil
) - -
request
(type:GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoCustomSuspensionRequest.t
, default:nil
) - If the out-of-the-box email/pubsub notifications are not suitable and custom logic is required, fire a workflow containing all info needed to notify users to resume execution.
Attributes
-
descriptivePhrase
(type:String.t
, default:nil
) - A short phrase to describe what this parameter contains. -
helpText
(type:String.t
, default:nil
) - Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter. -
hideDefaultValue
(type:boolean()
, default:nil
) - Whether the default value is hidden in the UI. -
inputDisplayOption
(type:String.t
, default:nil
) - -
isHidden
(type:boolean()
, default:nil
) - Whether this field is hidden in the UI. -
label
(type:String.t
, default:nil
) - A user-friendly label for the parameter. -
parameterNameOption
(type:String.t
, default:nil
) - -
subSectionLabel
(type:String.t
, default:nil
) - A user-friendly label for subSection under which the parameter will be displayed. -
uiPlaceholderText
(type:String.t
, default:nil
) - Placeholder text which will appear in the UI input form for this parameter.
Attributes
-
doubleRange
(type:GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleDoubleRange.t
, default:nil
) - -
intRange
(type:GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleIntRange.t
, default:nil
) - -
stringRegex
(type:GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleStringRegex.t
, default:nil
) -
Range used to validate doubles and floats.
Range used to validate longs and ints.
Rule used to validate strings.
Key-value pair of EventBus parameters.
A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified.
Entry is a pair of key and value.
Field represents either the key or value in an entry.
LINT.IfChange To support various types of parameter values. Next available id: 14
Key-value pair of EventBus property.
Attributes
-
errorMsg
(type:String.t
, default:nil
) - The error message of the failure if applicable. -
executionIds
(type:list(String.t)
, default:nil
) - The execution ids of each Subworkflow fired by this scatter. -
isSuccessful
(type:boolean()
, default:nil
) - If execution is sync, this is true if the execution passed and false if it failed. If the execution is async, this is true if the WF was fired off successfully, and false if it failed to execute. The success or failure of the subworkflows executed are not captured. -
responseParams
(type:list(GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoParameterEntry.t)
, default:nil
) - A list of all the response parameters in the aggregtorMap stored with the remapped key. -
scatterElement
(type:GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoParameterValueType.t
, default:nil
) - The element that was scattered for this execution.
Policy that dictates the behavior for the task after it completes successfully.
Attributes
-
customMessage
(type:String.t
, default:nil
) - Optional information to provide recipients of the suspension in addition to the resolution URL, typically containing relevant parameter values from the originating workflow. -
notifications
(type:list(GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoNotification.t)
, default:nil
) - -
suspensionExpiration
(type:GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoSuspensionExpiration.t
, default:nil
) - Indicates the next steps when no external actions happen on the suspension. -
whoMayResolve
(type:list(GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoSuspensionAuthPermissions.t)
, default:nil
) - Identities able to resolve this suspension.
Attributes
-
expireAfterMs
(type:integer()
, default:nil
) - Milliseconds after which the suspension expires, if no action taken. -
liftWhenExpired
(type:boolean()
, default:nil
) - Whether the suspension will be REJECTED or LIFTED upon expiration. REJECTED is the default behavior. -
remindAfterMs
(type:integer()
, default:nil
) - Milliseconds after which the previous suspension action reminder, if any, is sent using the selected notification option, for a suspension which is still PENDING_UNSPECIFIED.
Attributes
-
audit
(type:GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoSuspensionResolutionInfoAudit.t
, default:nil
) - -
clientId
(type:String.t
, default:nil
) - The event data user sends as request. -
cloudKmsConfig
(type:GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoCloudKmsConfig.t
, default:nil
) - KMS info, used by cmek/gmek integration -
createdTimestamp
(type:DateTime.t
, default:nil
) - Auto-generated. -
encryptedSuspensionResolutionInfo
(type:String.t
, default:nil
) - Encrypted SuspensionResolutionInfo -
eventExecutionInfoId
(type:String.t
, default:nil
) - Required. ID of the associated execution. -
externalTraffic
(type:GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoExternalTraffic.t
, default:nil
) - The origin of the suspension for periodic notifications. -
lastModifiedTimestamp
(type:DateTime.t
, default:nil
) - Auto-generated. -
product
(type:String.t
, default:nil
) - Which Google product the suspension belongs to. If not set, the suspension belongs to Integration Platform by default. -
status
(type:String.t
, default:nil
) - -
suspensionConfig
(type:GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoSuspensionConfig.t
, default:nil
) - -
suspensionId
(type:String.t
, default:nil
) - Primary key for the SuspensionResolutionInfoTable. -
taskNumber
(type:String.t
, default:nil
) - Required. Task number of the associated SuspensionTask. -
workflowName
(type:String.t
, default:nil
) - Required. The name of the originating workflow. -
wrappedDek
(type:String.t
, default:nil
) - Wrapped dek
Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event.
Contains the details of the execution of this task. Next available id: 11
TaskMetadata are attributes that are associated to every common Task we have.
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.
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
Task author would use this type to configure a config module.
Attributes
-
creatorEmail
(type:String.t
, default:nil
) - The creator's email address. -
name
(type:String.t
, default:nil
) - Required. Unique identifier of the teardown task within this Config. We use this field as the identifier to find next teardown tasks. -
nextTeardownTask
(type:GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoNextTeardownTask.t
, default:nil
) - -
parameters
(type:GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoEventParameters.t
, default:nil
) - The parameters the user can pass to this task. -
properties
(type:GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoEventBusProperties.t
, default:nil
) - -
teardownTaskImplementationClassName
(type:String.t
, default:nil
) - Required. Implementation class name.
Attributes
-
initialValue
(type:GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoBaseValue.t
, default:nil
) - Initial value upon which to perform transformations. -
transformationFunctions
(type:list(GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoFunction.t)
, default:nil
) - Transformations to be applied sequentially.
Attributes
-
condition
(type:String.t
, default:nil
) - 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
(type:GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoEventParameters.t
, default:nil
) - Optional. To be used in TaskConfig for the implementation class. -
triggerCriteriaTaskImplementationClassName
(type:String.t
, default:nil
) - Optional. Implementation class name. The class should implement the “TypedTask” interface.
Used for define type for values. Currently supported value types include int, string, double, array, and any proto message.
Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
Stats for the requested dimensions: QPS, duration, and error/warning rate
Attributes
-
clientId
(type:String.t
, default:nil
) - -
enumFilterType
(type:String.t
, default:nil
) - Whether to include or exclude the enums matching the regex. -
errorEnumString
(type:String.t
, default:nil
) - -
retryAttempt
(type:String.t
, default:nil
) - -
taskName
(type:String.t
, default:nil
) - -
taskNumber
(type:String.t
, default:nil
) - -
triggerId
(type:String.t
, default:nil
) - Stats have been or will be aggregated on set fields for any semantically-meaningful combination. -
warningEnumString
(type:String.t
, default:nil
) - -
workflowId
(type:String.t
, default:nil
) - -
workflowName
(type:String.t
, default:nil
) -
Contains the details of the execution info of this event: this includes the tasks execution details plus the event execution statistics. Next available id: 12
Contains all the execution details for a workflow instance. Next available id: 27
Contains the details of the execution info: this includes the replay reason and replay tree connecting executions in a parent-child relationship
Attributes
-
checkpointTaskNumber
(type:String.t
, default:nil
) - Indicates "right after which checkpoint task's execution" this snapshot is taken. -
conditionResults
(type:list(GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoConditionResult.t)
, default:nil
) - All of the computed conditions that been calculated. -
diffParams
(type:GoogleApi.Integrations.V1.Model.EnterpriseCrmFrontendsEventbusProtoEventParameters.t
, default:nil
) - The parameters in Event object that differs from last snapshot. -
eventExecutionInfoId
(type:String.t
, default:nil
) - Points to the event execution info this snapshot belongs to. -
eventExecutionSnapshotId
(type:String.t
, default:nil
) - Auto-generated. Used as primary key for EventExecutionSnapshots table. -
eventExecutionSnapshotMetadata
(type:GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata.t
, default:nil
) - -
eventParams
(type:GoogleApi.Integrations.V1.Model.EnterpriseCrmFrontendsEventbusProtoEventParameters.t
, default:nil
) - The parameters in Event object. -
snapshotTime
(type:String.t
, default:nil
) - Indicates when this snapshot is taken. -
taskExecutionDetails
(type:list(GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoTaskExecutionDetails.t)
, default:nil
) - All of the task execution details at the given point of time. -
taskName
(type:String.t
, default:nil
) - The task name associated with this snapshot. Could be empty.
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
Key-value pair of EventBus task parameters. Next id: 13
Key-value pair of EventBus parameters.
A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified.
Entry is a pair of key and value.
Field represents either the key or value in an entry.
To support various types of parameter values. Next available id: 14
Next available id: 4
The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.
Contains a task's metadata and associated information. Next available id: 7
Configuration detail of a trigger. Next available id: 22
Variables names mapped to api trigger.
Attributes
-
attributes
(type:GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoAttributes.t
, default:nil
) - Metadata information about the parameters. -
children
(type:list(GoogleApi.Integrations.V1.Model.EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry.t)
, default:nil
) - Child parameters nested within this parameter. This field only applies to protobuf parameters -
containsLargeData
(type:boolean()
, default:nil
) - Indicates whether this variable contains large data and need to be uploaded to Cloud Storage. -
dataType
(type:String.t
, default:nil
) - The data type of the parameter. -
defaultValue
(type:GoogleApi.Integrations.V1.Model.EnterpriseCrmFrontendsEventbusProtoParameterValueType.t
, default:nil
) - Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object. -
description
(type:String.t
, default:nil
) - Optional. The description about the parameter -
inOutType
(type:String.t
, default:nil
) - Specifies the input/output type for the parameter. -
isTransient
(type:boolean()
, default:nil
) - Whether this parameter is a transient parameter. -
jsonSchema
(type:String.t
, default:nil
) - This schema will be used to validate runtime JSON-typed values of this parameter. -
key
(type:String.t
, default:nil
) - 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
(type:String.t
, default:nil
) - 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". -
producedBy
(type:GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoNodeIdentifier.t
, default:nil
) - The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param. -
producer
(type:String.t
, default:nil
) - -
protoDefName
(type:String.t
, default:nil
) - The name of the protobuf type if the parameter has a protobuf data type. -
protoDefPath
(type:String.t
, default:nil
) - If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry". -
required
(type:boolean()
, default:nil
) -
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.
AuthConfig defines details of a authentication type.
Parameters to support Oauth 2.0 Auth Code Grant Authentication. See https://www.rfc-editor.org/rfc/rfc6749#section-1.3.1 for more details.
Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details.
Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details.
Parameters to support JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant based authentication. See https://tools.ietf.org/html/rfc7523 for more details.
JWT claims used for the jwt-bearer authorization grant.
Parameters to support Ssh public key Authentication.
Parameters to support Username and Password Authentication.
Billing config for the connection.
ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
Connection represents an instance of connector.
ConnectionStatus indicates the state of the connection.
This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version
Attributes
-
host
(type:String.t
, default:nil
) - For publicly routable host. -
port
(type:integer()
, default:nil
) - The port is the target port number that is accepted by the destination. -
serviceAttachment
(type:String.t
, default:nil
) - PSC service attachments. Format: projects//regions//serviceAttachments/*
Define the Connectors target endpoint.
Encryption Key value.
Eventing Configuration of a connection
Dead Letter configuration details provided by the user.
Eventing runtime data has the details related to eventing managed by the system.
WebhookData has details of webhook configuration.
WebhookSubscriptions has details of webhook subscriptions.
EventingStatus indicates the state of eventing.
Autoscaling config for connector deployment system metrics.
Determines whether or no a connection is locked. If locked, a reason must be specified.
Log configuration for the connection.
Node configuration for the connection.
Resource limits defined for connection pods of a given connector type.
Resource requests defined for connection pods of a given connector type.
Secret provides a reference to entries in Secret Manager.
SSL Configuration of a connection
The access token represents the authorization of a specific application to access specific parts of a user’s data.
An assertion which will check for a condition over task execution status or an expression for task output variables Next available id: 5
The result of an assertion.
Status for the execution attempt.
The AuthConfig resource use to hold channels and connection config data.
The credentials to authenticate a user agent with a server that is put in HTTP Authorization request header.
This message only contains a field of boolean array.
Request for cancelling an execution.
Response for cancelling an execution.
The certificate definition
Contains client certificate information
The configuration information for the Client
Configuration information for Client's Cloud KMS information
Cloud Logging details for execution info
Cloud Scheduler Trigger configuration
Conditional task failur retry strategies
Metadata of runtime connection schema.
Configuration detail of coordinate, it used for UI
Request for CreateAppsScriptProject rpc call.
Response for CreateAppsScriptProject rpc call.
Request for Creating Cloud Function rpc call.
Response for Creating Cloud Function rpc call.
Defines parameters for a single, canonical credential.
Request for the Deprovision rpc
This message only contains a field of double number array.
Response for downloading an execution.
Response for DownloadIntegrationVersion.
Response for DownloadJsonPackage.
Response for DownloadTemplate.
Response for DownloadTestCase.
Response containing all provisioned regions for Connector Platform.
Configuration detail of a error catch task
This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Next available id: 4
The response for executing an integration.
The request for executing an integration.
The response for executing an integration.
The request for executing a functional test.
The response for executing a functional test.
The Execution resource contains detailed information of an individual integration execution.
Contains the details of the execution info: this includes the tasks execution details plus the event execution statistics.
Contains the details of the execution info: this includes the replay reason and replay tree connecting executions in a parent-child relationship
Contains the snapshot of the execution for a given checkpoint.
Metadata of the execution snapshot.
Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a retry_strategy
of NONE will be applied).
To store Integration version related file i.e. Integration Version, Config variable etc.
Returns success or error message
Response for the GetClientMetadata rpc
Response for the GetClient rpc
Request to Import template
Response for import template
This message only contains a field of integer array.
The integration definition.
Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
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.
Integration Config Parameter is defined in the integration config and are used to provide external configuration for integration. It provide information about data types of the expected parameters and provide any default values or value. They can also be used to add custom attributes.
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.
The integration version definition.
Define the template of IntegrationVersion.
Represents JSON web token(JWT), which is a compact, URL-safe means of representing claims to be transferred between two parties, enabling the claims to be digitally signed or integrity protected.
Request for lift Suspension
Response of lift Suspense
Request for LinkAppsScriptProject rpc call.
Response for LinkAppsScriptProject rpc call.
Response to list AuthConfigs.
Response to list Certificates.
Response containing Connections listed by region.
Response for listing the integration execution data.
Response for ListIntegrationVersions.
Response for ListIntegrations.
Response for listing RuntimeActionSchemas for a specific Connection.
Response for listing RuntimeEntitySchemas for a specific Connection.
Response to list SfdcChannels.
Response to list SfdcInstances.
Response for Suspensions.ListSuspensions.
Response for a request to list templates
The response for listing the functional test execution data.
Response for ListTestCases
The configuration for mocking of a task during test execution Next available id: 4
The task that is next in line to be executed, if the condition specified evaluated to true.
The OAuth Type where the client sends request with the client id and requested scopes to auth endpoint. User sees a consent screen and auth code is received at specified redirect url afterwards. The auth code is then combined with the client id and secret and sent to the token endpoint in exchange for the access and refresh token. The refresh token can be used to fetch new access tokens.
For client credentials grant, the client sends a POST request with grant_type as 'client_credentials' to the authorization server. The authorization server will respond with a JSON object containing the access token.
For resource owner credentials grant, the client will ask the user for their authorization credentials (ususally a username and password) and send a POST request to the authorization server. The authorization server will respond with a JSON object containing the access token.
A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified.
Entry is a pair of key and value.
Field represents either the key or value in an entry.
Metadata information for the given project
Request for the Provision rpc
Request for PublishIntegrationVersion.
Response for PublishIntegrationVersion.
Request for the ReplaceServiceAccount rpc
Request for replaying an execution.
Response for replaying an execution.
Request for [Suspensions.ResolveSuspensions].
Response for Suspensions.ResolveSuspensions.
Metadata of an action, including schemas for its inputs and outputs.
Metadata of an entity, including a schema for its properties.
The request for scheduling an integration. Next available id: 11
The response for executing an integration.
Response for a request to search templates
To store string representation of Integration file.
Represents the service account which can be used to generate access token for authenticating the service call.
The SfdcChannel that points to a CDC or Platform Event Channel.
The SfdcInstance resource use to hold channels and connection config data.
Request to Share template
This message only contains a field of string array.
Policy that dictates the behavior for the task after it completes successfully.
A record representing a suspension.
Configurations for approving the Suspension.
Expiration configs for the approval request.
Contains when and by whom the suspension was resolved.
Request for the SwitchEncryption rpc
Request to enable/disable variable masking for a provisioned client
Request for TakeoverEditLock.
Response for TakeoverEditLock.
Request for TakeoverTestCaseEditLock.
The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.
Contains the details of the execution of this task.
Defines the template for Application Integration
Define the bundle of the template.
Define the components that are present in a template.
Defines the functional test case for Application Integration. Next available id: 15
The request for testing an integration.
The response for testing an integration.
The task mock configuration details and assertions for functional tests. Next available id: 6
Configuration detail of a trigger.
Variables names mapped to api trigger.
Request for UnpublishIntegrationVersion.
Request to Unshare template
Request for UploadIntegrationVersion.
Response for UploadIntegrationVersion.
Request for UploadTemplate.
Response for UploadTemplate.
Request for UploadTestCase.
Response for UploadTestCase.
Request to Use template
Sub Integration which would be created via templates.
Response for use template
Username and password pair.
The type of the parameter.
LINT.IfChange Use this request to post all workflows associated with a given trigger id. Next available id: 13
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
API client metadata for GoogleApi.Integrations.V1alpha.
API calls for all endpoints tagged Callback
.
API calls for all endpoints tagged ConnectorPlatformRegions
.
API calls for all endpoints tagged Projects
.
Handle Tesla connections for GoogleApi.Integrations.V1alpha.
Registered ids for errors, as "oneof" enums. Each task or logical grouping of tasks may share the same enum.
Attributes
-
allowedCredentialTypes
(type:list(String.t)
, default:nil
) - Defines the credential types to be supported as Task may restrict specific types to use, e.g. Cloud SQL Task will use username/password type only. -
allowedServiceAccountInContext
(type:boolean()
, default:nil
) - -
authConfigId
(type:String.t
, default:nil
) - UUID of the AuthConfig. -
scope
(type:String.t
, default:nil
) - A space-delimited list of requested scope permissions. -
useServiceAccountInContext
(type:boolean()
, default:nil
) -
Email address along with optional name and tokens. These tokens will be substituted for the variables in the form of [{var_name}], where var_name could be any string of no more than 32 bytes.
Attributes are additional options that can be associated with each event property. For more information, see
List of error enums for alerts.
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.
Attributes
-
baseFunction
(type:GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmEventbusProtoFunction.t
, default:nil
) - Start with a function that does not build on existing values. Eg. CurrentTime, Min, Max, Exists, etc. -
literalValue
(type:GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmEventbusProtoParameterValueType.t
, default:nil
) - Start with a literal value. -
referenceValue
(type:String.t
, default:nil
) - Start with a reference value to dereference.
Attributes
-
assigneeEmailAddress
(type:String.t
, default:nil
) - Whom to assign the new bug. Optional. -
componentId
(type:String.t
, default:nil
) - ID of the buganizer component within which to create a new issue. Required. -
templateId
(type:String.t
, default:nil
) - ID of the buganizer template to use. Optional. -
title
(type:String.t
, default:nil
) - Title of the issue to be created. Required.
Attributes
-
gcpProjectId
(type:String.t
, default:nil
) - Optional. The id of GCP project where the KMS key is stored. If not provided, assume the key is stored in the same GCP project defined in Client (tag 14). -
keyName
(type:String.t
, default:nil
) - A Cloud KMS key is a named object containing one or more key versions, along with metadata for the key. A key exists on exactly one key ring tied to a specific location. -
keyRingName
(type:String.t
, default:nil
) - A key ring organizes keys in a specific Google Cloud location and allows you to manage access control on groups of keys. A key ring's name does not need to be unique across a Google Cloud project, but must be unique within a given location. -
keyVersionName
(type:String.t
, default:nil
) - Optional. Each version of a key contains key material used for encryption or signing. A key's version is represented by an integer, starting at 1. To decrypt data or verify a signature, you must use the same key version that was used to encrypt or sign the data. -
locationName
(type:String.t
, default:nil
) - Location name of the key ring, e.g. "us-west1". -
serviceAccount
(type:String.t
, default:nil
) - Optional. The service account used for authentication of this KMS key. If this is not provided, the service account in Client.clientSource will be used.
Cloud Scheduler Trigger configuration
This message recursively combines constituent conditions using logical AND.
Condition that uses operator
to evaluate the key against the value.
Contains the combined condition calculation results.
Attributes
-
connectionName
(type:String.t
, default:nil
) - Connection name Format: projects/{project}/locations/{location}/connections/{connection} -
connectorVersion
(type:String.t
, default:nil
) - Connector version Format: projects/{project}/locations/{location}/providers/{provider}/connectors/{connector}/versions/{version} -
serviceName
(type:String.t
, default:nil
) - Service name Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}
Represents two-dimensional positions.
Attributes
-
postToQueueWithTriggerIdRequest
(type:GoogleApi.Integrations.V1alpha.Model.GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest.t
, default:nil
) - Request to fire an event containing the SuspensionInfo message. -
suspensionInfoEventParameterKey
(type:String.t
, default:nil
) - In the fired event, set the SuspensionInfo message as the value for this key.
An error, warning, or information message associated with a workflow.
LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus.
Contains the details of the execution info of this event: this includes the tasks execution details plus the event execution statistics. Next available id: 11
Contains the snapshot of the event execution for a given checkpoint. Next available id: 13
Attributes
-
ancestorIterationNumbers
(type:list(String.t)
, default:nil
) - Ancestor iteration number for the task(it will only be non-empty if the task is under 'private workflow') -
ancestorTaskNumbers
(type:list(String.t)
, default:nil
) - Ancestor task number for the task(it will only be non-empty if the task is under 'private workflow') -
eventAttemptNum
(type:integer()
, default:nil
) - the event attempt number this snapshot belongs to. -
integrationName
(type:String.t
, default:nil
) - The direct integration which the event execution snapshots belongs to -
taskAttemptNum
(type:integer()
, default:nil
) - the task attempt number this snapshot belongs to. Could be empty. -
taskLabel
(type:String.t
, default:nil
) - the task label associated with this snapshot. Could be empty. -
taskName
(type:String.t
, default:nil
) - the task name associated with this snapshot. Could be empty. -
taskNumber
(type:String.t
, default:nil
) - The task number associated with this snapshot. Could be empty.
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
Message that helps aggregate all sub-executions triggered by one execution and keeps track of child-parent relationships.
Represents external traffic type and id.
Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a retry_strategy
of NONE will be applied).
Information about the value and type of the field.
Field Mapping Config to map multiple output fields values from input fields values.
Attributes
-
functionType
(type:GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmEventbusProtoFunctionType.t
, default:nil
) - The name of the function to perform. -
parameters
(type:list(GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmEventbusProtoTransformExpression.t)
, default:nil
) - List of parameters required for the transformation.
Attributes
-
baseFunction
(type:GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmEventbusProtoBaseFunction.t
, default:nil
) - LINT.IfChange -
booleanArrayFunction
(type:GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmEventbusProtoBooleanArrayFunction.t
, default:nil
) - -
booleanFunction
(type:GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmEventbusProtoBooleanFunction.t
, default:nil
) - -
doubleArrayFunction
(type:GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmEventbusProtoDoubleArrayFunction.t
, default:nil
) - -
doubleFunction
(type:GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmEventbusProtoDoubleFunction.t
, default:nil
) - -
intArrayFunction
(type:GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmEventbusProtoIntArrayFunction.t
, default:nil
) - -
intFunction
(type:GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmEventbusProtoIntFunction.t
, default:nil
) - -
jsonFunction
(type:GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmEventbusProtoJsonFunction.t
, default:nil
) - LINT.ThenChange(//depot/google3/alkali/apps/integrationplatform/client/workflow_editor/utils/transform_function.ts) -
protoArrayFunction
(type:GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmEventbusProtoProtoArrayFunction.t
, default:nil
) - -
protoFunction
(type:GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmEventbusProtoProtoFunction.t
, default:nil
) - -
stringArrayFunction
(type:GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmEventbusProtoStringArrayFunction.t
, default:nil
) - -
stringFunction
(type:GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmEventbusProtoStringFunction.t
, default:nil
) -
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.
Attributes
-
currentIterationCount
(type:String.t
, default:nil
) - Starting from 1, not 0. -
currentIterationDetail
(type:String.t
, default:nil
) - Needs to be set by the loop impl class before each iteration. The abstract loop class will append the request and response to it. Eg. The foreach Loop will clean up and set it as the current iteration element at the start of each loop. The post request and response will be appended to the value once they are available. -
errorMsg
(type:String.t
, default:nil
) - Add the error message when loops fail. -
failureLocation
(type:String.t
, default:nil
) - Indicates where in the loop logic did it error out.
Mapped field is a pair of input field and output field.
The task that is next in line to be executed, if the condition specified evaluated to true.
The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching).
Represents a node identifier (type + id). Next highest id: 3
Attributes
-
buganizerNotification
(type:GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmEventbusProtoBuganizerNotification.t
, default:nil
) - -
emailAddress
(type:GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmEventbusProtoAddress.t
, default:nil
) - -
escalatorQueue
(type:String.t
, default:nil
) - -
pubsubTopic
(type:String.t
, default:nil
) - -
request
(type:GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmEventbusProtoCustomSuspensionRequest.t
, default:nil
) - If the out-of-the-box email/pubsub notifications are not suitable and custom logic is required, fire a workflow containing all info needed to notify users to resume execution.
Attributes
-
descriptivePhrase
(type:String.t
, default:nil
) - A short phrase to describe what this parameter contains. -
helpText
(type:String.t
, default:nil
) - Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter. -
hideDefaultValue
(type:boolean()
, default:nil
) - Whether the default value is hidden in the UI. -
inputDisplayOption
(type:String.t
, default:nil
) - -
isHidden
(type:boolean()
, default:nil
) - Whether this field is hidden in the UI. -
label
(type:String.t
, default:nil
) - A user-friendly label for the parameter. -
parameterNameOption
(type:String.t
, default:nil
) - -
subSectionLabel
(type:String.t
, default:nil
) - A user-friendly label for subSection under which the parameter will be displayed. -
uiPlaceholderText
(type:String.t
, default:nil
) - Placeholder text which will appear in the UI input form for this parameter.
Attributes
-
doubleRange
(type:GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleDoubleRange.t
, default:nil
) - -
intRange
(type:GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleIntRange.t
, default:nil
) - -
stringRegex
(type:GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleStringRegex.t
, default:nil
) -
Range used to validate doubles and floats.
Range used to validate longs and ints.
Rule used to validate strings.
Key-value pair of EventBus parameters.
A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified.
Entry is a pair of key and value.
Field represents either the key or value in an entry.
LINT.IfChange To support various types of parameter values. Next available id: 14
Key-value pair of EventBus property.
Attributes
-
errorMsg
(type:String.t
, default:nil
) - The error message of the failure if applicable. -
executionIds
(type:list(String.t)
, default:nil
) - The execution ids of each Subworkflow fired by this scatter. -
isSuccessful
(type:boolean()
, default:nil
) - If execution is sync, this is true if the execution passed and false if it failed. If the execution is async, this is true if the WF was fired off successfully, and false if it failed to execute. The success or failure of the subworkflows executed are not captured. -
responseParams
(type:list(GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmEventbusProtoParameterEntry.t)
, default:nil
) - A list of all the response parameters in the aggregtorMap stored with the remapped key. -
scatterElement
(type:GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmEventbusProtoParameterValueType.t
, default:nil
) - The element that was scattered for this execution.
Policy that dictates the behavior for the task after it completes successfully.
LINT.IfChange
Attributes
-
customMessage
(type:String.t
, default:nil
) - Optional information to provide recipients of the suspension in addition to the resolution URL, typically containing relevant parameter values from the originating workflow. -
notifications
(type:list(GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmEventbusProtoNotification.t)
, default:nil
) - -
suspensionExpiration
(type:GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmEventbusProtoSuspensionExpiration.t
, default:nil
) - Indicates the next steps when no external actions happen on the suspension. -
whoMayResolve
(type:list(GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmEventbusProtoSuspensionAuthPermissions.t)
, default:nil
) - Identities able to resolve this suspension.
Attributes
-
expireAfterMs
(type:integer()
, default:nil
) - Milliseconds after which the suspension expires, if no action taken. -
liftWhenExpired
(type:boolean()
, default:nil
) - Whether the suspension will be REJECTED or LIFTED upon expiration. REJECTED is the default behavior. -
remindAfterMs
(type:integer()
, default:nil
) - Milliseconds after which the previous suspension action reminder, if any, is sent using the selected notification option, for a suspension which is still PENDING_UNSPECIFIED.
Attributes
-
audit
(type:GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmEventbusProtoSuspensionResolutionInfoAudit.t
, default:nil
) - -
clientId
(type:String.t
, default:nil
) - The event data user sends as request. -
cloudKmsConfig
(type:GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmEventbusProtoCloudKmsConfig.t
, default:nil
) - KMS info, used by cmek/gmek integration -
createdTimestamp
(type:DateTime.t
, default:nil
) - Auto-generated. -
encryptedSuspensionResolutionInfo
(type:String.t
, default:nil
) - Encrypted SuspensionResolutionInfo -
eventExecutionInfoId
(type:String.t
, default:nil
) - Required. ID of the associated execution. -
externalTraffic
(type:GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmEventbusProtoExternalTraffic.t
, default:nil
) - The origin of the suspension for periodic notifications. -
lastModifiedTimestamp
(type:DateTime.t
, default:nil
) - Auto-generated. -
product
(type:String.t
, default:nil
) - Which Google product the suspension belongs to. If not set, the suspension belongs to Integration Platform by default. -
status
(type:String.t
, default:nil
) - -
suspensionConfig
(type:GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmEventbusProtoSuspensionConfig.t
, default:nil
) - -
suspensionId
(type:String.t
, default:nil
) - Primary key for the SuspensionResolutionInfoTable. -
taskNumber
(type:String.t
, default:nil
) - Required. Task number of the associated SuspensionTask. -
workflowName
(type:String.t
, default:nil
) - Required. The name of the originating workflow. -
wrappedDek
(type:String.t
, default:nil
) - Wrapped dek
Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event.
Contains the details of the execution of this task. Next available id: 11
TaskMetadata are attributes that are associated to every common Task we have.
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.
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
Task author would use this type to configure a config module.
Attributes
-
creatorEmail
(type:String.t
, default:nil
) - The creator's email address. -
name
(type:String.t
, default:nil
) - Required. Unique identifier of the teardown task within this Config. We use this field as the identifier to find next teardown tasks. -
nextTeardownTask
(type:GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmEventbusProtoNextTeardownTask.t
, default:nil
) - -
parameters
(type:GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmEventbusProtoEventParameters.t
, default:nil
) - The parameters the user can pass to this task. -
properties
(type:GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmEventbusProtoEventBusProperties.t
, default:nil
) - -
teardownTaskImplementationClassName
(type:String.t
, default:nil
) - Required. Implementation class name.
Attributes
-
initialValue
(type:GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmEventbusProtoBaseValue.t
, default:nil
) - Initial value upon which to perform transformations. -
transformationFunctions
(type:list(GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmEventbusProtoFunction.t)
, default:nil
) - Transformations to be applied sequentially.
Attributes
-
condition
(type:String.t
, default:nil
) - 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
(type:GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmEventbusProtoEventParameters.t
, default:nil
) - Optional. To be used in TaskConfig for the implementation class. -
triggerCriteriaTaskImplementationClassName
(type:String.t
, default:nil
) - Optional. Implementation class name. The class should implement the “TypedTask” interface.
Used for define type for values. Currently supported value types include int, string, double, array, and any proto message.
Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
Stats for the requested dimensions: QPS, duration, and error/warning rate
Attributes
-
clientId
(type:String.t
, default:nil
) - -
enumFilterType
(type:String.t
, default:nil
) - Whether to include or exclude the enums matching the regex. -
errorEnumString
(type:String.t
, default:nil
) - -
retryAttempt
(type:String.t
, default:nil
) - -
taskName
(type:String.t
, default:nil
) - -
taskNumber
(type:String.t
, default:nil
) - -
triggerId
(type:String.t
, default:nil
) - Stats have been or will be aggregated on set fields for any semantically-meaningful combination. -
warningEnumString
(type:String.t
, default:nil
) - -
workflowId
(type:String.t
, default:nil
) - -
workflowName
(type:String.t
, default:nil
) -
Contains the details of the execution info of this event: this includes the tasks execution details plus the event execution statistics. Next available id: 11
Contains all the execution details for a workflow instance. Next available id: 24
Attributes
-
checkpointTaskNumber
(type:String.t
, default:nil
) - Indicates "right after which checkpoint task's execution" this snapshot is taken. -
conditionResults
(type:list(GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmEventbusProtoConditionResult.t)
, default:nil
) - All of the computed conditions that been calculated. -
diffParams
(type:GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmFrontendsEventbusProtoEventParameters.t
, default:nil
) - The parameters in Event object that differs from last snapshot. -
eventExecutionInfoId
(type:String.t
, default:nil
) - Points to the event execution info this snapshot belongs to. -
eventExecutionSnapshotId
(type:String.t
, default:nil
) - Auto-generated. Used as primary key for EventExecutionSnapshots table. -
eventExecutionSnapshotMetadata
(type:GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata.t
, default:nil
) - -
eventParams
(type:GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmFrontendsEventbusProtoEventParameters.t
, default:nil
) - The parameters in Event object. -
snapshotTime
(type:String.t
, default:nil
) - Indicates when this snapshot is taken. -
taskExecutionDetails
(type:list(GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmEventbusProtoTaskExecutionDetails.t)
, default:nil
) - All of the task execution details at the given point of time. -
taskName
(type:String.t
, default:nil
) - The task name associated with this snapshot. Could be empty.
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
Key-value pair of EventBus task parameters. Next id: 13
Key-value pair of EventBus parameters.
A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified.
Entry is a pair of key and value.
Field represents either the key or value in an entry.
To support various types of parameter values. Next available id: 14
Next available id: 4
The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.
Contains a task's metadata and associated information. Next available id: 7
Configuration detail of a trigger. Next available id: 20
Attributes
-
attributes
(type:GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmEventbusProtoAttributes.t
, default:nil
) - Metadata information about the parameters. -
children
(type:list(GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry.t)
, default:nil
) - Child parameters nested within this parameter. This field only applies to protobuf parameters -
containsLargeData
(type:boolean()
, default:nil
) - Indicates whether this variable contains large data and need to be uploaded to Cloud Storage. -
dataType
(type:String.t
, default:nil
) - The data type of the parameter. -
defaultValue
(type:GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmFrontendsEventbusProtoParameterValueType.t
, default:nil
) - Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object. -
description
(type:String.t
, default:nil
) - Optional. The description about the parameter -
inOutType
(type:String.t
, default:nil
) - Specifies the input/output type for the parameter. -
isTransient
(type:boolean()
, default:nil
) - Whether this parameter is a transient parameter. -
jsonSchema
(type:String.t
, default:nil
) - This schema will be used to validate runtime JSON-typed values of this parameter. -
key
(type:String.t
, default:nil
) - 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
(type:String.t
, default:nil
) - 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". -
producedBy
(type:GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmEventbusProtoNodeIdentifier.t
, default:nil
) - The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param. -
producer
(type:String.t
, default:nil
) - -
protoDefName
(type:String.t
, default:nil
) - The name of the protobuf type if the parameter has a protobuf data type. -
protoDefPath
(type:String.t
, default:nil
) - If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry". -
required
(type:boolean()
, default:nil
) -
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.
Describes string and array limits when writing to logs. When a limit is exceeded the shortener_type describes how to shorten the field. next_id: 6
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
AuthConfig defines details of a authentication type.
Parameters to support Oauth 2.0 Auth Code Grant Authentication. See https://www.rfc-editor.org/rfc/rfc6749#section-1.3.1 for more details.
Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details.
Parameters to support JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant based authentication. See https://tools.ietf.org/html/rfc7523 for more details.
JWT claims used for the jwt-bearer authorization grant.
Parameters to support Ssh public key Authentication.
Parameters to support Username and Password Authentication.
ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
Connection represents an instance of connector.
ConnectionStatus indicates the state of the connection.
This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version
Attributes
-
host
(type:String.t
, default:nil
) - For publicly routable host. -
port
(type:integer()
, default:nil
) - The port is the target port number that is accepted by the destination. -
serviceAttachment
(type:String.t
, default:nil
) - PSC service attachments. Format: projects//regions//serviceAttachments/*
Define the Connectors target endpoint.
Encryption Key value.
Eventing Configuration of a connection
Dead Letter configuration details provided by the user.
Eventing runtime data has the details related to eventing managed by the system.
WebhookData has details of webhook configuration.
EventingStatus indicates the state of eventing.
Autoscaling config for connector deployment system metrics.
Determines whether or no a connection is locked. If locked, a reason must be specified.
Log configuration for the connection.
Node configuration for the connection.
Resource limits defined for connection pods of a given connector type.
Resource requests defined for connection pods of a given connector type.
Secret provides a reference to entries in Secret Manager.
SSL Configuration of a connection
The access token represents the authorization of a specific application to access specific parts of a user’s data.
Status for the execution attempt.
The AuthConfig resource use to hold channels and connection config data.
The credentials to authenticate a user agent with a server that is put in HTTP Authorization request header.
This message only contains a field of boolean array.
Request for cancelling an execution.
Response for cancelling an execution.
The certificate definition
Contains client certificate information
Cloud Logging details for execution info
Cloud Scheduler Trigger configuration
Metadata of runtime connection schema.
Configuration detail of coordinate, it used for UI
Request for CreateAppsScriptProject rpc call.
Response for CreateAppsScriptProject rpc call.
Defines parameters for a single, canonical credential.
This message only contains a field of double number array.
Response for DownloadIntegrationVersion.
Response containing all provisioned regions for Connector Platform.
Configuration detail of a error catch task
This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Next available id: 4
The response for executing an integration.
The request for executing an integration.
The response for executing an integration.
The Execution resource contains detailed information of an individual integration execution.
Contains the details of the execution info: this includes the tasks execution details plus the event execution statistics.
Contains the snapshot of the execution for a given checkpoint.
Metadata of the execution snapshot.
Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a retry_strategy
of NONE will be applied).
Returns success or error message
This message only contains a field of integer array.
The integration definition.
Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
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.
Integration Config Parameter is defined in the integration config and are used to provide external configuration for integration. It provide information about data types of the expected parameters and provide any default values or value. They can also be used to add custom attributes.
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.
IntegrationTemplateVersion definition. An IntegrationTemplateVersion provides configurations required to construct an IntegrationVersion. It cannot be executed directly like an Integration. Users can create IntegrationTemplateVersions using Integrations. These Templates can be shared by users across GCP projects. Next available: 17
The integration version definition.
Represents JSON web token(JWT), which is a compact, URL-safe means of representing claims to be transferred between two parties, enabling the claims to be digitally signed or integrity protected.
Request for lift Suspension
Response of lift Suspense
Request for LinkAppsScriptProject rpc call.
Response for LinkAppsScriptProject rpc call.
Response to list AuthConfigs.
Response to list Certificates.
Response containing Connections listed by region.
Response for listing the integration execution data.
Response for IntegrationTemplateVersions.ListIntegrationTemplateVersions.
Response for ListIntegrationVersions.
Response for ListIntegrations.
Response for listing RuntimeActionSchemas for a specific Connection.
Response for listing RuntimeEntitySchemas for a specific Connection.
Response to list SfdcChannels.
Response to list SfdcInstances.
Response for Suspensions.ListSuspensions.
The task that is next in line to be executed, if the condition specified evaluated to true.
The OAuth Type where the client sends request with the client id and requested scopes to auth endpoint. User sees a consent screen and auth code is received at specified redirect url afterwards. The auth code is then combined with the client id and secret and sent to the token endpoint in exchange for the access and refresh token. The refresh token can be used to fetch new access tokens.
For client credentials grant, the client sends a POST request with grant_type as 'client_credentials' to the authorization server. The authorization server will respond with a JSON object containing the access token.
For resource owner credentials grant, the client will ask the user for their authorization credentials (ususally a username and password) and send a POST request to the authorization server. The authorization server will respond with a JSON object containing the access token.
A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified.
Entry is a pair of key and value.
Field represents either the key or value in an entry.
Request for PublishIntegrationVersion.
Response for PublishIntegrationVersion.
Request for [Suspensions.ResolveSuspensions].
Response for Suspensions.ResolveSuspensions.
Metadata of an action, including schemas for its inputs and outputs.
Metadata of an entity, including a schema for its properties.
The request for scheduling an integration. Next available id: 10
The response for executing an integration.
To store string representation of Integration file.
Represents the service account which can be used to generate access token for authenticating the service call.
The SfdcChannel that points to a CDC or Platform Event Channel.
The SfdcInstance resource use to hold channels and connection config data.
This message only contains a field of string array.
Policy that dictates the behavior for the task after it completes successfully.
A record representing a suspension.
Configurations for approving the Suspension.
Expiration configs for the approval request.
Contains when and by whom the suspension was resolved.
Request for TakeoverEditLock.
Response for TakeoverEditLock.
The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.
Contains the details of the execution of this task.
Configuration detail of a trigger.
Request for UnpublishIntegrationVersion.
Request for UploadIntegrationVersion.
Response for UploadIntegrationVersion.
Username and password pair.
The type of the parameter.
LINT.IfChange Use this request to post all workflows associated with a given trigger id. Next available id: 12
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }