Types overview

CrmlogErrorCode

Registered ids for errors, as "oneof" enums. Each task or logical grouping of tasks may share the same enum.
Fields
commonErrorCode

enum

(No description provided)

Enum type. Can be one of the following:
COMMON_ERROR_CODE_UNSPECIFIED (No description provided)
INVALID_CREDENTIALS (No description provided)
REQUIRED_FIELDS_MISSING (No description provided)
INVALID_FIELDS (No description provided)
BACKEND (No description provided)
GENERAL (No description provided)
INTERNAL (No description provided)
IO_ERROR (No description provided)
NOT_FOUND (No description provided)
EVENT_BUS (No description provided)
ALREADY_EXISTS (No description provided)
CONCORD (No description provided)
CONVERSION (No description provided)
FLUME (No description provided)
PERMISSION (No description provided)
SALES_FORCE (No description provided)
SPANNER (No description provided)
UNIMPLEMENTED (No description provided)
RELTIO (No description provided)
WORKFLOW_NOT_FOUND (No description provided)
QUOTA_THROTTLED (No description provided)
QUOTA_ENQUEUED (No description provided)
INVALID_QUOTA_CONFIGURATION (No description provided)
TASK_NOT_FOUND (No description provided)
EXECUTION_TIMEOUT (No description provided)
INVALID_EVENT_EXECUTION_STATE (No description provided)
INVALID_ATTRIBUTE (No description provided)
MISSING_ATTRIBUTE (No description provided)
CLIENT_UNAUTHORIZED_FOR_WORKFLOW (No description provided)
INVALID_PARAMETER (No description provided)
MISSING_PARAMETER (No description provided)
UNAUTHROIZED_WORKFLOW_EDITOR_ACTION (No description provided)
FAILED_PRECONDITION (No description provided)
INVALID_CLIENT (No description provided)
MISSING_CLIENT (No description provided)
INVALID_WORKFLOW (No description provided)
MISSING_QUOTA_CONFIGURATION (No description provided)
UNHANDLED_TASK_ERROR (No description provided)
SCRIPT_TASK_RUNTIME_ERROR (No description provided)
RPC (No description provided)
INVALID_PROTO (No description provided)
UNHANDLED_EVENTBUS_ERROR (No description provided)
INVALID_TASK_STATE (No description provided)
TYPED_TASK_INVALID_INPUT_OPERATION (No description provided)
TYPED_TASK_INVALID_OUTPUT_OPERATION (No description provided)
VALIDATION_ERROR (No description provided)
RESUME_ERROR (No description provided)
APPS_SCRIPT_EXECUTION_ERROR (No description provided)
INVALID_VECTOR_USER (No description provided)
INFORMATICA (No description provided)
RETRYABLE_TASK_ERROR (No description provided)
INVALID_TENANT (No description provided)
WRONG_TENANT (No description provided)
INFORMATICA_BACKEND_UNAVAILABLE (No description provided)
RPC_PERMISSION_DENIED (No description provided)
SYNC_EVENTBUS_EXECUTION_TIMEOUT SYNC_EVENTBUS_EXECUTION_TIMEOUT is for eventbus internal use only.
ASYNC_EVENTBUS_EXECUTION_TIMEOUT ASYNC_EVENTBUS_EXECUTION_TIMEOUT is for eventbus internal use only. This error will be counted as server availability error.
NOT_SUPPORTED_DATA_TYPE (No description provided)
UNSANITIZED_USER_INPUT (No description provided)
TRANSFORM_EXPRESSION_EVALUATION_ERROR (No description provided)
HTTP_EXCEPTION (No description provided)
EXECUTION_CANCELLED (No description provided)

EnterpriseCrmCardsCellValue

(No description provided)
Fields
booleanValue

boolean

(No description provided)

doubleValue

number (double format)

(No description provided)

empty

object (GoogleProtobufEmpty)

(No description provided)

longValue

string (int64 format)

(No description provided)

stringValue

string

(No description provided)

EnterpriseCrmCardsRow

(No description provided)
Fields
cells[]

object (EnterpriseCrmCardsCellValue)

Ordered list of cell values within a row.

EnterpriseCrmCardsTabularData

The generic data format returned from all connectors.
Fields
headers[]

string

Ordered list of column headers.

rows[]

object (EnterpriseCrmCardsRow)

Ordered list of table rows.

EnterpriseCrmCardsTemplatesAplosSeriesData

Data used to render an Aplos Series card.
Fields
rows[]

object (EnterpriseCrmCardsTemplatesAplosSeriesDataRow)

A single Series Row

EnterpriseCrmCardsTemplatesAplosSeriesDataRow

Aplos series row is exactly two columns labeled x and y.
Fields
x

object (EnterpriseCrmCardsCellValue)

(No description provided)

y

object (EnterpriseCrmCardsCellValue)

(No description provided)

EnterpriseCrmCardsTemplatesAplosSeriesListData

Data used for Aplos charts that accept multiple Series.
Fields
series[]

object (EnterpriseCrmCardsTemplatesAplosSeriesListDataSeries)

(No description provided)

EnterpriseCrmCardsTemplatesAplosSeriesListDataSeries

(No description provided)
Fields
data

object (EnterpriseCrmCardsTemplatesAplosSeriesData)

(No description provided)

name

string

(No description provided)

EnterpriseCrmEventbusAuthconfigAuthConfigTaskParam

(No description provided)
Fields
allowedCredentialTypes[]

string

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

boolean

(No description provided)

authConfigId

string

UUID of the AuthConfig.

scope

string

A space-delimited list of requested scope permissions.

useServiceAccountInContext

boolean

(No description provided)

EnterpriseCrmEventbusProtoAddress

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.
Fields
email

string

Required.

name

string

(No description provided)

tokens[]

object (EnterpriseCrmEventbusProtoToken)

(No description provided)

EnterpriseCrmEventbusProtoAttributes

Attributes are additional options that can be associated with each event property. Next available: 8
Fields
dataType

enum

Things like URL, Email, Currency, Timestamp (rather than string, int64...)

Enum type. Can be one of the following:
DATA_TYPE_UNSPECIFIED (No description provided)
EMAIL (No description provided)
URL (No description provided)
CURRENCY (No description provided)
TIMESTAMP (No description provided)
DOMAIN_NAME Domain is a web url string with one top-level private domain and a suffix (for example: google.com, walmart.com)
defaultValue

object (EnterpriseCrmEventbusProtoValueType)

Used to define defaults.

isRequired

boolean

Required for event execution. The validation will be done by the event bus when the event is triggered.

isSearchable

boolean

Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable.

logSettings

object (EnterpriseCrmEventbusProtoLogSettings)

(No description provided)

searchable

enum

(No description provided)

Enum type. Can be one of the following:
UNSPECIFIED (No description provided)
YES If yes, the parameter key and value will be full-text indexed. In a proto, this value will propagate to all children whose searchable is unspecified.
NO If no, the parameter key and value will not be full-text indexed. In a proto, this value will propagate to all children whose searchable is unspecified.
taskVisibility[]

string

List of tasks that can view this property, if empty then all.

EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList

List of error enums for alerts.
Fields
enumStrings[]

string

(No description provided)

filterType

enum

(No description provided)

Enum type. Can be one of the following:
DEFAULT_INCLUSIVE (No description provided)
EXCLUSIVE (No description provided)

EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue

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.
Fields
absolute

string (int64 format)

(No description provided)

percentage

integer (int32 format)

(No description provided)

EnterpriseCrmEventbusProtoBaseFunction

(No description provided)
Fields
functionName

enum

(No description provided)

Enum type. Can be one of the following:
UNSPECIFIED (No description provided)
NOW_IN_MILLIS (No description provided)
INT_LIST (No description provided)
ENVIRONMENT (No description provided)
GET_EXECUTION_ID (No description provided)
GET_INTEGRATION_NAME (No description provided)
GET_REGION (No description provided)
GET_UUID (No description provided)
GET_PROJECT_ID (No description provided)

EnterpriseCrmEventbusProtoBaseValue

(No description provided)
Fields
baseFunction

object (EnterpriseCrmEventbusProtoFunction)

Start with a function that does not build on existing values. Eg. CurrentTime, Min, Max, Exists, etc.

literalValue

object (EnterpriseCrmEventbusProtoParameterValueType)

Start with a literal value.

referenceValue

string

Start with a reference value to dereference.

EnterpriseCrmEventbusProtoBooleanArrayFunction

(No description provided)
Fields
functionName

enum

(No description provided)

Enum type. Can be one of the following:
UNSPECIFIED (No description provided)
GET (No description provided)
APPEND (No description provided)
SIZE (No description provided)
TO_SET (No description provided)
APPEND_ALL (No description provided)
TO_JSON (No description provided)
SET (No description provided)
REMOVE (No description provided)
REMOVE_AT (No description provided)
CONTAINS (No description provided)
FOR_EACH (No description provided)
FILTER (No description provided)

EnterpriseCrmEventbusProtoBooleanFunction

(No description provided)
Fields
functionName

enum

(No description provided)

Enum type. Can be one of the following:
UNSPECIFIED (No description provided)
TO_JSON (No description provided)
NOT (No description provided)
AND (No description provided)
NAND (No description provided)
OR (No description provided)
XOR (No description provided)
NOR (No description provided)
XNOR (No description provided)
TO_STRING (No description provided)
EQUALS (No description provided)

EnterpriseCrmEventbusProtoBooleanParameterArray

(No description provided)
Fields
booleanValues[]

boolean

(No description provided)

EnterpriseCrmEventbusProtoBuganizerNotification

(No description provided)
Fields
assigneeEmailAddress

string

Whom to assign the new bug. Optional.

componentId

string (int64 format)

ID of the buganizer component within which to create a new issue. Required.

templateId

string (int64 format)

ID of the buganizer template to use. Optional.

title

string

Title of the issue to be created. Required.

EnterpriseCrmEventbusProtoCloudSchedulerConfig

Cloud Scheduler Trigger configuration
Fields
cronTab

string

Required. The cron tab of cloud scheduler trigger.

errorMessage

string

Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations

location

string

Required. The location where associated cloud scheduler job will be created

serviceAccountEmail

string

Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time

EnterpriseCrmEventbusProtoCombinedCondition

This message recursively combines constituent conditions using logical AND.
Fields
conditions[]

object (EnterpriseCrmEventbusProtoCondition)

A set of individual constituent conditions.

EnterpriseCrmEventbusProtoCondition

Condition that uses operator to evaluate the key against the value.
Fields
eventPropertyKey

string

Key that's evaluated against the value. Please note the data type of the runtime value associated with the key should match the data type of value, else an IllegalArgumentException is thrown.

operator

enum

Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.

Enum type. Can be one of the following:
UNSET (No description provided)
EQUALS (No description provided)
CONTAINS (No description provided)
LESS_THAN (No description provided)
GREATER_THAN (No description provided)
EXISTS (No description provided)
DOES_NOT_EXIST (No description provided)
IS_EMPTY (No description provided)
IS_NOT_EMPTY (No description provided)
value

object (EnterpriseCrmEventbusProtoValueType)

Value that's checked for the key.

EnterpriseCrmEventbusProtoConditionResult

Contains the combined condition calculation results.
Fields
currentTaskNumber

string

the current task number.

nextTaskNumber

string

the next task number.

result

boolean

the result comes out after evaluate the combined condition. True if there's no combined condition specified.

EnterpriseCrmEventbusProtoConnectorsConnection

(No description provided)
Fields
connectionName

string

Connection name Format: projects/{project}/locations/{location}/connections/{connection}

connectorVersion

string

Connector version Format: projects/{project}/locations/{location}/providers/{provider}/connectors/{connector}/versions/{version}

serviceName

string

Service name Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}

EnterpriseCrmEventbusProtoConnectorsGenericConnectorTaskConfig

(No description provided)
Fields
connection

object (EnterpriseCrmEventbusProtoConnectorsConnection)

User-selected connection.

operation

enum

Operation to perform using the configured connection.

Enum type. Can be one of the following:
OPERATION_UNSPECIFIED (No description provided)
EXECUTE_ACTION (No description provided)
LIST_ENTITIES (No description provided)
GET_ENTITY (No description provided)
CREATE_ENTITY (No description provided)
UPDATE_ENTITY (No description provided)
DELETE_ENTITY (No description provided)

EnterpriseCrmEventbusProtoCoordinate

Represents two-dimensional positions.
Fields
x

integer (int32 format)

(No description provided)

y

integer (int32 format)

(No description provided)

EnterpriseCrmEventbusProtoCustomSuspensionRequest

(No description provided)
Fields
postToQueueWithTriggerIdRequest

object (GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest)

Request to fire an event containing the SuspensionInfo message.

suspensionInfoEventParameterKey

string

In the fired event, set the SuspensionInfo message as the value for this key.

EnterpriseCrmEventbusProtoDoubleArray

(No description provided)
Fields
values[]

number (double format)

(No description provided)

EnterpriseCrmEventbusProtoDoubleArrayFunction

(No description provided)
Fields
functionName

enum

(No description provided)

Enum type. Can be one of the following:
UNSPECIFIED (No description provided)
GET (No description provided)
APPEND (No description provided)
SIZE (No description provided)
SUM (No description provided)
AVG (No description provided)
MAX (No description provided)
MIN (No description provided)
TO_SET (No description provided)
APPEND_ALL (No description provided)
TO_JSON (No description provided)
SET (No description provided)
REMOVE (No description provided)
REMOVE_AT (No description provided)
CONTAINS (No description provided)
FOR_EACH (No description provided)
FILTER (No description provided)

EnterpriseCrmEventbusProtoDoubleFunction

(No description provided)
Fields
functionName

enum

(No description provided)

Enum type. Can be one of the following:
UNSPECIFIED (No description provided)
TO_JSON (No description provided)
TO_STRING (No description provided)
ADD (No description provided)
SUBTRACT (No description provided)
MULTIPLY (No description provided)
DIVIDE (No description provided)
EXPONENT (No description provided)
ROUND (No description provided)
FLOOR (No description provided)
CEIL (No description provided)
GREATER_THAN (No description provided)
LESS_THAN (No description provided)
EQUALS (No description provided)
GREATER_THAN_EQUALS (No description provided)
LESS_THAN_EQUALS (No description provided)
MOD (No description provided)

EnterpriseCrmEventbusProtoDoubleParameterArray

(No description provided)
Fields
doubleValues[]

number (double format)

(No description provided)

EnterpriseCrmEventbusProtoErrorDetail

An error, warning, or information message associated with a workflow.
Fields
errorCode

object (CrmlogErrorCode)

The associated error-code, which can be a common or internal code.

errorMessage

string

The full text of the error message, including any parameters that were thrown along with the exception.

severity

enum

The severity of the error: ERROR|WARN|INFO.

Enum type. Can be one of the following:
SEVERITY_UNSPECIFIED (No description provided)
ERROR (No description provided)
WARN (No description provided)
INFO (No description provided)
taskNumber

integer (int32 format)

The task try-number, in which, the error occurred. If zero, the error happened at the event level.

EnterpriseCrmEventbusProtoEventBusProperties

LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus.
Fields
properties[]

object (EnterpriseCrmEventbusProtoPropertyEntry)

An unordered list of property entries.

EnterpriseCrmEventbusProtoEventExecutionDetails

Contains the details of the execution info of this event: this includes the tasks execution details plus the event execution statistics. Next available id: 10
Fields
eventAttemptStats[]

object (EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats)

(No description provided)

eventExecutionSnapshot[]

object (EnterpriseCrmEventbusProtoEventExecutionSnapshot)

(No description provided)

eventExecutionState

enum

(No description provided)

Enum type. Can be one of the following:
UNSPECIFIED (No description provided)
ON_HOLD Event is received and waiting for the execution. This happens when firing the event via "postToQueue" or "schedule".
IN_PROCESS Event is under processing.
SUCCEEDED Event execution successfully finished. There's no more change after this state.
FAILED Event execution failed. There's no more change after this state.
CANCELED Event execution canceled by user. There's no more change after this state.
RETRY_ON_HOLD Event execution failed and waiting for retry.
SUSPENDED Event execution suspended and waiting for manual intervention.
eventRetriesFromBeginningCount

integer (int32 format)

Indicates the number of times the execution has restarted from the beginning.

logFilePath

string

The log file path (aka. cns address) for this event.

networkAddress

string

The network address (aka. bns address) that indicates where the event executor is running.

nextExecutionTime

string (int64 format)

Next scheduled execution time in case the execution status was RETRY_ON_HOLD.

ryeLockUnheldCount

integer (int32 format)

Used internally and shouldn't be exposed to users. A counter for the cron job to record how many times this event is in in_process state but don't have a lock consecutively/

EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats

(No description provided)
Fields
endTime

string (int64 format)

The end time of the event execution for current attempt.

startTime

string (int64 format)

The start time of the event execution for current attempt. This could be in the future if it's been scheduled.

EnterpriseCrmEventbusProtoEventExecutionSnapshot

Contains the snapshot of the event execution for a given checkpoint. Next available id: 13
Fields
checkpointTaskNumber

string

Indicates "right after which checkpoint task's execution" this snapshot is taken.

conditionResults[]

object (EnterpriseCrmEventbusProtoConditionResult)

All of the computed conditions that been calculated.

diffParams

object (EnterpriseCrmEventbusProtoEventParameters)

The parameters in Event object that differs from last snapshot.

eventExecutionInfoId

string

Points to the event execution info this snapshot belongs to.

eventExecutionSnapshotId

string

Auto-generated. Used as primary key for EventExecutionSnapshots table.

eventExecutionSnapshotMetadata

object (EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata)

(No description provided)

eventParams

object (EnterpriseCrmEventbusProtoEventParameters)

The parameters in Event object.

exceedMaxSize

boolean

indicate whether snapshot exceeded maximum size before clean up

snapshotTime

string (int64 format)

Indicates when this snapshot is taken.

taskExecutionDetails[]

object (EnterpriseCrmEventbusProtoTaskExecutionDetails)

All of the task execution details at the given point of time.

taskName

string

The task name associated with this snapshot. Could be empty.

EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata

(No description provided)
Fields
eventAttemptNum

integer (int32 format)

the event attempt number this snapshot belongs to.

taskAttemptNum

integer (int32 format)

the task attempt number this snapshot belongs to. Could be empty.

taskName

string

the task name associated with this snapshot. Could be empty.

taskNumber

string

The task number associated with this snapshot. Could be empty.

EnterpriseCrmEventbusProtoEventParameters

LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Next id: 4
Fields
parameters[]

object (EnterpriseCrmEventbusProtoParameterEntry)

Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.

EnterpriseCrmEventbusProtoExecutionTraceInfo

Message that helps aggregate all sub-executions triggered by one execution and keeps track of child-parent relationships.
Fields
parentEventExecutionInfoId

string

Parent event execution info id that triggers the current execution through SubWorkflowExecutorTask.

traceId

string

Used to aggregate ExecutionTraceInfo.

EnterpriseCrmEventbusProtoExternalTraffic

Represents external traffic type and id.
Fields
gcpProjectId

string

User’s GCP project id the traffic is referring to.

gcpProjectNumber

string

User’s GCP project number the traffic is referring to.

location

string

Location for the user's request.

source

enum

LINT.ThenChange(//depot/google3/enterprise/crm/eventbus/proto/product.proto:product, //depot/google3/java/com/google/enterprise/crm/integrationplatform/api/utils/ConverterUtils.java:source_to_product)

Enum type. Can be one of the following:
SOURCE_UNSPECIFIED (No description provided)
APIGEE (No description provided)
SECURITY (No description provided)

EnterpriseCrmEventbusProtoFailurePolicy

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).
Fields
intervalInSeconds

string (int64 format)

Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.

maxNumRetries

integer (int32 format)

Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.

retryStrategy

enum

Defines what happens to the task upon failure.

Enum type. Can be one of the following:
UNSPECIFIED (No description provided)
IGNORE Ignores the failure of this task. The rest of the workflow will be executed Assuming this task succeeded.
NONE Causes a permanent failure of the task. However, if the last task(s) of event was successfully completed despite the failure of this task, it has no impact on the workflow.
FATAL Causes a permanent failure of the event. It is different from NONE because this will mark the event as FAILED by shutting down the event execution.
FIXED_INTERVAL The task will be retried from the failed task onwards after a fixed delay. A max-retry count is required to be specified with this strategy. A jitter is added to each exponential interval so that concurrently failing tasks of the same type do not end up retrying after the exact same exponential interval. Max_num_retries and interval_in_seconds must be specified.
LINEAR_BACKOFF The task will be retried from the failed task onwards after a fixed delay that linearly increases with each retry attempt. A jitter is added to each exponential interval so that concurrently failing tasks of the same type do not end up retrying after the exact same exponential interval. A max-retry count is required to be specified with this strategy. Max_num_retries and interval_in_seconds must be specified.
EXPONENTIAL_BACKOFF The task will be retried after an exponentially increasing period of time with each failure. A jitter is added to each exponential interval so that concurrently failing tasks of the same type do not end up retrying after the exact same exponential interval. A max-retry count is required to be specified with this strategy. max_num_retries and interval_in_seconds must be specified.
RESTART_WORKFLOW_WITH_BACKOFF The entire workflow will be restarted with the initial parameters that were set when the event was fired. A max-retry count is required to be specified with this strategy. max_num_retries and interval_in_seconds must be specified.

EnterpriseCrmEventbusProtoField

Information about the value and type of the field. Next Id: 8
Fields
cardinality

enum

By default, if the cardinality is unspecified the field is considered required while mapping.

Enum type. Can be one of the following:
UNSPECIFIED For fields with unspecified cardinality.
OPTIONAL If field cardinality is set to optional, ignore errors if input field value is null or the reference_key is not found.
defaultValue

object (EnterpriseCrmEventbusProtoParameterValueType)

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

enum

Specifies the data type of the field.

Enum type. Can be one of the following:
DATA_TYPE_UNSPECIFIED (No description provided)
STRING_VALUE (No description provided)
INT_VALUE (No description provided)
DOUBLE_VALUE (No description provided)
BOOLEAN_VALUE (No description provided)
PROTO_VALUE (No description provided)
SERIALIZED_OBJECT_VALUE (No description provided)
STRING_ARRAY (No description provided)
INT_ARRAY (No description provided)
DOUBLE_ARRAY (No description provided)
PROTO_ARRAY (No description provided)
PROTO_ENUM (No description provided)
BOOLEAN_ARRAY (No description provided)
PROTO_ENUM_ARRAY (No description provided)
BYTES BYTES and BYTES_ARRAY data types are not allowed for top-level params. They're only meant to support protobufs with BYTES (sub)fields.
BYTES_ARRAY (No description provided)
NON_SERIALIZABLE_OBJECT (No description provided)
JSON_VALUE (No description provided)
protoDefPath

string

Optional. The fully qualified proto name (e.g. enterprise.crm.storage.Account). Required for output field of type PROTO_VALUE or PROTO_ARRAY. For e.g., if input field_type is BYTES and output field_type is PROTO_VALUE, then fully qualified proto type url should be provided to parse the input bytes. If field_type is *_ARRAY, then all the converted protos are of the same type.

referenceKey

string

This holds the reference key of the workflow or task parameter. 1. Any workflow parameter, for e.g. $workflowParam1$. 2. Any task input or output parameter, for e.g. $task1_param1$. 3. Any workflow or task parameters with subfield references, for e.g., $task1_param1.employee.id$

transformExpression

object (EnterpriseCrmEventbusProtoTransformExpression)

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.

EnterpriseCrmEventbusProtoFieldMappingConfig

Field Mapping Config to map multiple output fields values from input fields values. Next id: 2
Fields
mappedFields[]

object (EnterpriseCrmEventbusProtoMappedField)

(No description provided)

EnterpriseCrmEventbusProtoFunction

(No description provided)
Fields
functionType

object (EnterpriseCrmEventbusProtoFunctionType)

The name of the function to perform.

parameters[]

object (EnterpriseCrmEventbusProtoTransformExpression)

List of parameters required for the transformation.

EnterpriseCrmEventbusProtoFunctionType

(No description provided)
Fields
baseFunction

object (EnterpriseCrmEventbusProtoBaseFunction)

LINT.IfChange

booleanArrayFunction

object (EnterpriseCrmEventbusProtoBooleanArrayFunction)

(No description provided)

booleanFunction

object (EnterpriseCrmEventbusProtoBooleanFunction)

(No description provided)

doubleArrayFunction

object (EnterpriseCrmEventbusProtoDoubleArrayFunction)

(No description provided)

doubleFunction

object (EnterpriseCrmEventbusProtoDoubleFunction)

(No description provided)

intArrayFunction

object (EnterpriseCrmEventbusProtoIntArrayFunction)

(No description provided)

intFunction

object (EnterpriseCrmEventbusProtoIntFunction)

(No description provided)

jsonFunction

object (EnterpriseCrmEventbusProtoJsonFunction)

LINT.ThenChange(//depot/google3/alkali/apps/integrationplatform/client/workflow_editor/utils/transform_function.ts)

protoArrayFunction

object (EnterpriseCrmEventbusProtoProtoArrayFunction)

(No description provided)

protoFunction

object (EnterpriseCrmEventbusProtoProtoFunction)

(No description provided)

stringArrayFunction

object (EnterpriseCrmEventbusProtoStringArrayFunction)

(No description provided)

stringFunction

object (EnterpriseCrmEventbusProtoStringFunction)

(No description provided)

EnterpriseCrmEventbusProtoIntArray

(No description provided)
Fields
values[]

string (int64 format)

(No description provided)

EnterpriseCrmEventbusProtoIntArrayFunction

(No description provided)
Fields
functionName

enum

(No description provided)

Enum type. Can be one of the following:
UNSPECIFIED (No description provided)
GET (No description provided)
APPEND (No description provided)
SIZE (No description provided)
SUM (No description provided)
AVG (No description provided)
MAX (No description provided)
MIN (No description provided)
TO_SET (No description provided)
APPEND_ALL (No description provided)
TO_JSON (No description provided)
SET (No description provided)
REMOVE (No description provided)
REMOVE_AT (No description provided)
CONTAINS (No description provided)
FOR_EACH (No description provided)
FILTER (No description provided)

EnterpriseCrmEventbusProtoIntFunction

(No description provided)
Fields
functionName

enum

(No description provided)

Enum type. Can be one of the following:
UNSPECIFIED (No description provided)
ADD (No description provided)
SUBTRACT (No description provided)
MULTIPLY (No description provided)
DIVIDE (No description provided)
EXPONENT (No description provided)
GREATER_THAN_EQUAL_TO (No description provided)
GREATER_THAN (No description provided)
LESS_THAN_EQUAL_TO (No description provided)
LESS_THAN (No description provided)
TO_DOUBLE (No description provided)
TO_STRING (No description provided)
EQUALS (No description provided)
TO_JSON (No description provided)
MOD (No description provided)
EPOCH_TO_HUMAN_READABLE_TIME (No description provided)

EnterpriseCrmEventbusProtoIntParameterArray

(No description provided)
Fields
intValues[]

string (int64 format)

(No description provided)

EnterpriseCrmEventbusProtoJsonFunction

(No description provided)
Fields
functionName

enum

(No description provided)

Enum type. Can be one of the following:
UNSPECIFIED (No description provided)
GET_PROPERTY (No description provided)
GET_ELEMENT (No description provided)
APPEND_ELEMENT (No description provided)
SIZE (No description provided)
SET_PROPERTY (No description provided)
FLATTEN (No description provided)
FLATTEN_ONCE (No description provided)
MERGE (No description provided)
TO_STRING (No description provided)
TO_INT (No description provided)
TO_DOUBLE (No description provided)
TO_BOOLEAN (No description provided)
TO_PROTO (No description provided)
TO_STRING_ARRAY (No description provided)
TO_INT_ARRAY (No description provided)
TO_DOUBLE_ARRAY (No description provided)
TO_PROTO_ARRAY (No description provided)
TO_BOOLEAN_ARRAY (No description provided)
REMOVE_PROPERTY (No description provided)
RESOLVE_TEMPLATE (No description provided)
EQUALS (No description provided)
FOR_EACH (No description provided)
FILTER_ELEMENTS next id: 24

EnterpriseCrmEventbusProtoLogSettings

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.
Fields
logFieldName

string

The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key.

sanitizeOptions

object (EnterpriseCrmLoggingGwsSanitizeOptions)

Contains the scrubbing options, such as whether to scrub, obfuscate, etc.

seedPeriod

enum

(No description provided)

Enum type. Can be one of the following:
SEED_PERIOD_UNSPECIFIED (No description provided)
DAY Sanitized values remain constant for the day of the event.
WEEK Sanitized values remain constant for the week of the event; may cross month boundaries.
MONTH Sanitized values remain constant for the month of the event.
seedScope

enum

(No description provided)

Enum type. Can be one of the following:
SEED_SCOPE_UNSPECIFIED (No description provided)
EVENT_NAME Hash computations include the event name.
TIME_PERIOD Hash computations include a time period.
PARAM_NAME Hash computations include the param name.
shorteningLimits

object (EnterpriseCrmLoggingGwsFieldLimits)

Contains the field limits for shortening, such as max string length and max array length.

EnterpriseCrmEventbusProtoLoopMetadata

(No description provided)
Fields
currentIterationCount

string (int64 format)

Starting from 1, not 0.

currentIterationDetail

string

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

string

Add the error message when loops fail.

failureLocation

enum

Indicates where in the loop logic did it error out.

Enum type. Can be one of the following:
UNKNOWN No error or Unknown.
SUBWORKFLOW Subworkflow failed while firing/running.
PARAM_OVERRIDING Param overrides failed.
PARAM_AGGREGATING Param aggregation failed.
SETTING_ITERATION_ELEMENT Setting for loop current element failed.
GETTING_LIST_TO_ITERATE Getting the list to iterate.
CONDITION_EVALUATION Evaluating the while loop condition.
BUILDING_REQUEST Building the iteration request

EnterpriseCrmEventbusProtoMappedField

Mapped field is a pair of input field and output field. Next Id: 3
Fields
inputField

object (EnterpriseCrmEventbusProtoField)

The input field being mapped from.

outputField

object (EnterpriseCrmEventbusProtoField)

The output field being mapped to.

EnterpriseCrmEventbusProtoNextTask

The task that is next in line to be executed, if the condition specified evaluated to true.
Fields
combinedConditions[]

object (EnterpriseCrmEventbusProtoCombinedCondition)

Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use condition

condition

string

Standard filter expression for this task to become an eligible next task.

description

string

User-provided description intended to give more business context about the next task edge or condition.

label

string

User-provided label that is attached to this edge in the UI.

taskConfigId

string

ID of the next task.

taskNumber

string

Task number of the next task.

EnterpriseCrmEventbusProtoNextTeardownTask

The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching).
Fields
name

string

Required. Name of the next teardown task.

EnterpriseCrmEventbusProtoNodeIdentifier

Represents a node identifier (type + id). Next highest id: 3
Fields
elementIdentifier

string

Configuration of the edge.

elementType

enum

Destination node where the edge ends. It can only be a task config.

Enum type. Can be one of the following:
UNKNOWN_TYPE (No description provided)
TASK_CONFIG (No description provided)
TRIGGER_CONFIG (No description provided)

EnterpriseCrmEventbusProtoNotification

(No description provided)
Fields
buganizerNotification

object (EnterpriseCrmEventbusProtoBuganizerNotification)

(No description provided)

emailAddress

object (EnterpriseCrmEventbusProtoAddress)

(No description provided)

escalatorQueue

string

(No description provided)

pubsubTopic

string

(No description provided)

request

object (EnterpriseCrmEventbusProtoCustomSuspensionRequest)

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.

EnterpriseCrmEventbusProtoParamSpecEntryConfig

(No description provided)
Fields
descriptivePhrase

string

A short phrase to describe what this parameter contains.

helpText

string

Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter.

hideDefaultValue

boolean

Whether the default value is hidden in the UI.

inputDisplayOption

enum

(No description provided)

Enum type. Can be one of the following:
DEFAULT A single-line input for strings, a numeric input box for numbers, or a checkbox for booleans.
STRING_MULTI_LINE A multi-line input box for longer strings/string templates.
NUMBER_SLIDER A slider to select a numerical value. The default range is [0, 100].
BOOLEAN_TOGGLE A toggle button for boolean parameters.
isHidden

boolean

Whether this field is hidden in the UI.

label

string

A user-friendly label for the parameter.

parameterNameOption

enum

(No description provided)

Enum type. Can be one of the following:
DEFAULT_NOT_PARAMETER_NAME This field is not a parameter name.
IS_PARAMETER_NAME If this field is a string and this option is selected, the field will be interpreted as a parameter name. Users will be able to choose a variable using the autocomplete, but the name will be stored as a literal string.
KEY_IS_PARAMETER_NAME If this field is a ParameterMap and this option is selected, the map's keys will be interpreted as parameter names. Ignored if this field is not a ParameterMap.
VALUE_IS_PARAMETER_NAME If this field is a ParameterMap and this option is selected, the map's values will be interpreted as parameter names. Ignored if this field is not a ParameterMap.
subSectionLabel

string

A user-friendly label for subSection under which the parameter will be displayed.

uiPlaceholderText

string

Placeholder text which will appear in the UI input form for this parameter.

EnterpriseCrmEventbusProtoParamSpecEntryProtoDefinition

(No description provided)
Fields
fullName

string

The fully-qualified proto name. This message, for example, would be "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition".

path

string

Path to the proto file that contains the message type's definition.

EnterpriseCrmEventbusProtoParamSpecEntryValidationRule

(No description provided)
Fields
doubleRange

object (EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleDoubleRange)

(No description provided)

intRange

object (EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleIntRange)

(No description provided)

stringRegex

object (EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleStringRegex)

(No description provided)

EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleDoubleRange

Range used to validate doubles and floats.
Fields
max

number (double format)

The inclusive maximum of the acceptable range.

min

number (double format)

The inclusive minimum of the acceptable range.

EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleIntRange

Range used to validate longs and ints.
Fields
max

string (int64 format)

The inclusive maximum of the acceptable range.

min

string (int64 format)

The inclusive minimum of the acceptable range.

EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleStringRegex

Rule used to validate strings.
Fields
exclusive

boolean

Whether the regex matcher is applied exclusively (if true, matching values will be rejected).

regex

string

The regex applied to the input value(s).

EnterpriseCrmEventbusProtoParameterEntry

Key-value pair of EventBus parameters.
Fields
key

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.

value

object (EnterpriseCrmEventbusProtoParameterValueType)

Values for the defined keys. Each value can either be string, int, double or any proto message.

EnterpriseCrmEventbusProtoParameterMap

A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified.
Fields
entries[]

object (EnterpriseCrmEventbusProtoParameterMapEntry)

(No description provided)

keyType

enum

Option to specify key value type for all entries of the map. If provided then field types for all entries must conform to this.

Enum type. Can be one of the following:
DATA_TYPE_UNSPECIFIED (No description provided)
STRING_VALUE (No description provided)
INT_VALUE (No description provided)
DOUBLE_VALUE (No description provided)
BOOLEAN_VALUE (No description provided)
PROTO_VALUE (No description provided)
SERIALIZED_OBJECT_VALUE (No description provided)
STRING_ARRAY (No description provided)
INT_ARRAY (No description provided)
DOUBLE_ARRAY (No description provided)
PROTO_ARRAY (No description provided)
PROTO_ENUM (No description provided)
BOOLEAN_ARRAY (No description provided)
PROTO_ENUM_ARRAY (No description provided)
BYTES BYTES and BYTES_ARRAY data types are not allowed for top-level params. They're only meant to support protobufs with BYTES (sub)fields.
BYTES_ARRAY (No description provided)
NON_SERIALIZABLE_OBJECT (No description provided)
JSON_VALUE (No description provided)
valueType

enum

(No description provided)

Enum type. Can be one of the following:
DATA_TYPE_UNSPECIFIED (No description provided)
STRING_VALUE (No description provided)
INT_VALUE (No description provided)
DOUBLE_VALUE (No description provided)
BOOLEAN_VALUE (No description provided)
PROTO_VALUE (No description provided)
SERIALIZED_OBJECT_VALUE (No description provided)
STRING_ARRAY (No description provided)
INT_ARRAY (No description provided)
DOUBLE_ARRAY (No description provided)
PROTO_ARRAY (No description provided)
PROTO_ENUM (No description provided)
BOOLEAN_ARRAY (No description provided)
PROTO_ENUM_ARRAY (No description provided)
BYTES BYTES and BYTES_ARRAY data types are not allowed for top-level params. They're only meant to support protobufs with BYTES (sub)fields.
BYTES_ARRAY (No description provided)
NON_SERIALIZABLE_OBJECT (No description provided)
JSON_VALUE (No description provided)

EnterpriseCrmEventbusProtoParameterMapEntry

Entry is a pair of key and value.
Fields
key

object (EnterpriseCrmEventbusProtoParameterMapField)

(No description provided)

value

object (EnterpriseCrmEventbusProtoParameterMapField)

(No description provided)

EnterpriseCrmEventbusProtoParameterMapField

Field represents either the key or value in an entry.
Fields
literalValue

object (EnterpriseCrmEventbusProtoParameterValueType)

Passing a literal value.

referenceKey

string

Referencing one of the WF variables.

EnterpriseCrmEventbusProtoParameterValueType

LINT.IfChange To support various types of parameter values. Next available id: 14
Fields
booleanArray

object (EnterpriseCrmEventbusProtoBooleanParameterArray)

(No description provided)

booleanValue

boolean

(No description provided)

doubleArray

object (EnterpriseCrmEventbusProtoDoubleParameterArray)

(No description provided)

doubleValue

number (double format)

(No description provided)

intArray

object (EnterpriseCrmEventbusProtoIntParameterArray)

(No description provided)

intValue

string (int64 format)

(No description provided)

protoArray

object (EnterpriseCrmEventbusProtoProtoParameterArray)

(No description provided)

protoValue

map (key: string, value: any)

(No description provided)

serializedObjectValue

object (EnterpriseCrmEventbusProtoSerializedObjectParameter)

(No description provided)

stringArray

object (EnterpriseCrmEventbusProtoStringParameterArray)

(No description provided)

stringValue

string

(No description provided)

EnterpriseCrmEventbusProtoPropertyEntry

Key-value pair of EventBus property.
Fields
key

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.

value

object (EnterpriseCrmEventbusProtoValueType)

Values for the defined keys. Each value can either be string, int, double or any proto message.

EnterpriseCrmEventbusProtoProtoArrayFunction

(No description provided)
Fields
functionName

enum

(No description provided)

Enum type. Can be one of the following:
UNSPECIFIED (No description provided)
GET (No description provided)
APPEND (No description provided)
SIZE (No description provided)
TO_SET (No description provided)
APPEND_ALL (No description provided)
TO_JSON (No description provided)
SET (No description provided)
REMOVE (No description provided)
REMOVE_AT (No description provided)
CONTAINS (No description provided)
FOR_EACH (No description provided)
FILTER (No description provided)

EnterpriseCrmEventbusProtoProtoFunction

(No description provided)
Fields
functionName

enum

(No description provided)

Enum type. Can be one of the following:
UNSPECIFIED (No description provided)
GET_STRING_SUBFIELD (No description provided)
GET_INT_SUBFIELD (No description provided)
GET_DOUBLE_SUBFIELD (No description provided)
GET_BOOLEAN_SUBFIELD (No description provided)
GET_STRING_ARRAY_SUBFIELD (No description provided)
GET_INT_ARRAY_SUBFIELD (No description provided)
GET_DOUBLE_ARRAY_SUBFIELD (No description provided)
GET_BOOLEAN_ARRAY_SUBFIELD (No description provided)
GET_PROTO_ARRAY_SUBFIELD (No description provided)
GET_PROTO_SUBFIELD (No description provided)
TO_JSON (No description provided)
GET_BYTES_SUBFIELD_AS_UTF_8_STRING (No description provided)
GET_BYTES_SUBFIELD_AS_PROTO (No description provided)
EQUALS (No description provided)

EnterpriseCrmEventbusProtoProtoParameterArray

(No description provided)
Fields
protoValues[]

object

(No description provided)

EnterpriseCrmEventbusProtoScatterResponse

(No description provided)
Fields
errorMsg

string

The error message of the failure if applicable.

executionIds[]

string

The execution ids of each Subworkflow fired by this scatter.

isSuccessful

boolean

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[]

object (EnterpriseCrmEventbusProtoParameterEntry)

A list of all the response parameters in the aggregtorMap stored with the remapped key.

scatterElement

object (EnterpriseCrmEventbusProtoParameterValueType)

The element that was scattered for this execution.

EnterpriseCrmEventbusProtoSerializedObjectParameter

(No description provided)
Fields
objectValue

string (bytes format)

(No description provided)

EnterpriseCrmEventbusProtoStringArray

(No description provided)
Fields
values[]

string

(No description provided)

EnterpriseCrmEventbusProtoStringArrayFunction

(No description provided)
Fields
functionName

enum

(No description provided)

Enum type. Can be one of the following:
UNSPECIFIED (No description provided)
GET (No description provided)
APPEND (No description provided)
SIZE (No description provided)
TO_SET (No description provided)
APPEND_ALL (No description provided)
TO_JSON (No description provided)
SET (No description provided)
REMOVE (No description provided)
REMOVE_AT (No description provided)
CONTAINS (No description provided)
FOR_EACH (No description provided)
FILTER (No description provided)

EnterpriseCrmEventbusProtoStringFunction

(No description provided)
Fields
functionName

enum

(No description provided)

Enum type. Can be one of the following:
UNSPECIFIED (No description provided)
CONCAT (No description provided)
TO_UPPERCASE (No description provided)
TO_LOWERCASE (No description provided)
CONTAINS (No description provided)
SPLIT (No description provided)
LENGTH (No description provided)
EQUALS (No description provided)
TO_INT (No description provided)
TO_DOUBLE (No description provided)
TO_BOOLEAN (No description provided)
TO_BASE_64 (No description provided)
TO_JSON (No description provided)
EQUALS_IGNORE_CASE (No description provided)
REPLACE_ALL (No description provided)
SUBSTRING (No description provided)
RESOLVE_TEMPLATE (No description provided)

EnterpriseCrmEventbusProtoStringParameterArray

(No description provided)
Fields
stringValues[]

string

(No description provided)

EnterpriseCrmEventbusProtoSuccessPolicy

Policy that dictates the behavior for the task after it completes successfully.
Fields
finalState

enum

State to which the execution snapshot status will be set if the task succeeds.

Enum type. Can be one of the following:
UNSPECIFIED (No description provided)
SUCCEEDED The default behavior, where successful tasks will be marked as SUCCEEDED.
SUSPENDED Sets the state to SUSPENDED after executing. This is required for SuspensionTask; event execution will continue once the user calls ResolveSuspensions with the event_execution_info_id and the task number.

EnterpriseCrmEventbusProtoSuspensionAuthPermissions

LINT.IfChange
Fields
gaiaIdentity

object (EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity)

Represents a Gaia identity for a person or service account.

googleGroup

object (EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity)

(No description provided)

loasRole

string

(No description provided)

mdbGroup

string

(No description provided)

EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity

(No description provided)
Fields
emailAddress

string

(No description provided)

gaiaId

string (int64 format)

(No description provided)

EnterpriseCrmEventbusProtoSuspensionConfig

(No description provided)
Fields
customMessage

string

Optional information to provide recipients of the suspension in addition to the resolution URL, typically containing relevant parameter values from the originating workflow.

notifications[]

object (EnterpriseCrmEventbusProtoNotification)

(No description provided)

suspensionExpiration

object (EnterpriseCrmEventbusProtoSuspensionExpiration)

Indicates the next steps when no external actions happen on the suspension.

whoMayResolve[]

object (EnterpriseCrmEventbusProtoSuspensionAuthPermissions)

Identities able to resolve this suspension.

EnterpriseCrmEventbusProtoSuspensionExpiration

(No description provided)
Fields
expireAfterMs

integer (int32 format)

Milliseconds after which the suspension expires, if no action taken.

liftWhenExpired

boolean

Whether the suspension will be REJECTED or LIFTED upon expiration. REJECTED is the default behavior.

remindAfterMs

integer (int32 format)

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.

EnterpriseCrmEventbusProtoSuspensionResolutionInfo

(No description provided)
Fields
audit

object (EnterpriseCrmEventbusProtoSuspensionResolutionInfoAudit)

(No description provided)

createdTimestamp

string (Timestamp format)

Auto-generated.

eventExecutionInfoId

string

Required. ID of the associated execution.

externalTraffic

object (EnterpriseCrmEventbusProtoExternalTraffic)

The origin of the suspension for periodic notifications.

lastModifiedTimestamp

string (Timestamp format)

Auto-generated.

product

enum

Which Google product the suspension belongs to. If not set, the suspension belongs to Integration Platform by default.

Enum type. Can be one of the following:
UNSPECIFIED_PRODUCT (No description provided)
IP (No description provided)
APIGEE (No description provided)
SECURITY (No description provided)
status

enum

(No description provided)

Enum type. Can be one of the following:
PENDING_UNSPECIFIED (No description provided)
REJECTED (No description provided)
LIFTED (No description provided)
suspensionConfig

object (EnterpriseCrmEventbusProtoSuspensionConfig)

(No description provided)

suspensionId

string

Primary key for the SuspensionResolutionInfoTable.

taskNumber

string

Required. Task number of the associated SuspensionTask.

workflowName

string

Required. The name of the originating workflow.

EnterpriseCrmEventbusProtoSuspensionResolutionInfoAudit

(No description provided)
Fields
resolvedBy

string

(No description provided)

timestamp

string (Timestamp format)

(No description provided)

EnterpriseCrmEventbusProtoTaskAlertConfig

Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event.
Fields
aggregationPeriod

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

boolean

Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.

alertName

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.

clientId

string

Client associated with this alert configuration. Must be a client enabled in one of the containing workflow's triggers.

durationThresholdMs

string (int64 format)

Should be specified only for TASK_AVERAGE_DURATION and TASK_PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.

errorEnumList

object (EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList)

(No description provided)

metricType

enum

(No description provided)

Enum type. Can be one of the following:
METRIC_TYPE_UNSPECIFIED The default value. Metric type should always be set to one of the other non-default values, otherwise it will result in an INVALID_ARGUMENT error.
TASK_ERROR_RATE Specifies alerting on the rate of errors (potentially for a specific set of enum values) for the enclosing TaskConfig.
TASK_WARNING_RATE Specifies alerting on the rate of warnings (potentially for a specific set of enum values) for the enclosing TaskConfig. Warnings use the same enum values as errors.
TASK_RATE Specifies alerting on the number of instances for the enclosing TaskConfig executed in the given aggregation_period.
TASK_AVERAGE_DURATION Specifies alerting on the average duration of execution for the enclosing task.
TASK_PERCENTILE_DURATION Specifies alerting on the duration of a particular percentile of task executions. E.g. If 10% or more of the task executions have durations above 5 seconds, alert.
numAggregationPeriods

integer (int32 format)

For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.

onlyFinalAttempt

boolean

Only count final task attempts, not retries.

playbookUrl

string

Link to a playbook for resolving the issue that triggered this alert.

thresholdType

enum

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.

Enum type. Can be one of the following:
UNSPECIFIED_THRESHOLD_TYPE (No description provided)
EXPECTED_MIN Note that this field will only trigger alerts if the workflow specifying it runs at least once in 24 hours (which is our in-memory retention period for monarch streams). Also note that aggregation_period for this alert configuration must be less than 24 hours.
EXPECTED_MAX (No description provided)
thresholdValue

object (EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue)

The metric value, above or below which the alert should be triggered.

warningEnumList

object (EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList)

(No description provided)

EnterpriseCrmEventbusProtoTaskExecutionDetails

Contains the details of the execution of this task. Next available id: 11
Fields
taskAttemptStats[]

object (EnterpriseCrmEventbusProtoTaskExecutionDetailsTaskAttemptStats)

(No description provided)

taskExecutionState

enum

(No description provided)

Enum type. Can be one of the following:
UNSPECIFIED (No description provided)
PENDING_EXECUTION Task is waiting for its precondition tasks to finish to start the execution.
IN_PROCESS Task is under processing.
SUCCEED Task execution successfully finished. There's no more change after this state.
FAILED Task execution failed. There's no more change after this state.
FATAL Task execution failed and cause the whole event execution to fail immediately. There's no more change after this state.
RETRY_ON_HOLD Task execution failed and waiting for retry.
SKIPPED Task execution skipped. This happens when its precondition wasn't met, or the event execution been canceled before reach to the task. There's no more changes after this state.
CANCELED Task execution canceled when in progress. This happens when event execution been canceled or any other task fall in fatal state.
PENDING_ROLLBACK Task is waiting for its dependency tasks' rollback to finish to start its rollback.
ROLLBACK_IN_PROCESS Task is rolling back.
ROLLEDBACK Task is rolled back. This is the state we will set regardless of rollback succeeding or failing.
SUSPENDED Task is a SuspensionTask which has executed once, creating a pending suspension.
taskNumber

string

Pointer to the task config it used for execution.

EnterpriseCrmEventbusProtoTaskExecutionDetailsTaskAttemptStats

(No description provided)
Fields
endTime

string (int64 format)

The end time of the task execution for current attempt.

startTime

string (int64 format)

The start time of the task execution for current attempt. This could be in the future if it's been scheduled.

EnterpriseCrmEventbusProtoTaskMetadata

TaskMetadata are attributes that are associated to every common Task we have. Next available: 26
Fields
activeTaskName

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[]

object (EnterpriseCrmEventbusProtoTaskMetadataAdmin)

(No description provided)

category

enum

(No description provided)

Enum type. Can be one of the following:
UNSPECIFIED_CATEGORY (No description provided)
CUSTOM (No description provided)
FLOW_CONTROL (No description provided)
DATA_MANIPULATION (No description provided)
SCRIPTING (No description provided)
CONNECTOR (No description provided)
HIDDEN Internal IP tasks that should not be available in the UI.
CLOUD_SYSTEMS Tasks that are relevant to cloud systems teams and typically
CUSTOM_TASK_TEMPLATE include connecting to Vector salesforce, CRM Hub Spanner etc. Task entities that derive from a custom task template.
codeSearchLink

string

The Code Search link to the Task Java file.

defaultJsonValidationOption

enum

Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution.

Enum type. Can be one of the following:
UNSPECIFIED_JSON_VALIDATION_OPTION As per the default behavior, no validation will be run. Will not override any option set in a Task.
SKIP Do not run any validation against JSON schemas.
PRE_EXECUTION Validate all potential input JSON parameters against schemas specified in WorkflowParameters.
POST_EXECUTION Validate all potential output JSON parameters against schemas specified in WorkflowParameters.
PRE_POST_EXECUTION Perform both PRE_EXECUTION and POST_EXECUTION validations.
defaultSpec

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

string

In a few sentences, describe the purpose and usage of the task.

descriptiveName

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

string

Snippet of markdown documentation to embed in the RHP for this task.

externalCategory

enum

(No description provided)

Enum type. Can be one of the following:
UNSPECIFIED_EXTERNAL_CATEGORY (No description provided)
CORE (No description provided)
CONNECTORS (No description provided)
externalCategorySequence

integer (int32 format)

Sequence with which the task in specific category to be displayed in task discovery panel for external users.

externalDocHtml

string

External-facing documention embedded in the RHP for this task.

externalDocLink

string

Doc link for external-facing documentation (separate from g3doc).

externalDocMarkdown

string

DEPRECATED: Use external_doc_html.

g3DocLink

string

URL to the associated G3 Doc for the task if available

iconLink

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

boolean

The deprecation status of the current task. Default value is false;

name

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

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

enum

Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE.

Enum type. Can be one of the following:
UNSPECIFIED_STATUS Default value. Actual Task Status should always be set to either INACTIVE or ACTIVE. If none is specified at runtime, it will be set to INACTIVE.
DEFAULT_INACTIVE Still in-progress or incomplete, and not intended for use.
ACTIVE Available for use.
system

enum

(No description provided)

Enum type. Can be one of the following:
UNSPECIFIED_SYSTEM (No description provided)
GENERIC (No description provided)
BUGANIZER (No description provided)
SALESFORCE (No description provided)
CLOUD_SQL (No description provided)
PLX (No description provided)
SHEETS (No description provided)
GOOGLE_GROUPS (No description provided)
EMAIL (No description provided)
SPANNER (No description provided)
DATA_BRIDGE (No description provided)
tags[]

string

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.

EnterpriseCrmEventbusProtoTaskMetadataAdmin

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.
Fields
googleGroupEmail

string

(No description provided)

userEmail

string

(No description provided)

EnterpriseCrmEventbusProtoTaskUiConfig

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.
Fields
taskUiModuleConfigs[]

object (EnterpriseCrmEventbusProtoTaskUiModuleConfig)

Configurations of included config modules.

EnterpriseCrmEventbusProtoTaskUiModuleConfig

Task author would use this type to configure a config module.
Fields
moduleId

enum

ID of the config module.

Enum type. Can be one of the following:
UNSPECIFIED_TASK_MODULE Default
LABEL Supports editing label of a task config.
ERROR_HANDLING Supports editing error handling settings such as retry strategy.
TASK_PARAM_TABLE Supports adding, removing and editing task parameter values in a table with little assistance or restriction.
TASK_PARAM_FORM Supports editing values of declared input parameters of a task. Think of it as a "strongly typed" upgrade to the TASK_PARAM_TABLE.
PRECONDITION Supports editing preconditions of a task config.
SCRIPT_EDITOR Supports adding, editing, and deleting the scripts associated with a script task, as well as modifying the input/output parameters.
RPC Supports editing task parameters associated with an RPC/stubby task.
TASK_SUMMARY Contains readonly task information, including input/output type info.
SUSPENSION Configures a SuspensionTask.
RPC_TYPED Configures a GenericStubbyTypedTask.
SUB_WORKFLOW Configures a SubWorkflowExecutorTask.
APPS_SCRIPT_NAVIGATOR Supports navigating to Apps Script editor
SUB_WORKFLOW_FOR_EACH_LOOP Configures a SubWorkflowForEachLoopTask.
FIELD_MAPPING Configures a FieldMappingTask.
README Contains embedded in-product documentation for a task.
REST_CALLER UI widget for the rest caller task.
SUB_WORKFLOW_SCATTER_GATHER Configures a SubWorkflowScatterGatherTask.
CLOUD_SQL Configures a CloudSql Task.
GENERIC_CONNECTOR_TASK Configure a GenericConnectorTask.

EnterpriseCrmEventbusProtoTeardown

(No description provided)
Fields
teardownTaskConfigs[]

object (EnterpriseCrmEventbusProtoTeardownTaskConfig)

Required.

EnterpriseCrmEventbusProtoTeardownTaskConfig

(No description provided)
Fields
creatorEmail

string

The creator's email address.

name

string

Required. Unique identifier of the teardown task within this Config. We use this field as the identifier to find next teardown tasks.

nextTeardownTask

object (EnterpriseCrmEventbusProtoNextTeardownTask)

(No description provided)

parameters

object (EnterpriseCrmEventbusProtoEventParameters)

The parameters the user can pass to this task.

properties

object (EnterpriseCrmEventbusProtoEventBusProperties)

(No description provided)

teardownTaskImplementationClassName

string

Required. Implementation class name.

EnterpriseCrmEventbusProtoToken

(No description provided)
Fields
name

string

(No description provided)

value

string

(No description provided)

EnterpriseCrmEventbusProtoTransformExpression

(No description provided)
Fields
initialValue

object (EnterpriseCrmEventbusProtoBaseValue)

Initial value upon which to perform transformations.

transformationFunctions[]

object (EnterpriseCrmEventbusProtoFunction)

Transformations to be applied sequentially.

EnterpriseCrmEventbusProtoTriggerCriteria

(No description provided)
Fields
condition

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

object (EnterpriseCrmEventbusProtoEventParameters)

Optional. To be used in TaskConfig for the implementation class.

triggerCriteriaTaskImplementationClassName

string

Optional. Implementation class name. The class should implement the “TypedTask” interface.

EnterpriseCrmEventbusProtoValueType

Used for define type for values. Currently supported value types include int, string, double, array, and any proto message.
Fields
booleanValue

boolean

(No description provided)

doubleArray

object (EnterpriseCrmEventbusProtoDoubleArray)

(No description provided)

doubleValue

number (double format)

(No description provided)

intArray

object (EnterpriseCrmEventbusProtoIntArray)

(No description provided)

intValue

string (int64 format)

(No description provided)

protoValue

map (key: string, value: any)

(No description provided)

stringArray

object (EnterpriseCrmEventbusProtoStringArray)

(No description provided)

stringValue

string

(No description provided)

EnterpriseCrmEventbusProtoWorkflowAlertConfig

Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
Fields
aggregationPeriod

string

For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.

alertDisabled

boolean

Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.

alertName

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.

clientId

string

Client associated with this alert configuration.

durationThresholdMs

string (int64 format)

Should be specified only for AVERAGE_DURATION and PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.

errorEnumList

object (EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList)

(No description provided)

metricType

enum

(No description provided)

Enum type. Can be one of the following:
METRIC_TYPE_UNSPECIFIED The default value. Metric type should always be set to one of the other non-default values, otherwise it will result in an INVALID_ARGUMENT error.
EVENT_ERROR_RATE Specifies alerting on the rate of errors for the enclosing workflow.
EVENT_WARNING_RATE Specifies alerting on the rate of warnings for the enclosing workflow. Warnings use the same enum values as errors.
TASK_ERROR_RATE Specifies alerting on the rate of errors for any task in the enclosing workflow.
TASK_WARNING_RATE Specifies alerting on the rate of warnings for any task in the enclosing workflow.
TASK_RATE Specifies alerting on the rate of executions over all tasks in the enclosing workflow.
EVENT_RATE Specifies alerting on the number of events executed in the given aggregation_period.
EVENT_AVERAGE_DURATION Specifies alerting on the average duration of executions for this workflow.
EVENT_PERCENTILE_DURATION Specifies alerting on the duration value of a particular percentile of workflow executions. E.g. If 10% or more of the workflow executions have durations above 5 seconds, alert.
TASK_AVERAGE_DURATION Specifies alerting on the average duration of any task in the enclosing workflow,
TASK_PERCENTILE_DURATION Specifies alerting on the duration value of a particular percentile of any task executions within the enclosing workflow. E.g. If 10% or more of the task executions in the workflow have durations above 5 seconds, alert.
numAggregationPeriods

integer (int32 format)

For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.

onlyFinalAttempt

boolean

For either events or tasks, depending on the type of alert, count only final attempts, not retries.

playbookUrl

string

Link to a playbook for resolving the issue that triggered this alert.

thresholdType

enum

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.

Enum type. Can be one of the following:
UNSPECIFIED_THRESHOLD_TYPE (No description provided)
EXPECTED_MIN Note that this field will only trigger alerts if the workflow specifying it runs at least once in 24 hours (which is our in-memory retention period for monarch streams). Also note that aggregation_period for this alert configuration must be less than 24 hours.
EXPECTED_MAX (No description provided)
thresholdValue

object (EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue)

The metric value, above or below which the alert should be triggered.

warningEnumList

object (EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList)

(No description provided)

EnterpriseCrmEventbusStats

Stats for the requested dimensions: QPS, duration, and error/warning rate
Fields
dimensions

object (EnterpriseCrmEventbusStatsDimensions)

Dimensions that these stats have been aggregated on.

durationInSeconds

number (double format)

Average duration in seconds.

errorRate

number (double format)

Average error rate.

qps

number (double format)

Queries per second.

warningRate

number (double format)

Average warning rate.

EnterpriseCrmEventbusStatsDimensions

(No description provided)
Fields
clientId

string

(No description provided)

enumFilterType

enum

Whether to include or exclude the enums matching the regex.

Enum type. Can be one of the following:
DEFAULT_INCLUSIVE (No description provided)
EXCLUSIVE (No description provided)
errorEnumString

string

(No description provided)

retryAttempt

enum

(No description provided)

Enum type. Can be one of the following:
UNSPECIFIED (No description provided)
FINAL Task has completed successfully or has depleted all retry attempts.
RETRYABLE Task has failed but may be retried.
CANCELED Task has been deliberately canceled.
taskName

string

(No description provided)

taskNumber

string

(No description provided)

triggerId

string

Stats have been or will be aggregated on set fields for any semantically-meaningful combination.

warningEnumString

string

(No description provided)

workflowId

string

(No description provided)

workflowName

string

(No description provided)

EnterpriseCrmFrontendsEventbusProtoBooleanParameterArray

(No description provided)
Fields
booleanValues[]

boolean

(No description provided)

EnterpriseCrmFrontendsEventbusProtoDoubleParameterArray

(No description provided)
Fields
doubleValues[]

number (double format)

(No description provided)

EnterpriseCrmFrontendsEventbusProtoEventExecutionDetails

Contains the details of the execution info of this event: this includes the tasks execution details plus the event execution statistics. Next available id: 10
Fields
eventAttemptStats[]

object (EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats)

(No description provided)

eventExecutionSnapshot[]

object (EnterpriseCrmFrontendsEventbusProtoEventExecutionSnapshot)

After snapshot migration, this field will no longer be populated, but old execution snapshots will still be accessible.

eventExecutionState

enum

The execution state of this event.

Enum type. Can be one of the following:
UNSPECIFIED (No description provided)
ON_HOLD Event is received and waiting for the execution. This happens when firing the event via "postToQueue" or "schedule".
IN_PROCESS Event is under processing.
SUCCEEDED Event execution successfully finished. There's no more change after this state.
FAILED Event execution failed. There's no more change after this state.
CANCELED Event execution canceled by user. There's no more change after this state.
RETRY_ON_HOLD Event execution failed and waiting for retry.
SUSPENDED Event execution suspended and waiting for manual intervention.
eventRetriesFromBeginningCount

integer (int32 format)

Indicates the number of times the execution has restarted from the beginning.

logFilePath

string

The log file path (aka. cns address) for this event.

networkAddress

string

The network address (aka. bns address) that indicates where the event executor is running.

nextExecutionTime

string (int64 format)

Next scheduled execution time in case the execution status was RETRY_ON_HOLD.

ryeLockUnheldCount

integer (int32 format)

Used internally and shouldn't be exposed to users. A counter for the cron job to record how many times this event is in in_process state but don't have a lock consecutively/

EnterpriseCrmFrontendsEventbusProtoEventExecutionInfo

Contains all the execution details for a workflow instance. Next available id: 24
Fields
clientId

string

The event data user sends as request.

createTime

string (int64 format)

Auto-generated.

errorCode

object (CrmlogErrorCode)

Final error-code if event failed.

errors[]

object (EnterpriseCrmEventbusProtoErrorDetail)

Errors, warnings, and informationals associated with the workflow/task. The order in which the errors were added by the workflow/task is maintained.

eventExecutionDetails

object (EnterpriseCrmFrontendsEventbusProtoEventExecutionDetails)

The execution info about this event.

eventExecutionInfoId

string

Auto-generated primary key.

executionTraceInfo

object (EnterpriseCrmEventbusProtoExecutionTraceInfo)

Execution trace info to aggregate parent-child executions.

lastModifiedTime

string (int64 format)

Auto-generated.

postMethod

enum

The ways user posts this event.

Enum type. Can be one of the following:
UNSPECIFIED (No description provided)
POST (No description provided)
POST_TO_QUEUE (No description provided)
SCHEDULE (No description provided)
POST_BY_EVENT_CONFIG_ID (No description provided)
POST_WITH_EVENT_DETAILS (No description provided)
product

enum

Which Google product the execution_info belongs to. If not set, the execution_info belongs to Integration Platform by default.

Enum type. Can be one of the following:
UNSPECIFIED_PRODUCT (No description provided)
IP (No description provided)
APIGEE (No description provided)
SECURITY (No description provided)
requestId

string

Optional. This is used to de-dup incoming request.

requestParams

object (EnterpriseCrmFrontendsEventbusProtoEventParameters)

Event parameters come in as part of the request.

responseParams

object (EnterpriseCrmFrontendsEventbusProtoEventParameters)

Event parameters come out as part of the response.

snapshotNumber

string (int64 format)

Workflow snapshot number.

tenant

string

Tenant this event is created. Used to reschedule the event to correct tenant.

triggerId

string

The trigger id of the workflow trigger config. If both trigger_id and client_id is present, the workflow is executed from the start tasks provided by the matching trigger config otherwise it is executed from the default start tasks.

workflowId

string

Required. Pointer to the workflow it is executing.

workflowName

string

Name of the workflow.

workflowRetryBackoffIntervalSeconds

string (int64 format)

Time interval in seconds to schedule retry of workflow in manifold when workflow is already running

EnterpriseCrmFrontendsEventbusProtoEventExecutionSnapshot

(No description provided)
Fields
checkpointTaskNumber

string

Indicates "right after which checkpoint task's execution" this snapshot is taken.

conditionResults[]

object (EnterpriseCrmEventbusProtoConditionResult)

All of the computed conditions that been calculated.

diffParams

object (EnterpriseCrmFrontendsEventbusProtoEventParameters)

The parameters in Event object that differs from last snapshot.

eventExecutionInfoId

string

Points to the event execution info this snapshot belongs to.

eventExecutionSnapshotId

string

Auto-generated. Used as primary key for EventExecutionSnapshots table.

eventExecutionSnapshotMetadata

object (EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata)

(No description provided)

eventParams

object (EnterpriseCrmFrontendsEventbusProtoEventParameters)

The parameters in Event object.

snapshotTime

string (int64 format)

Indicates when this snapshot is taken.

taskExecutionDetails[]

object (EnterpriseCrmEventbusProtoTaskExecutionDetails)

All of the task execution details at the given point of time.

taskName

string

The task name associated with this snapshot. Could be empty.

EnterpriseCrmFrontendsEventbusProtoEventParameters

LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Next id: 4
Fields
parameters[]

object (EnterpriseCrmFrontendsEventbusProtoParameterEntry)

Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.

EnterpriseCrmFrontendsEventbusProtoIntParameterArray

(No description provided)
Fields
intValues[]

string (int64 format)

(No description provided)

EnterpriseCrmFrontendsEventbusProtoParamSpecEntry

Key-value pair of EventBus task parameters. Next id: 13
Fields
className

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

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

object (EnterpriseCrmEventbusProtoParamSpecEntryConfig)

Optional fields, such as help text and other useful info.

dataType

enum

The data type of the parameter.

Enum type. Can be one of the following:
DATA_TYPE_UNSPECIFIED (No description provided)
STRING_VALUE (No description provided)
INT_VALUE (No description provided)
DOUBLE_VALUE (No description provided)
BOOLEAN_VALUE (No description provided)
PROTO_VALUE (No description provided)
SERIALIZED_OBJECT_VALUE (No description provided)
STRING_ARRAY (No description provided)
INT_ARRAY (No description provided)
DOUBLE_ARRAY (No description provided)
PROTO_ARRAY (No description provided)
PROTO_ENUM (No description provided)
BOOLEAN_ARRAY (No description provided)
PROTO_ENUM_ARRAY (No description provided)
BYTES BYTES and BYTES_ARRAY data types are not allowed for top-level params. They're only meant to support protobufs with BYTES (sub)fields.
BYTES_ARRAY (No description provided)
NON_SERIALIZABLE_OBJECT (No description provided)
JSON_VALUE (No description provided)
defaultValue

object (EnterpriseCrmFrontendsEventbusProtoParameterValueType)

Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.

isDeprecated

boolean

If set, this entry is deprecated, so further use of this parameter should be prohibited.

isOutput

boolean

(No description provided)

jsonSchema

string

If the data_type is JSON_VALUE, then this will define its schema.

key

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

object (EnterpriseCrmEventbusProtoParamSpecEntryProtoDefinition)

Populated if this represents a proto or proto array.

required

boolean

If set, the user must provide an input value for this parameter.

validationRule

object (EnterpriseCrmEventbusProtoParamSpecEntryValidationRule)

Rule used to validate inputs (individual values and collection elements) for this parameter.

EnterpriseCrmFrontendsEventbusProtoParamSpecsMessage

(No description provided)
Fields
parameters[]

object (EnterpriseCrmFrontendsEventbusProtoParamSpecEntry)

(No description provided)

EnterpriseCrmFrontendsEventbusProtoParameterEntry

Key-value pair of EventBus parameters.
Fields
dataType

enum

Explicitly getting the type of the parameter.

Enum type. Can be one of the following:
DATA_TYPE_UNSPECIFIED (No description provided)
STRING_VALUE (No description provided)
INT_VALUE (No description provided)
DOUBLE_VALUE (No description provided)
BOOLEAN_VALUE (No description provided)
PROTO_VALUE (No description provided)
SERIALIZED_OBJECT_VALUE (No description provided)
STRING_ARRAY (No description provided)
INT_ARRAY (No description provided)
DOUBLE_ARRAY (No description provided)
PROTO_ARRAY (No description provided)
PROTO_ENUM (No description provided)
BOOLEAN_ARRAY (No description provided)
PROTO_ENUM_ARRAY (No description provided)
BYTES BYTES and BYTES_ARRAY data types are not allowed for top-level params. They're only meant to support protobufs with BYTES (sub)fields.
BYTES_ARRAY (No description provided)
NON_SERIALIZABLE_OBJECT (No description provided)
JSON_VALUE (No description provided)
key

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.

value

object (EnterpriseCrmFrontendsEventbusProtoParameterValueType)

Values for the defined keys. Each value can either be string, int, double or any proto message.

EnterpriseCrmFrontendsEventbusProtoParameterMap

A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified.
Fields
entries[]

object (EnterpriseCrmFrontendsEventbusProtoParameterMapEntry)

(No description provided)

keyType

enum

Option to specify key value type for all entries of the map. If provided then field types for all entries must conform to this.

Enum type. Can be one of the following:
DATA_TYPE_UNSPECIFIED (No description provided)
STRING_VALUE (No description provided)
INT_VALUE (No description provided)
DOUBLE_VALUE (No description provided)
BOOLEAN_VALUE (No description provided)
PROTO_VALUE (No description provided)
SERIALIZED_OBJECT_VALUE (No description provided)
STRING_ARRAY (No description provided)
INT_ARRAY (No description provided)
DOUBLE_ARRAY (No description provided)
PROTO_ARRAY (No description provided)
PROTO_ENUM (No description provided)
BOOLEAN_ARRAY (No description provided)
PROTO_ENUM_ARRAY (No description provided)
BYTES BYTES and BYTES_ARRAY data types are not allowed for top-level params. They're only meant to support protobufs with BYTES (sub)fields.
BYTES_ARRAY (No description provided)
NON_SERIALIZABLE_OBJECT (No description provided)
JSON_VALUE (No description provided)
valueType

enum

(No description provided)

Enum type. Can be one of the following:
DATA_TYPE_UNSPECIFIED (No description provided)
STRING_VALUE (No description provided)
INT_VALUE (No description provided)
DOUBLE_VALUE (No description provided)
BOOLEAN_VALUE (No description provided)
PROTO_VALUE (No description provided)
SERIALIZED_OBJECT_VALUE (No description provided)
STRING_ARRAY (No description provided)
INT_ARRAY (No description provided)
DOUBLE_ARRAY (No description provided)
PROTO_ARRAY (No description provided)
PROTO_ENUM (No description provided)
BOOLEAN_ARRAY (No description provided)
PROTO_ENUM_ARRAY (No description provided)
BYTES BYTES and BYTES_ARRAY data types are not allowed for top-level params. They're only meant to support protobufs with BYTES (sub)fields.
BYTES_ARRAY (No description provided)
NON_SERIALIZABLE_OBJECT (No description provided)
JSON_VALUE (No description provided)

EnterpriseCrmFrontendsEventbusProtoParameterMapEntry

Entry is a pair of key and value.
Fields
key

object (EnterpriseCrmFrontendsEventbusProtoParameterMapField)

(No description provided)

value

object (EnterpriseCrmFrontendsEventbusProtoParameterMapField)

(No description provided)

EnterpriseCrmFrontendsEventbusProtoParameterMapField

Field represents either the key or value in an entry.
Fields
literalValue

object (EnterpriseCrmFrontendsEventbusProtoParameterValueType)

Passing a literal value.

referenceKey

string

Referencing one of the WF variables.

EnterpriseCrmFrontendsEventbusProtoParameterValueType

To support various types of parameter values. Next available id: 14
Fields
booleanArray

object (EnterpriseCrmFrontendsEventbusProtoBooleanParameterArray)

(No description provided)

booleanValue

boolean

(No description provided)

doubleArray

object (EnterpriseCrmFrontendsEventbusProtoDoubleParameterArray)

(No description provided)

doubleValue

number (double format)

(No description provided)

intArray

object (EnterpriseCrmFrontendsEventbusProtoIntParameterArray)

(No description provided)

intValue

string (int64 format)

(No description provided)

jsonValue

string

(No description provided)

protoArray

object (EnterpriseCrmFrontendsEventbusProtoProtoParameterArray)

(No description provided)

protoValue

map (key: string, value: any)

(No description provided)

serializedObjectValue

object (EnterpriseCrmFrontendsEventbusProtoSerializedObjectParameter)

(No description provided)

stringArray

object (EnterpriseCrmFrontendsEventbusProtoStringParameterArray)

(No description provided)

stringValue

string

(No description provided)

EnterpriseCrmFrontendsEventbusProtoProtoParameterArray

(No description provided)
Fields
protoValues[]

object

(No description provided)

EnterpriseCrmFrontendsEventbusProtoRollbackStrategy

Next available id: 4
Fields
parameters

object (EnterpriseCrmFrontendsEventbusProtoEventParameters)

Optional. The customized parameters the user can pass to this task.

rollbackTaskImplementationClassName

string

Required. This is the name of the task that needs to be executed upon rollback of this task.

taskNumbersToRollback[]

string

Required. These are the tasks numbers of the tasks whose rollback_strategy.rollback_task_implementation_class_name needs to be executed upon failure of this task.

EnterpriseCrmFrontendsEventbusProtoSerializedObjectParameter

(No description provided)
Fields
objectValue

string (bytes format)

(No description provided)

EnterpriseCrmFrontendsEventbusProtoStringParameterArray

(No description provided)
Fields
stringValues[]

string

(No description provided)

EnterpriseCrmFrontendsEventbusProtoTaskConfig

The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. Next available id: 27
Fields
alertConfigs[]

object (EnterpriseCrmEventbusProtoTaskAlertConfig)

Alert configurations on error rate, warning rate, number of runs, durations, etc.

createTime

string (Timestamp format)

Auto-generated.

creatorEmail

string

The creator's email address. Auto-generated from the user's email.

description

string

User-provided description intended to give more business context about the task.

disableStrictTypeValidation

boolean

If this config contains a TypedTask, allow validation to succeed if an input is read from the output of another TypedTask whose output type is declared as a superclass of the requested input type. For instance, if the previous task declares an output of type Message, any task with this flag enabled will pass validation when attempting to read any proto Message type from the resultant Event parameter.

failurePolicy

object (EnterpriseCrmEventbusProtoFailurePolicy)

Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).

incomingEdgeCount

integer (int32 format)

The number of edges leading into this TaskConfig.

jsonValidationOption

enum

If set, overrides the option configured in the Task implementation class.

Enum type. Can be one of the following:
UNSPECIFIED_JSON_VALIDATION_OPTION As per the default behavior, no validation will be run. Will not override any option set in a Task.
SKIP Do not run any validation against JSON schemas.
PRE_EXECUTION Validate all potential input JSON parameters against schemas specified in WorkflowParameters.
POST_EXECUTION Validate all potential output JSON parameters against schemas specified in WorkflowParameters.
PRE_POST_EXECUTION Perform both PRE_EXECUTION and POST_EXECUTION validations.
label

string

User-provided label that is attached to this TaskConfig in the UI.

lastModifiedTime

string (Timestamp format)

Auto-generated.

nextTasks[]

object (EnterpriseCrmEventbusProtoNextTask)

The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by event_config_id. Each of these next tasks are executed only if the condition associated with them evaluates to true.

nextTasksExecutionPolicy

enum

The policy dictating the execution of the next set of tasks for the current task.

Enum type. Can be one of the following:
UNSPECIFIED Default
RUN_ALL_MATCH Execute all the tasks that satisfy their associated condition.
RUN_FIRST_MATCH Execute the first task that satisfies the associated condition.
parameters

map (key: string, value: object (EnterpriseCrmFrontendsEventbusProtoParameterEntry))

The customized parameters the user can pass to this task.

position

object (EnterpriseCrmEventbusProtoCoordinate)

Optional. Informs the front-end application where to draw this task config on the UI.

precondition

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

string

Optional. User-provided label that is attached to precondition in the UI.

rollbackStrategy

object (EnterpriseCrmFrontendsEventbusProtoRollbackStrategy)

Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times).

successPolicy

object (EnterpriseCrmEventbusProtoSuccessPolicy)

Determines what action to take upon successful task completion.

synchronousCallFailurePolicy

object (EnterpriseCrmEventbusProtoFailurePolicy)

Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).

taskEntity

object (EnterpriseCrmFrontendsEventbusProtoTaskEntity)

Copy of the task entity that this task config is an instance of.

taskExecutionStrategy

enum

The policy dictating the execution strategy of this task.

Enum type. Can be one of the following:
WHEN_ALL_SUCCEED Wait until all of its previous tasks finished execution, then verify at least one of the edge conditions is met, and execute if possible. This should be considered as WHEN_ALL_TASKS_SUCCEED.
WHEN_ANY_SUCCEED Start execution as long as any of its previous tasks finished execution and the corresponding edge condition is met (since we will execute if only that succeeding edge condition is met).
WHEN_ALL_TASKS_AND_CONDITIONS_SUCCEED Wait until all of its previous tasks finished execution, then verify the all edge conditions are met and execute if possible.
taskName

string

The name for the task.

taskNumber

string

REQUIRED: the identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field next_tasks.task_number).

taskSpec

string

A string template that allows user to configure task parameters (with either literal default values or tokens which will be resolved at execution time) for the task. It will eventually replace the old "parameters" field.

taskTemplateName

string

Used to define task-template name if task is of type task-template

taskType

enum

Defines the type of the task

Enum type. Can be one of the following:
TASK Normal IP task
ASIS_TEMPLATE Task is of As-Is Template type
IO_TEMPLATE Task is of I/O template type with a different underlying task

EnterpriseCrmFrontendsEventbusProtoTaskEntity

Contains a task's metadata and associated information. Next available id: 7
Fields
disabledForVpcSc

boolean

True if the task has conflict with vpcsc

metadata

object (EnterpriseCrmEventbusProtoTaskMetadata)

Metadata inclueds the task name, author and so on.

paramSpecs

object (EnterpriseCrmFrontendsEventbusProtoParamSpecsMessage)

Declarations for inputs/outputs for a TypedTask. This is also associated with the METADATA mask.

stats

object (EnterpriseCrmEventbusStats)

Deprecated - statistics from the Monarch query.

taskType

enum

Defines the type of the task

Enum type. Can be one of the following:
TASK Normal IP task
ASIS_TEMPLATE Task is of As-Is Template type
IO_TEMPLATE Task is of I/O template type with a different underlying task
uiConfig

object (EnterpriseCrmEventbusProtoTaskUiConfig)

UI configuration for this task Also associated with the METADATA mask.

EnterpriseCrmFrontendsEventbusProtoTriggerConfig

Configuration detail of a trigger. Next available id: 17
Fields
alertConfig[]

object (EnterpriseCrmEventbusProtoWorkflowAlertConfig)

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.

cloudSchedulerConfig

object (EnterpriseCrmEventbusProtoCloudSchedulerConfig)

(No description provided)

description

string

User-provided description intended to give more business context about the task.

enabledClients[]

string

Required. The list of client ids which are enabled to execute the workflow using this trigger. In other words, these clients have the workflow execution privledges for this trigger. For API trigger, the client id in the incoming request is validated against the list of enabled clients. For non-API triggers, one workflow execution is triggered on behalf of each enabled client.

label

string

The user created label for a particular trigger.

nextTasksExecutionPolicy

enum

Dictates how next tasks will be executed.

Enum type. Can be one of the following:
UNSPECIFIED Default
RUN_ALL_MATCH Execute all the tasks that satisfy their associated condition.
RUN_FIRST_MATCH Execute the first task that satisfies the associated condition.
pauseWorkflowExecutions

boolean

Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed.

position

object (EnterpriseCrmEventbusProtoCoordinate)

Optional. Informs the front-end application where to draw this trigger config on the UI.

properties

map (key: string, value: string)

Configurable properties of the trigger, not to be confused with workflow parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Cloud Pubsub triggers.

startTasks[]

object (EnterpriseCrmEventbusProtoNextTask)

Set of tasks numbers from where the workflow execution is started by this trigger. If this is empty, then workflow is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same workflow execution graph).

triggerCriteria

object (EnterpriseCrmEventbusProtoTriggerCriteria)

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.

triggerId

string

The backend trigger ID.

triggerNumber

string

Required. A number to uniquely identify each trigger config within the workflow on UI.

triggerType

enum

(No description provided)

Enum type. Can be one of the following:
UNKNOWN (No description provided)
CLOUD_PUBSUB (No description provided)
GOOPS (No description provided)
SFDC_SYNC (No description provided)
CRON (No description provided)
API (No description provided)
MANIFOLD_TRIGGER (No description provided)
DATALAYER_DATA_CHANGE (No description provided)
SFDC_CHANNEL (No description provided)
CLOUD_PUBSUB_EXTERNAL (No description provided)
SFDC_CDC_CHANNEL (No description provided)
SFDC_PLATFORM_EVENTS_CHANNEL (No description provided)
CLOUD_SCHEDULER (No description provided)

EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry

(No description provided)
Fields
attributes

object (EnterpriseCrmEventbusProtoAttributes)

Metadata information about the parameters.

children[]

object (EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry)

Child parameters nested within this parameter. This field only applies to protobuf parameters

dataType

enum

The data type of the parameter.

Enum type. Can be one of the following:
DATA_TYPE_UNSPECIFIED (No description provided)
STRING_VALUE (No description provided)
INT_VALUE (No description provided)
DOUBLE_VALUE (No description provided)
BOOLEAN_VALUE (No description provided)
PROTO_VALUE (No description provided)
SERIALIZED_OBJECT_VALUE (No description provided)
STRING_ARRAY (No description provided)
INT_ARRAY (No description provided)
DOUBLE_ARRAY (No description provided)
PROTO_ARRAY (No description provided)
PROTO_ENUM (No description provided)
BOOLEAN_ARRAY (No description provided)
PROTO_ENUM_ARRAY (No description provided)
BYTES BYTES and BYTES_ARRAY data types are not allowed for top-level params. They're only meant to support protobufs with BYTES (sub)fields.
BYTES_ARRAY (No description provided)
NON_SERIALIZABLE_OBJECT (No description provided)
JSON_VALUE (No description provided)
defaultValue

object (EnterpriseCrmFrontendsEventbusProtoParameterValueType)

Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.

inOutType

enum

Specifies the input/output type for the parameter.

Enum type. Can be one of the following:
IN_OUT_TYPE_UNSPECIFIED (No description provided)
IN Input parameters for the workflow. EventBus validates that these parameters exist in the workflows before execution.
OUT Output Parameters for the workflow. EventBus will only return the workflow parameters tagged with OUT in the response back.
IN_OUT Input or Output Parameters. These can be used as both input and output. EventBus will validate for the existence of these parameters before execution and will also return this parameter back in the response.
isTransient

boolean

Whether this parameter is a transient parameter.

jsonSchema

string

This schema will be used to validate runtime JSON-typed values of this parameter.

key

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

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".

producedBy

object (EnterpriseCrmEventbusProtoNodeIdentifier)

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

string

(No description provided)

protoDefName

string

The name of the protobuf type if the parameter has a protobuf data type.

protoDefPath

string

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".

EnterpriseCrmFrontendsEventbusProtoWorkflowParameters

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.
Fields
parameters[]

object (EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry)

Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution.

EnterpriseCrmLoggingGwsFieldLimits

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
Fields
logAction

enum

(No description provided)

Enum type. Can be one of the following:
LOG_ACTION_UNSPECIFIED (No description provided)
DONT_LOG (No description provided)
LOG (No description provided)
logType[]

string

To which type(s) of logs the limits apply.

maxArraySize

integer (int32 format)

maximum array size. If the array exceds this size, the field (list) is truncated.

maxStringLength

integer (int32 format)

maximum string length. If the field exceeds this amount the field is shortened.

shortenerType

enum

(No description provided)

Enum type. Can be one of the following:
SHORTENER_TYPE_UNSPECIFIED (No description provided)
SHORTEN String is shortened to max_string_length.
HASH String is replaced by its hex-string hash.
SHORTEN_WITH_HASH String is replaced by a combination of string shortening and a hex-string hash.
SHORTEN_EMAIL String shortening for email addresses. Shortening may be done on the user and/or domain portion of the email address.
SHORTEN_EMAIL_WITH_HASH String is replaced by a combination of string shortening and a hex-string hash for an email address.
SHORTEN_DOMAIN Shortens a domain name (e.g., as part of an email address or URL).

EnterpriseCrmLoggingGwsSanitizeOptions

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
Fields
isAlreadySanitized

boolean

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.

logType[]

string

To which type(s) of logs the sanitize options apply.

privacy

enum

(No description provided)

Enum type. Can be one of the following:
PRIVACY_TYPE_UNSPECIFIED (No description provided)
NOT_PII Field does NOT contain PII or sensitive data.
PII Field contains PII.
SPII Field contains Sensitive PII.
UNSURE Unsure if field contains PII.
sanitizeType

enum

(No description provided)

Enum type. Can be one of the following:
SANITIZE_TYPE_UNSPECIFIED (No description provided)
SCRUB Replace value with a scrubbed value (usu. a constant).
ANONYMIZE Transform a value so that it cannot be tracked across events. However, a given value, is transformed to the same value within an event. E.g., "foo.com" is transformed to "0xabcdef" for event 1001, and to "0xfedcba" for event 1002.
ANONYMIZE_LIMITED_REPEATABLE Transform values as with ANONYMIZER, but the same transformation is repeated for a limited time (e.g., 1 day).
OBFUSCATE The value is transformed using a well-defined obfuscator (e.g., D3_CUSTOMER_ID).
ENCRYPT The value is encrypted.
DO_NOT_SANITIZE No sanitization is required.

GoogleCloudConnectorsV1AuthConfig

AuthConfig defines details of a authentication type.
Fields
additionalVariables[]

object (GoogleCloudConnectorsV1ConfigVariable)

List containing additional auth configs.

authType

enum

The type of authentication configured.

Enum type. Can be one of the following:
AUTH_TYPE_UNSPECIFIED Authentication type not specified.
USER_PASSWORD Username and Password Authentication.
OAUTH2_JWT_BEARER JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant based authentication
OAUTH2_CLIENT_CREDENTIALS Oauth 2.0 Client Credentials Grant Authentication
SSH_PUBLIC_KEY SSH Public Key Authentication
OAUTH2_AUTH_CODE_FLOW Oauth 2.0 Authorization Code Flow
oauth2ClientCredentials

object (GoogleCloudConnectorsV1AuthConfigOauth2ClientCredentials)

Oauth2ClientCredentials.

oauth2JwtBearer

object (GoogleCloudConnectorsV1AuthConfigOauth2JwtBearer)

Oauth2JwtBearer.

sshPublicKey

object (GoogleCloudConnectorsV1AuthConfigSshPublicKey)

SSH Public Key.

userPassword

object (GoogleCloudConnectorsV1AuthConfigUserPassword)

UserPassword.

GoogleCloudConnectorsV1AuthConfigOauth2ClientCredentials

Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details.
Fields
clientId

string

The client identifier.

clientSecret

object (GoogleCloudConnectorsV1Secret)

Secret version reference containing the client secret.

GoogleCloudConnectorsV1AuthConfigOauth2JwtBearer

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.
Fields
clientKey

object (GoogleCloudConnectorsV1Secret)

Secret version reference containing a PKCS#8 PEM-encoded private key associated with the Client Certificate. This private key will be used to sign JWTs used for the jwt-bearer authorization grant. Specified in the form as: projects/*/secrets/*/versions/*.

jwtClaims

object (GoogleCloudConnectorsV1AuthConfigOauth2JwtBearerJwtClaims)

JwtClaims providers fields to generate the token.

GoogleCloudConnectorsV1AuthConfigOauth2JwtBearerJwtClaims

JWT claims used for the jwt-bearer authorization grant.
Fields
audience

string

Value for the "aud" claim.

issuer

string

Value for the "iss" claim.

subject

string

Value for the "sub" claim.

GoogleCloudConnectorsV1AuthConfigSshPublicKey

Parameters to support Ssh public key Authentication.
Fields
certType

string

Format of SSH Client cert.

sshClientCert

object (GoogleCloudConnectorsV1Secret)

SSH Client Cert. It should contain both public and private key.

sshClientCertPass

object (GoogleCloudConnectorsV1Secret)

Password (passphrase) for ssh client certificate if it has one.

username

string

The user account used to authenticate.

GoogleCloudConnectorsV1AuthConfigUserPassword

Parameters to support Username and Password Authentication.
Fields
password

object (GoogleCloudConnectorsV1Secret)

Secret version reference containing the password.

username

string

Username.

GoogleCloudConnectorsV1ConfigVariable

ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
Fields
boolValue

boolean

Value is a bool.

intValue

string (int64 format)

Value is an integer

key

string

Key of the config variable.

secretValue

object (GoogleCloudConnectorsV1Secret)

Value is a secret.

stringValue

string

Value is a string.

GoogleCloudConnectorsV1Connection

Connection represents an instance of connector.
Fields
authConfig

object (GoogleCloudConnectorsV1AuthConfig)

Optional. Configuration for establishing the connection's authentication with an external system.

configVariables[]

object (GoogleCloudConnectorsV1ConfigVariable)

Optional. Configuration for configuring the connection with an external system.

connectorVersion

string

Required. Connector version on which the connection is created. The format is: projects//locations//providers//connectors//versions/* Only global location is supported for ConnectorVersion resource.

createTime

string (Timestamp format)

Output only. Created time.

description

string

Optional. Description of the resource.

destinationConfigs[]

object (GoogleCloudConnectorsV1DestinationConfig)

Optional. Configuration of the Connector's destination. Only accepted for Connectors that accepts user defined destination(s).

envoyImageLocation

string

Output only. GCR location where the envoy image is stored. formatted like: gcr.io/{bucketName}/{imageName}

imageLocation

string

Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName}

labels

map (key: string, value: string)

Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources

lockConfig

object (GoogleCloudConnectorsV1LockConfig)

Optional. Configuration that indicates whether or not the Connection can be edited.

name

string

Output only. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection}

nodeConfig

object (GoogleCloudConnectorsV1NodeConfig)

Optional. Configuration for the connection.

serviceAccount

string

Optional. Service account needed for runtime plane to access GCP resources.

serviceDirectory

string

Output only. The name of the Service Directory service name. Used for Private Harpoon to resolve the ILB address. e.g. "projects/cloud-connectors-e2e-testing/locations/us-central1/namespaces/istio-system/services/istio-ingressgateway-connectors"

status

object (GoogleCloudConnectorsV1ConnectionStatus)

Output only. Current status of the connection.

suspended

boolean

Optional. Suspended indicates if a user has suspended a connection or not.

updateTime

string (Timestamp format)

Output only. Updated time.

GoogleCloudConnectorsV1ConnectionStatus

ConnectionStatus indicates the state of the connection.
Fields
description

string

Description.

state

enum

State.

Enum type. Can be one of the following:
STATE_UNSPECIFIED Connection does not have a state yet.
CREATING Connection is being created.
ACTIVE Connection is running and ready for requests.
INACTIVE Connection is stopped.
DELETING Connection is being deleted.
UPDATING Connection is being updated.
ERROR Connection is not running due to an error.
status

string

Status provides detailed information for the state.

GoogleCloudConnectorsV1Destination

(No description provided)
Fields
host

string

For publicly routable host.

port

integer (int32 format)

The port is the target port number that is accepted by the destination.

serviceAttachment

string

PSC service attachments. Format: projects//regions//serviceAttachments/*

GoogleCloudConnectorsV1DestinationConfig

Define the Connectors target endpoint.
Fields
destinations[]

object (GoogleCloudConnectorsV1Destination)

The destinations for the key.

key

string

The key is the destination identifier that is supported by the Connector.

GoogleCloudConnectorsV1LockConfig

Determines whether or no a connection is locked. If locked, a reason must be specified.
Fields
locked

boolean

Indicates whether or not the connection is locked.

reason

string

Describes why a connection is locked.

GoogleCloudConnectorsV1NodeConfig

Configuration for the connection.
Fields
maxNodeCount

integer (int32 format)

Maximum number of nodes in the runtime nodes.

minNodeCount

integer (int32 format)

Minimum number of nodes in the runtime nodes.

GoogleCloudConnectorsV1Secret

Secret provides a reference to entries in Secret Manager.
Fields
secretVersion

string

The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*.

GoogleCloudIntegrationsV1alphaAccessToken

The access token represents the authorization of a specific application to access specific parts of a user’s data.
Fields
accessToken

string

The access token encapsulating the security identity of a process or thread.

accessTokenExpireTime

string (Timestamp format)

Required. The approximate time until the access token retrieved is valid.

refreshToken

string

If the access token will expire, use the refresh token to obtain another access token.

refreshTokenExpireTime

string (Timestamp format)

The approximate time until the refresh token retrieved is valid.

tokenType

string

Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.

GoogleCloudIntegrationsV1alphaAttemptStats

Status for the execution attempt.
Fields
endTime

string (Timestamp format)

The end time of the event execution for current attempt.

startTime

string (Timestamp format)

The start time of the event execution for current attempt. This could be in the future if it's been scheduled.

GoogleCloudIntegrationsV1alphaAuthConfig

The AuthConfig resource use to hold channels and connection config data.
Fields
certificateId

string

Certificate id for client certificate

createTime

string (Timestamp format)

Output only. The timestamp when the auth config is created.

creatorEmail

string

The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call.

credentialType

enum

Credential type of the encrypted credential.

Enum type. Can be one of the following:
CREDENTIAL_TYPE_UNSPECIFIED Unspecified credential type
USERNAME_AND_PASSWORD Regular username/password pair.
API_KEY API key.
OAUTH2_AUTHORIZATION_CODE OAuth 2.0 Authorization Code Grant Type.
OAUTH2_IMPLICIT OAuth 2.0 Implicit Grant Type.
OAUTH2_CLIENT_CREDENTIALS OAuth 2.0 Client Credentials Grant Type.
OAUTH2_RESOURCE_OWNER_CREDENTIALS OAuth 2.0 Resource Owner Credentials Grant Type.
JWT JWT Token.
AUTH_TOKEN Auth Token, e.g. bearer token.
SERVICE_ACCOUNT Service Account which can be used to generate token for authentication.
CLIENT_CERTIFICATE_ONLY Client Certificate only.
OIDC_TOKEN Google OIDC ID Token
decryptedCredential

object (GoogleCloudIntegrationsV1alphaCredential)

Raw auth credentials.

description

string

A description of the auth config.

displayName

string

The name of the auth config.

encryptedCredential

string (bytes format)

Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key.

expiryNotificationDuration[]

string (Duration format)

User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours.

lastModifierEmail

string

The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.

name

string

Resource name of the SFDC instance projects/{project}/locations/{location}/authConfigs/{authConfig}.

overrideValidTime

string (Timestamp format)

User provided expiry time to override. For the example of Salesforce, username/password credentials can be valid for 6 months depending on the instance settings.

reason

string

The reason / details of the current status.

state

enum

The status of the auth config.

Enum type. Can be one of the following:
STATE_UNSPECIFIED Status not specified.
VALID Valid Auth config.
INVALID General invalidity, if it doesn't fits in the detailed issue below.
SOFT_DELETED Auth config soft deleted.
EXPIRED Auth config expired.
UNAUTHORIZED Auth config unauthorized.
UNSUPPORTED Auth config not supported.
updateTime

string (Timestamp format)

Output only. The timestamp when the auth config is modified.

validTime

string (Timestamp format)

The time until the auth config is valid. Empty or max value is considered the auth config won't expire.

visibility

enum

The visibility of the auth config.

Enum type. Can be one of the following:
AUTH_CONFIG_VISIBILITY_UNSPECIFIED Visibility not specified.
PRIVATE Profile visible to the creator only.
CLIENT_VISIBLE Profile visible within the client.

GoogleCloudIntegrationsV1alphaAuthToken

The credentials to authenticate a user agent with a server that is put in HTTP Authorization request header.
Fields
token

string

The token for the auth type.

type

string

Authentication type, e.g. "Basic", "Bearer", etc.

GoogleCloudIntegrationsV1alphaBooleanParameterArray

This message only contains a field of boolean array.
Fields
booleanValues[]

boolean

Boolean array.

GoogleCloudIntegrationsV1alphaCancelExecutionResponse

Response for cancelling an execution.
Fields
isCanceled

boolean

True if cancellation performed successfully

GoogleCloudIntegrationsV1alphaCertificate

The certificate definition
Fields
certificateStatus

enum

Status of the certificate

Enum type. Can be one of the following:
STATE_UNSPECIFIED Unspecified certificate status
ACTIVE Certificate in active state will be able to use
EXPIRED Certificate in expired state needs to be updated
credentialId

string

Immutable. Credential id that will be used to register with trawler INTERNAL_ONLY

description

string

Description of the certificate

displayName

string

Name of the certificate

name

string

Output only. Auto generated primary key

rawCertificate

object (GoogleCloudIntegrationsV1alphaClientCertificate)

Input only. Raw client certificate which would be registered with trawler

requestorId

string

Immutable. Requestor ID to be used to register certificate with trawler

validEndTime

string (Timestamp format)

Output only. The timestamp after which certificate will expire

validStartTime

string (Timestamp format)

Output only. The timestamp after which certificate will be valid

GoogleCloudIntegrationsV1alphaClientCertificate

Contains client certificate information
Fields
encryptedPrivateKey

string

The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----

passphrase

string

'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.

sslCertificate

string

The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----

GoogleCloudIntegrationsV1alphaClientConfig

The configuration information for the Client
Fields
billingType

enum

Indicates the billing type of the client

Enum type. Can be one of the following:
BILLING_TYPE_UNSPECIFIED Unspecified billing type
BILLING_TYPE_APIGEE_TRIALS A trial org provisioned through Apigee Provisioning Wizard
BILLING_TYPE_APIGEE_SUBSCRIPTION Subscription based users of Apigee
BILLING_TYPE_PAYG Consumption based users of IP
clientState

enum

Indicates the activity state the client

Enum type. Can be one of the following:
CLIENT_STATE_UNSPECIFIED The client state is unspecified
CLIENT_STATE_ACTIVE The client is active and able to make calls to the IP APIs
CLIENT_STATE_DISABLED The client is disabled and will soon be deleted
cloudKmsConfig

object (GoogleCloudIntegrationsV1alphaCloudKmsConfig)

Cloud KMS config for Auth Module to encrypt/decrypt credentials.

cloudLoggingConfig

object (GoogleCloudIntegrationsV1alphaCloudLoggingConfig)

Determines the cloud logging configuration for the project

createTime

string (Timestamp format)

The timestamp when the client was first created.

description

string

Description of what the client is used for

id

string

Globally unique ID (project_id + region)

p4ServiceAccount

string

The P4SA account associated with this client

projectId

string

The GCP project id of the client associated with

region

string

The region the client is linked to.

GoogleCloudIntegrationsV1alphaCloudKmsConfig

Configuration information for Client's Cloud KMS information
Fields
key

string

Required. 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.

keyVersion

string

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.

kmsLocation

string

Required. Location name of the key ring, e.g. "us-west1".

kmsRing

string

Required. 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.

GoogleCloudIntegrationsV1alphaCloudLoggingConfig

Config info for Cloud Logging
Fields
bucket

string

Cloud bucket name for the project.

enableCloudLogging

boolean

This field determines whether the logs should be sent to cloud logging api

GoogleCloudIntegrationsV1alphaCloudSchedulerConfig

Cloud Scheduler Trigger configuration
Fields
cronTab

string

Required. The cron tab of cloud scheduler trigger.

errorMessage

string

Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations

location

string

Required. The location where associated cloud scheduler job will be created

serviceAccountEmail

string

Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time

GoogleCloudIntegrationsV1alphaConnectionSchemaMetadata

Metadata of runtime connection schema.
Fields
actions[]

string

List of actions.

entities[]

string

List of entity names.

GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectRequest

Request for CreateAppsScriptProject rpc call.
Fields
appsScriptProject

string

The name of the Apps Script project to be created.

authConfigId

string

The auth config id necessary to fetch the necessary credentials to create the project for external clients

GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectResponse

Response for CreateAppsScriptProject rpc call.
Fields
projectId

string

The created AppsScriptProject ID.

GoogleCloudIntegrationsV1alphaCreateBundleRequest

PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. Request to create a new Bundle.
Fields
bundleId

string

Required. name of the bundle that will be created

integrations[]

string

A list of integrations that can be executed by the bundle

secondaryCustomerOrgId

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.

GoogleCloudIntegrationsV1alphaCreateBundleResponse

Response for create bundle.
Fields
config

object (GoogleCloudIntegrationsV1alphaIntegrationBundleConfig)

It contains the bundle data

triggerId

string

trigger_id of the bundle task

GoogleCloudIntegrationsV1alphaCreateCloudFunctionRequest

Request for Creating Cloud Function rpc call.
Fields
functionName

string

The function name of CF to be created

functionRegion

string

The function region of CF to be created

projectId

string

Indicates the id of the GCP project that the function will be created in.

GoogleCloudIntegrationsV1alphaCreateCloudFunctionResponse

Response for Creating Cloud Function rpc call.
Fields
triggerUrl

string

The trigger url that will be returned

GoogleCloudIntegrationsV1alphaCredential

Defines parameters for a single, canonical credential.
Fields
authToken

object (GoogleCloudIntegrationsV1alphaAuthToken)

Auth token credential

credentialType

enum

Credential type associated with auth config.

Enum type. Can be one of the following:
CREDENTIAL_TYPE_UNSPECIFIED Unspecified credential type
USERNAME_AND_PASSWORD Regular username/password pair.
API_KEY API key.
OAUTH2_AUTHORIZATION_CODE OAuth 2.0 Authorization Code Grant Type.
OAUTH2_IMPLICIT OAuth 2.0 Implicit Grant Type.
OAUTH2_CLIENT_CREDENTIALS OAuth 2.0 Client Credentials Grant Type.
OAUTH2_RESOURCE_OWNER_CREDENTIALS OAuth 2.0 Resource Owner Credentials Grant Type.
JWT JWT Token.
AUTH_TOKEN Auth Token, e.g. bearer token.
SERVICE_ACCOUNT Service Account which can be used to generate token for authentication.
CLIENT_CERTIFICATE_ONLY Client Certificate only.
OIDC_TOKEN Google OIDC ID Token
jwt

object (GoogleCloudIntegrationsV1alphaJwt)

JWT credential

oauth2AuthorizationCode

object (GoogleCloudIntegrationsV1alphaOAuth2AuthorizationCode)

The api_key and oauth2_implicit are not covered in v1 and will be picked up once v1 is implemented. ApiKey api_key = 3; OAuth2 authorization code credential

oauth2ClientCredentials

object (GoogleCloudIntegrationsV1alphaOAuth2ClientCredentials)

OAuth2Implicit oauth2_implicit = 5; OAuth2 client credentials

oauth2ResourceOwnerCredentials

object (GoogleCloudIntegrationsV1alphaOAuth2ResourceOwnerCredentials)

OAuth2 resource owner credentials

oidcToken

object (GoogleCloudIntegrationsV1alphaOidcToken)

Google OIDC ID Token

serviceAccountCredentials

object (GoogleCloudIntegrationsV1alphaServiceAccountCredentials)

Service account credential

usernameAndPassword

object (GoogleCloudIntegrationsV1alphaUsernameAndPassword)

Username and password credential

GoogleCloudIntegrationsV1alphaDoubleParameterArray

This message only contains a field of double number array.
Fields
doubleValues[]

number (double format)

Double number array.

GoogleCloudIntegrationsV1alphaDownloadExecutionResponse

Response for downloading an execution.
Fields
content

string

The content of downloaded execution.

GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse

Response for DownloadIntegrationVersion.
Fields
content

string

String representation of the integration version.

GoogleCloudIntegrationsV1alphaEnumerateConnectorPlatformRegionsResponse

Response containing all provisioned regions for Connector Platform.
Fields
regions[]

string

All regions where Connector Platform is provisioned.

GoogleCloudIntegrationsV1alphaEventParameter

This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus.
Fields
key

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.

value

object (GoogleCloudIntegrationsV1alphaValueType)

Values for the defined keys. Each value can either be string, int, double or any proto message.

GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest

The request for executing an integration.
Fields
doNotPropagateError

boolean

Optional. Flag to determine how to should propagate errors. If this flag is set to be true, it will not throw an exception. Instead, it will return a {@link ExecuteIntegrationsResponse} with an execution id and error messages as PostWithTriggerIdExecutionException in {@link EventParameters}. The flag is set to be false by default.

executionId

string

Optional. The id of the ON_HOLD execution to be resumed.

inputParameters

map (key: string, value: object (GoogleCloudIntegrationsV1alphaValueType))

Optional. Input parameters used by integration execution.

parameterEntries[]

object (EnterpriseCrmFrontendsEventbusProtoParameterEntry)

Optional. Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.

parameters

object (EnterpriseCrmFrontendsEventbusProtoEventParameters)

Optional. Passed in as parameters to each integration execution. Redacted

requestId

string

Optional. This is used to de-dup incoming request: if the duplicate request was detected, the response from the previous execution is returned.

triggerId

string

Required. Matched against all {@link TriggerConfig}s across all integrations. i.e. TriggerConfig.trigger_id.equals(trigger_id). The trigger_id is in the format of api_trigger/TRIGGER_NAME.

GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse

The response for executing an integration.
Fields
eventParameters

object (EnterpriseCrmFrontendsEventbusProtoEventParameters)

Details for the integration that were executed.

executionFailed

boolean

Is true if any execution in the integration failed. False otherwise.

executionId

string

The id of the execution corresponding to this run of integration.

outputParameters

map (key: string, value: any)

OUTPUT parameters in format of Map. Where Key is the name of the parameter. Note: Name of the system generated parameters are wrapped by backtick(`) to distinguish them from the user defined parameters.

parameterEntries[]

object (EnterpriseCrmFrontendsEventbusProtoParameterEntry)

Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.

GoogleCloudIntegrationsV1alphaExecution

The Execution resource contains detailed information of an individual integration execution.
Fields
createTime

string (Timestamp format)

Output only. Created time of the execution.

directSubExecutions[]

object (GoogleCloudIntegrationsV1alphaExecution)

Direct sub executions of the following Execution.

eventExecutionDetails

object (EnterpriseCrmEventbusProtoEventExecutionDetails)

The execution info about this event.

executionDetails

object (GoogleCloudIntegrationsV1alphaExecutionDetails)

Detailed info of this execution.

executionMethod

enum

The ways user posts this event.

Enum type. Can be one of the following:
EXECUTION_METHOD_UNSPECIFIED Default value.
POST Sync post.
POST_TO_QUEUE Async post.
SCHEDULE Async post with schedule time.
name

string

Auto-generated primary key.

requestParameters

map (key: string, value: object (GoogleCloudIntegrationsV1alphaValueType))

Event parameters come in as part of the request.

requestParams[]

object (EnterpriseCrmFrontendsEventbusProtoParameterEntry)

Event parameters come in as part of the request.

responseParameters

map (key: string, value: object (GoogleCloudIntegrationsV1alphaValueType))

Event parameters returned as part of the response.

responseParams[]

object (EnterpriseCrmFrontendsEventbusProtoParameterEntry)

Event parameters come out as part of the response.

triggerId

string

The trigger id of the integration trigger config. If both trigger_id and client_id is present, the integration is executed from the start tasks provided by the matching trigger config otherwise it is executed from the default start tasks.

updateTime

string (Timestamp format)

Output only. Last modified time of the execution.

GoogleCloudIntegrationsV1alphaExecutionDetails

Contains the details of the execution info: this includes the tasks execution details plus the event execution statistics.
Fields
attemptStats[]

object (GoogleCloudIntegrationsV1alphaAttemptStats)

List of Start and end time of the execution attempts.

executionSnapshots[]

object (GoogleCloudIntegrationsV1alphaExecutionSnapshot)

List of snapshots taken during the execution.

state

enum

Status of the execution.

Enum type. Can be one of the following:
STATE_UNSPECIFIED Default.
PENDING Execution is scheduled and awaiting to be triggered.
PROCESSING Execution is processing.
SUCCEEDED Execution successfully finished. There's no more change after this state.
FAILED Execution failed. There's no more change after this state.
CANCELLED Execution canceled by user. There's no more change after this state.
RETRY_ON_HOLD Execution failed and waiting for retry.
SUSPENDED Execution suspended and waiting for manual intervention.

GoogleCloudIntegrationsV1alphaExecutionSnapshot

Contains the snapshot of the execution for a given checkpoint.
Fields
checkpointTaskNumber

string

Indicates "after which checkpoint task's execution" this snapshot is taken.

executionSnapshotMetadata

object (GoogleCloudIntegrationsV1alphaExecutionSnapshotExecutionSnapshotMetadata)

Metadata of the execution snapshot.

params

map (key: string, value: object (GoogleCloudIntegrationsV1alphaValueType))

Parameters used during the execution.

taskExecutionDetails[]

object (GoogleCloudIntegrationsV1alphaTaskExecutionDetails)

All of the task execution details at the given point of time.

GoogleCloudIntegrationsV1alphaExecutionSnapshotExecutionSnapshotMetadata

Metadata of the execution snapshot.
Fields
executionAttempt

integer (int32 format)

the execution attempt number this snapshot belongs to.

task

string

the task name associated with this snapshot.

taskAttempt

integer (int32 format)

the task attempt number this snapshot belongs to.

taskNumber

string

The task number associated with this snapshot.

GoogleCloudIntegrationsV1alphaFailurePolicy

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).
Fields
intervalTime

string (Timestamp format)

Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.

maxRetries

integer (int32 format)

Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.

retryStrategy

enum

Defines what happens to the task upon failure.

Enum type. Can be one of the following:
RETRY_STRATEGY_UNSPECIFIED UNSPECIFIED.
IGNORE Ignores the failure of this task. The rest of the integration will be executed Assuming this task succeeded.
NONE Causes a permanent failure of the task. However, if the last task(s) of event was successfully completed despite the failure of this task, it has no impact on the integration.
FATAL Causes a permanent failure of the event. It is different from NONE because this will mark the event as FAILED by shutting down the event execution.
FIXED_INTERVAL The task will be retried from the failed task onwards after a fixed delay. A max-retry count is required to be specified with this strategy. A jitter is added to each exponential interval so that concurrently failing tasks of the same type do not end up retrying after the exact same exponential interval. max_retries and interval_in_seconds must be specified.
LINEAR_BACKOFF The task will be retried from the failed task onwards after a fixed delay that linearly increases with each retry attempt. A jitter is added to each exponential interval so that concurrently failing tasks of the same type do not end up retrying after the exact same exponential interval. A max-retry count is required to be specified with this strategy. max_retries and interval_in_seconds must be specified.
EXPONENTIAL_BACKOFF The task will be retried after an exponentially increasing period of time with each failure. A jitter is added to each exponential interval so that concurrently failing tasks of the same type do not end up retrying after the exact same exponential interval. A max-retry count is required to be specified with this strategy. max_retries and interval_in_seconds must be specified.
RESTART_INTEGRATION_WITH_BACKOFF The entire integration will be restarted with the initial parameters that were set when the event was fired. A max-retry count is required to be specified with this strategy. max_retries and interval_in_seconds must be specified.

GoogleCloudIntegrationsV1alphaGenerateTokenResponse

Returns success or error message
Fields
message

string

The message that notifies the user if the request succeeded or not.

GoogleCloudIntegrationsV1alphaGetBundleResponse

Response for GetBundle.
Fields
config

object (GoogleCloudIntegrationsV1alphaIntegrationBundleConfig)

It contains the bundle data

GoogleCloudIntegrationsV1alphaGetClientMetadataResponse

Response for the GetClientMetadata rpc
Fields
properties

object (GoogleCloudIntegrationsV1alphaProjectProperties)

Required. Required: The client configuration that was requested

GoogleCloudIntegrationsV1alphaGetClientResponse

Response for the GetClient rpc
Fields
client

object (GoogleCloudIntegrationsV1alphaClientConfig)

Required. Required: The client configuration that was requested

GoogleCloudIntegrationsV1alphaIntParameterArray

This message only contains a field of integer array.
Fields
intValues[]

string (int64 format)

Integer array.

GoogleCloudIntegrationsV1alphaIntegration

The integration definition.
Fields
active

boolean

Required. If any integration version is published.

description

string

Optional.

name

string

Required. The resource name of the integration.

updateTime

string (Timestamp format)

Output only. Auto-generated.

GoogleCloudIntegrationsV1alphaIntegrationAlertConfig

Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
Fields
aggregationPeriod

string

The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week). For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.

alertThreshold

integer (int32 format)

For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.

disableAlert

boolean

Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this integration alert.

displayName

string

Name of the alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the integration.

durationThreshold

string (Duration format)

Should be specified only for AVERAGE_DURATION and PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.

metricType

enum

The type of metric.

Enum type. Can be one of the following:
METRIC_TYPE_UNSPECIFIED The default value. Metric type should always be set to one of the other non-default values, otherwise it will result in an INVALID_ARGUMENT error.
EVENT_ERROR_RATE Specifies alerting on the rate of errors for the enclosing integration.
EVENT_WARNING_RATE Specifies alerting on the rate of warnings for the enclosing integration. Warnings use the same enum values as errors.
TASK_ERROR_RATE Specifies alerting on the rate of errors for any task in the enclosing integration.
TASK_WARNING_RATE Specifies alerting on the rate of warnings for any task in the enclosing integration.
TASK_RATE Specifies alerting on the rate of executions over all tasks in the enclosing integration.
EVENT_RATE Specifies alerting on the number of events executed in the given aggregation_period.
EVENT_AVERAGE_DURATION Specifies alerting on the average duration of executions for this integration.
EVENT_PERCENTILE_DURATION Specifies alerting on the duration value of a particular percentile of integration executions. E.g. If 10% or more of the integration executions have durations above 5 seconds, alert.
TASK_AVERAGE_DURATION Specifies alerting on the average duration of any task in the enclosing integration,
TASK_PERCENTILE_DURATION Specifies alerting on the duration value of a particular percentile of any task executions within the enclosing integration. E.g. If 10% or more of the task executions in the integration have durations above 5 seconds, alert.
onlyFinalAttempt

boolean

For either events or tasks, depending on the type of alert, count only final attempts, not retries.

thresholdType

enum

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.

Enum type. Can be one of the following:
THRESHOLD_TYPE_UNSPECIFIED Default.
EXPECTED_MIN Note that this field will only trigger alerts if the integration specifying it runs at least once in 24 hours (which is our in-memory retention period for monarch streams). Also note that aggregation_period for this alert configuration must be less than 24 hours. Min value threshold.
EXPECTED_MAX Max value threshold.
thresholdValue

object (GoogleCloudIntegrationsV1alphaIntegrationAlertConfigThresholdValue)

The metric value, above or below which the alert should be triggered.

GoogleCloudIntegrationsV1alphaIntegrationAlertConfigThresholdValue

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.
Fields
absolute

string (int64 format)

Absolute value threshold.

percentage

integer (int32 format)

Percentage threshold.

GoogleCloudIntegrationsV1alphaIntegrationBundleConfig

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.
Fields
integrations[]

string

A bundle of integrations that can be executed by the task at runtime.

serviceAccount

string

Output only. The service account created and owned by IP and added to the customers GCP project.

GoogleCloudIntegrationsV1alphaIntegrationParameter

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.
Fields
dataType

enum

Type of the parameter.

Enum type. Can be one of the following:
INTEGRATION_PARAMETER_DATA_TYPE_UNSPECIFIED Unspecified.
STRING_VALUE String.
INT_VALUE Integer.
DOUBLE_VALUE Double Number.
BOOLEAN_VALUE Boolean.
STRING_ARRAY String Array.
INT_ARRAY Integer Array.
DOUBLE_ARRAY Double Number Array.
BOOLEAN_ARRAY Boolean Array.
JSON_VALUE Json.
PROTO_VALUE Proto Value (Internal use only).
PROTO_ARRAY Proto Array (Internal use only).
defaultValue

object (GoogleCloudIntegrationsV1alphaValueType)

Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.

displayName

string

The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".

inputOutputType

enum

Specifies the input/output type for the parameter.

Enum type. Can be one of the following:
IN_OUT_TYPE_UNSPECIFIED Default.
IN Input parameters for the integration. EventBus validates that these parameters exist in the integrations before execution.
OUT Output Parameters for the integration. EventBus will only return the integration parameters tagged with OUT in the response back.
IN_OUT Input and Output Parameters. These can be used as both input and output. EventBus will validate for the existence of these parameters before execution and will also return this parameter back in the response.
isTransient

boolean

Whether this parameter is a transient parameter.

jsonSchema

string

This schema will be used to validate runtime JSON-typed values of this parameter.

key

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.

producer

string

The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.

searchable

boolean

Searchable in the execution log or not.

GoogleCloudIntegrationsV1alphaIntegrationVersion

The integration version definition.
Fields
createTime

string (Timestamp format)

Output only. Auto-generated.

databasePersistencePolicy

enum

Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index.

Enum type. Can be one of the following:
DATABASE_PERSISTENCE_POLICY_UNSPECIFIED Enables persistence for all execution data.
DATABASE_PERSISTENCE_DISABLED Disables persistence for all execution data.
description

string

Optional. The integration description.

integrationParameters[]

object (GoogleCloudIntegrationsV1alphaIntegrationParameter)

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.

integrationParametersInternal

object (EnterpriseCrmFrontendsEventbusProtoWorkflowParameters)

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.

lastModifierEmail

string

Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.

lockHolder

string

Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.

name

string

Output only. Auto-generated primary key.

origin

enum

Optional. The origin that indicates where this integration is coming from.

Enum type. Can be one of the following:
UNSPECIFIED (No description provided)
UI Workflow is being created via event bus UI.
PIPER_V2 User checked in this workflow in Piper as v2 textproto format and we synced it into spanner.
PIPER_V3 User checked in this workflow in piper as v3 textproto format and we synced it into spanner.
APPLICATION_IP_PROVISIONING Workflow is being created via Standalone IP Provisioning
parentTemplateId

string

Optional. The id of the template which was used to create this integration_version.

snapshotNumber

string (int64 format)

Optional. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflow_name, org_id latest(snapshot_number)]. However, last created snapshot need not be same as the HEAD. So users should always use "HEAD" tag to identify the head.

state

enum

Output only. User should not set it as an input.

Enum type. Can be one of the following:
INTEGRATION_STATE_UNSPECIFIED Default.
DRAFT Draft.
ACTIVE Active.
ARCHIVED Archived.
SNAPSHOT Snapshot.
status

enum

Output only. Generated by eventbus. User should not set it as an input.

Enum type. Can be one of the following:
UNKNOWN (No description provided)
DRAFT (No description provided)
ACTIVE (No description provided)
ARCHIVED (No description provided)
SNAPSHOT (No description provided)
taskConfigs[]

object (GoogleCloudIntegrationsV1alphaTaskConfig)

Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.

taskConfigsInternal[]

object (EnterpriseCrmFrontendsEventbusProtoTaskConfig)

Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.

teardown

object (EnterpriseCrmEventbusProtoTeardown)

Optional. Contains a graph of tasks that will be executed before putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), regardless of success or failure, similar to "finally" in code.

triggerConfigs[]

object (GoogleCloudIntegrationsV1alphaTriggerConfig)

Optional. Trigger configurations.

triggerConfigsInternal[]

object (EnterpriseCrmFrontendsEventbusProtoTriggerConfig)

Optional. Trigger configurations.

updateTime

string (Timestamp format)

Output only. Auto-generated.

userLabel

string

Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.

GoogleCloudIntegrationsV1alphaJwt

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.
Fields
jwt

string

The token calculated by the header, payload and signature.

jwtHeader

string

Identifies which algorithm is used to generate the signature.

jwtPayload

string

Contains a set of claims. The JWT specification defines seven Registered Claim Names which are the standard fields commonly included in tokens. Custom claims are usually also included, depending on the purpose of the token.

secret

string

User's pre-shared secret to sign the token.

GoogleCloudIntegrationsV1alphaLiftSuspensionRequest

Request for lift Suspension
Fields
suspensionResult

string

User passed in suspension result and will be used to control workflow execution branching behavior by setting up corresponnding edge condition with suspension result. For example, if you want to lift the suspension, you can pass "Approved", or if you want to reject the suspension and terminate workfloe execution, you can pass "Rejected" and terminate the workflow execution with configuring the edge condition.

GoogleCloudIntegrationsV1alphaLiftSuspensionResponse

Response of lift Suspense
Fields
eventExecutionInfoId

string

Execution Id that will be returned

GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectRequest

Request for LinkAppsScriptProject rpc call.
Fields
scriptId

string

The id of the Apps Script project to be linked.

GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectResponse

Response for LinkAppsScriptProject rpc call.
Fields
scriptId

string

The id of the linked Apps Script project.

GoogleCloudIntegrationsV1alphaListAuthConfigsResponse

Response to list AuthConfigs.
Fields
authConfigs[]

object (GoogleCloudIntegrationsV1alphaAuthConfig)

The list of AuthConfigs retrieved.

nextPageToken

string

The token used to retrieve the next page of results.

GoogleCloudIntegrationsV1alphaListCertificatesResponse

Response to list Certificates.
Fields
certificates[]

object (GoogleCloudIntegrationsV1alphaCertificate)

The list of Certificates retrieved.

nextPageToken

string

The token used to retrieve the next page of results.

GoogleCloudIntegrationsV1alphaListConnectionsResponse

Response containing Connections listed by region.
Fields
connections[]

object (GoogleCloudConnectorsV1Connection)

Connections.

nextPageToken

string

Next page token.

GoogleCloudIntegrationsV1alphaListExecutionSnapshotsResponse

Response for listing the integration execution snapshot.
Fields
executionSnapshots[]

object (EnterpriseCrmEventbusProtoEventExecutionSnapshot)

Required. The detailed information for the execution snapshot.

nextPageToken

string

The token returned in the previous response.

GoogleCloudIntegrationsV1alphaListExecutionsResponse

Response for listing the integration execution data.
Fields
executionInfos[]

object (EnterpriseCrmFrontendsEventbusProtoEventExecutionInfo)

Required. The detailed information of requested executions.

executions[]

object (GoogleCloudIntegrationsV1alphaExecution)

The detailed information of requested executions

nextPageToken

string

The token used to retrieve the next page results.

GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse

Response for ListIntegrationVersions.
Fields
integrationVersions[]

object (GoogleCloudIntegrationsV1alphaIntegrationVersion)

The integrations which match the request.

nextPageToken

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

noPermission

boolean

Whether the user has no permission on the version or not.

GoogleCloudIntegrationsV1alphaListIntegrationsResponse

Response for ListIntegrations.
Fields
integrations[]

object (GoogleCloudIntegrationsV1alphaIntegration)

The integrations which match the request.

nextPageToken

string

The next page token for the response.

GoogleCloudIntegrationsV1alphaListRuntimeActionSchemasResponse

Response for listing RuntimeActionSchemas for a specific Connection.
Fields
nextPageToken

string

Next page token.

runtimeActionSchemas[]

object (GoogleCloudIntegrationsV1alphaRuntimeActionSchema)

Runtime action schemas.

GoogleCloudIntegrationsV1alphaListRuntimeEntitySchemasResponse

Response for listing RuntimeEntitySchemas for a specific Connection.
Fields
nextPageToken

string

Next page token.

runtimeEntitySchemas[]

object (GoogleCloudIntegrationsV1alphaRuntimeEntitySchema)

Runtime entity schemas.

GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse

Response to list SfdcChannels.
Fields
nextPageToken

string

The token used to retrieve the next page of results.

sfdcChannels[]

object (GoogleCloudIntegrationsV1alphaSfdcChannel)

The list of SfdcChannels retrieved.

GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse

Response to list SfdcInstances.
Fields
nextPageToken

string

The token used to retrieve the next page of results.

sfdcInstances[]

object (GoogleCloudIntegrationsV1alphaSfdcInstance)

The list of SfdcInstances retrieved.

GoogleCloudIntegrationsV1alphaListSuspensionsResponse

Response for Suspensions.ListSuspensions.
Fields
nextPageToken

string

Token to retrieve the next page of results.

suspensions[]

object (GoogleCloudIntegrationsV1alphaSuspension)

The suspensions for the relevant execution which the caller has permissions to view and resolve.

GoogleCloudIntegrationsV1alphaListTaskEntitiesResponse

This is a UI only method and will be moved away. Response for ListTaskEntities.
Fields
taskEntities[]

object (EnterpriseCrmFrontendsEventbusProtoTaskEntity)

The list of the tasks.

GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequest

The request to get data for monarch connector config.
Fields
duration

string (Duration format)

How long the series data range: "1h","1d",etc.

endTime

string (Timestamp format)

Final time to query over, or the current time if left unset.

mashQuery

object (GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequestMashQuery)

Required. Query for searching data in monarch.

metricFieldTable

boolean

Returns a table of all possible metric field values within the specified duration, ignoring any data samples. Useful for autocomplete functionality.

outputPeriod

string (Duration format)

The output period for the query. Must be set if there is a window operation within the query and unset otherwise.

responseTemplate

enum

Required. Template for response.

Enum type. Can be one of the following:
DATA_FORMAT_UNSPECIFIED Unknown data format
TABLE_CONFIG Table data
APLOSE_SERIES_LIST_CONFIG Aplose series data

GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequestGroupBy

MashQuery GroupBy parameters.
Fields
fields[]

string

Optional. optional, metrics list for GroupBy.

reducer

string

Optional. optional, reduce function for GroupBy.

GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequestMashQuery

The MashQuery for searching data, set both queries for Join Operation.
Fields
firstQuery

object (GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequestMashQueryComponent)

Required. The components for constructing a mash query. Set "point_operation" if this is a single query

operationMode

object (GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequestMashQueryOperationMode)

Optional. optional, only set when joining 2 queries. By default join 2 queries with join operation.

secondQuery

object (GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequestMashQueryComponent)

Optional. optional, only set when joining 2 queries. Set "point_operation" for joined query.

GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequestMashQueryComponent

The components for constructing MashQuery.
Fields
borgTaskMetric

enum

Required. The metric for monarch.BorgTask.

Enum type. Can be one of the following:
BORG_TASK_METRIC_UNSPECIFIED Unknown metric
TASK_INDIVIDUAL_COUNT Metric end with: "/task/individual_count".
EVENT_COUNT Metric end with: "/event/count".
EVENT_DURATION Metric end with: "/event/duration".
TASK_INDIVIDUAL_DURATION Metric end with: "/task/individual_duration".
dataFilters[]

string

Optional. optional, filters on fetched data, "metric:client_id" not supported.

fetchFilters[]

string

Optional. optional, filters for Fetch Raw, "metric:client_id" not supported.

groupBy

object (GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequestGroupBy)

Optional. optional, GroupBy variables.

pointOperation

string

Optional. optional, Point Operation on single query or joined query.

timeDelta

string

Required. Window time delta.

GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequestMashQueryOperationMode

Operation between 2 query
Fields
joinConfig

object (GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequestMashQueryOperationModeJoinConfig)

Optional. join operation

operationType

enum

Optional. optional operation types.

Enum type. Can be one of the following:
OPERATION_TYPE_UNSPECIFIED By default join.
UNION Union operation
JOIN Join Operation
unionConfig

object (GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequestMashQueryOperationModeUnionConfig)

Optional. union operation

GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequestMashQueryOperationModeUnionConfig

Union operation
Fields
reducer

string

Optional. optional, reduce function

GoogleCloudIntegrationsV1alphaMonitorExecutionStatsResponse

The response for getting Execution stats.
Fields
aplosSeriesListData

object (EnterpriseCrmCardsTemplatesAplosSeriesListData)

List of points.

tableData

object (EnterpriseCrmCardsTabularData)

Data in form of table.

GoogleCloudIntegrationsV1alphaNextTask

The task that is next in line to be executed, if the condition specified evaluated to true.
Fields
condition

string

Standard filter expression for this task to become an eligible next task.

description

string

User-provided description intended to give additional business context about the task.

displayName

string

User-provided label that is attached to this edge in the UI.

taskConfigId

string

ID of the next task.

taskId

string

Task number of the next task.

GoogleCloudIntegrationsV1alphaOAuth2AuthorizationCode

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.
Fields
accessToken

object (GoogleCloudIntegrationsV1alphaAccessToken)

The access token received from the token endpoint.

applyReauthPolicy

boolean

Indicates if the user has opted in Google Reauth Policy. If opted in, the refresh token will be valid for 20 hours, after which time users must re-authenticate in order to obtain a new one.

authCode

string

The Auth Code that is used to initially retrieve the access token.

authEndpoint

string

The auth url endpoint to send the auth code request to.

authParams

object (GoogleCloudIntegrationsV1alphaParameterMap)

The auth parameters sent along with the auth code request.

clientId

string

The client's id.

clientSecret

string

The client's secret.

requestType

enum

Represent how to pass parameters to fetch access token

Enum type. Can be one of the following:
REQUEST_TYPE_UNSPECIFIED Unspecified request type
REQUEST_BODY To pass all the parameters in post body.
QUERY_PARAMETERS To pass all the parameters as a part of query parameter.
ENCODED_HEADER To pass client id and client secret as base 64 encoding of client_id:client_password and rest parameters in post body.
scope

string

A space-delimited list of requested scope permissions.

tokenEndpoint

string

The token url endpoint to send the token request to.

tokenParams

object (GoogleCloudIntegrationsV1alphaParameterMap)

The token parameters sent along with the token request.

GoogleCloudIntegrationsV1alphaOAuth2ClientCredentials

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.
Fields
accessToken

object (GoogleCloudIntegrationsV1alphaAccessToken)

Access token fetched from the authorization server.

clientId

string

The client's ID.

clientSecret

string

The client's secret.

requestType

enum

Represent how to pass parameters to fetch access token

Enum type. Can be one of the following:
REQUEST_TYPE_UNSPECIFIED Unspecified request type
REQUEST_BODY To pass all the parameters in post body.
QUERY_PARAMETERS To pass all the parameters as a part of query parameter.
ENCODED_HEADER To pass client id and client secret as base 64 encoding of client_id:client_password and rest parameters in post body.
scope

string

A space-delimited list of requested scope permissions.

tokenEndpoint

string

The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.

tokenParams

object (GoogleCloudIntegrationsV1alphaParameterMap)

Token parameters for the auth request.

GoogleCloudIntegrationsV1alphaOAuth2ResourceOwnerCredentials

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.
Fields
accessToken

object (GoogleCloudIntegrationsV1alphaAccessToken)

Access token fetched from the authorization server.

clientId

string

The client's ID.

clientSecret

string

The client's secret.

password

string

The user's password.

requestType

enum

Represent how to pass parameters to fetch access token

Enum type. Can be one of the following:
REQUEST_TYPE_UNSPECIFIED Unspecified request type
REQUEST_BODY To pass all the parameters in post body.
QUERY_PARAMETERS To pass all the parameters as a part of query parameter.
ENCODED_HEADER To pass client id and client secret as base 64 encoding of client_id:client_password and rest parameters in post body.
scope

string

A space-delimited list of requested scope permissions.

tokenEndpoint

string

The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.

tokenParams

object (GoogleCloudIntegrationsV1alphaParameterMap)

Token parameters for the auth request.

username

string

The user's username.

GoogleCloudIntegrationsV1alphaOidcToken

OIDC Token
Fields
audience

string

Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for.

serviceAccountEmail

string

The service account email to be used as the identity for the token.

token

string

ID token obtained for the service account

tokenExpireTime

string (Timestamp format)

The approximate time until the token retrieved is valid.

GoogleCloudIntegrationsV1alphaParameterMap

A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified.
Fields
entries[]

object (GoogleCloudIntegrationsV1alphaParameterMapEntry)

A list of parameter map entries.

keyType

enum

Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.

Enum type. Can be one of the following:
INTEGRATION_PARAMETER_DATA_TYPE_UNSPECIFIED Unspecified.
STRING_VALUE String.
INT_VALUE Integer.
DOUBLE_VALUE Double Number.
BOOLEAN_VALUE Boolean.
STRING_ARRAY String Array.
INT_ARRAY Integer Array.
DOUBLE_ARRAY Double Number Array.
BOOLEAN_ARRAY Boolean Array.
JSON_VALUE Json.
PROTO_VALUE Proto Value (Internal use only).
PROTO_ARRAY Proto Array (Internal use only).
valueType

enum

Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.

Enum type. Can be one of the following:
INTEGRATION_PARAMETER_DATA_TYPE_UNSPECIFIED Unspecified.
STRING_VALUE String.
INT_VALUE Integer.
DOUBLE_VALUE Double Number.
BOOLEAN_VALUE Boolean.
STRING_ARRAY String Array.
INT_ARRAY Integer Array.
DOUBLE_ARRAY Double Number Array.
BOOLEAN_ARRAY Boolean Array.
JSON_VALUE Json.
PROTO_VALUE Proto Value (Internal use only).
PROTO_ARRAY Proto Array (Internal use only).

GoogleCloudIntegrationsV1alphaParameterMapEntry

Entry is a pair of key and value.
Fields
key

object (GoogleCloudIntegrationsV1alphaParameterMapField)

Key of the map entry.

value

object (GoogleCloudIntegrationsV1alphaParameterMapField)

Value of the map entry.

GoogleCloudIntegrationsV1alphaParameterMapField

Field represents either the key or value in an entry.
Fields
literalValue

object (GoogleCloudIntegrationsV1alphaValueType)

Passing a literal value.

referenceKey

string

Referencing one of the Integration variables.

GoogleCloudIntegrationsV1alphaProjectProperties

Metadata information for the given project
Fields
ipEnablementState

enum

An enum value of what the enablement state is for the given project

Enum type. Can be one of the following:
IP_ENABLEMENT_STATE_UNSPECIFIED The client enablement status is unspecified
IP_ENABLEMENT_STATE_STANDALONE The client is enabled on Standalone IP
IP_ENABLEMENT_STATE_APIGEE The client is enabled on Apigee
IP_ENABLEMENT_STATE_APIGEE_ENTITLED The client is entitled for Apigee but not enabled
provisionedRegions[]

string

A list of provisioned regions on the current project

GoogleCloudIntegrationsV1alphaProvisionClientRequest

Request for the Provision rpc
Fields
cloudKmsConfig

object (GoogleCloudIntegrationsV1alphaCloudKmsConfig)

Required. Required: Cloud KMS config for AuthModule to encrypt/decrypt credentials.

createSampleWorkflows

boolean

Optional. Indicates if sample workflow should be created along with provisioning

GoogleCloudIntegrationsV1alphaResolveSuspensionRequest

Request for [Suspensions.ResolveSuspensions].
Fields
suspension

object (GoogleCloudIntegrationsV1alphaSuspension)

Suspension, containing the event_execution_info_id, task_id, and state to set on the corresponding suspension record.

GoogleCloudIntegrationsV1alphaRuntimeActionSchema

Metadata of an action, including schemas for its inputs and outputs.
Fields
action

string

Name of the action.

inputSchema

string

Input parameter schema for the action.

outputSchema

string

Output parameter schema for the action.

GoogleCloudIntegrationsV1alphaRuntimeEntitySchema

Metadata of an entity, including a schema for its properties.
Fields
arrayFieldSchema

string

The above schema, but for an array of the associated entity.

entity

string

Name of the entity.

fieldSchema

string

List of fields in the entity.

GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest

The request for scheduling an integration.
Fields
inputParameters

map (key: string, value: object (GoogleCloudIntegrationsV1alphaValueType))

Optional. Input parameters used by integration execution.

parameterEntries[]

object (EnterpriseCrmFrontendsEventbusProtoParameterEntry)

Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.

parameters

object (EnterpriseCrmEventbusProtoEventParameters)

Passed in as parameters to each integration execution.

requestId

string

This is used to de-dup incoming request: if the duplicate request was detected, the response from the previous execution is returned.

scheduleTime

string (Timestamp format)

The time that the integration should be executed. If the time is less or equal to the current time, the integration is executed immediately.

triggerId

string

Matched against all {@link TriggerConfig}s across all integrations. i.e. TriggerConfig.trigger_id.equals(trigger_id)

GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse

The response for executing an integration.
Fields
executionInfoIds[]

string

The execution info id for the executed integrations.

GoogleCloudIntegrationsV1alphaServiceAccountCredentials

Represents the service account which can be used to generate access token for authenticating the service call.
Fields
scope

string

A space-delimited list of requested scope permissions.

serviceAccount

string

Name of the service account that has the permission to make the request.

GoogleCloudIntegrationsV1alphaSfdcChannel

The SfdcChannel that points to a CDC or Platform Event Channel.
Fields
channelTopic

string

The Channel topic defined by salesforce once an channel is opened

createTime

string (Timestamp format)

Output only. Time when the channel is created

deleteTime

string (Timestamp format)

Output only. Time when the channel was deleted. Empty if not deleted.

description

string

The description for this channel

displayName

string

Client level unique name/alias to easily reference a channel.

isActive

boolean

Indicated if a channel has any active integrations referencing it. Set to false when the channel is created, and set to true if there is any integration published with the channel configured in it.

lastReplayId

string

Last sfdc messsage replay id for channel

name

string

Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.

updateTime

string (Timestamp format)

Output only. Time when the channel was last updated

GoogleCloudIntegrationsV1alphaSfdcInstance

The SfdcInstance resource use to hold channels and connection config data.
Fields
authConfigId[]

string

A list of AuthConfigs that can be tried to open the channel to SFDC

createTime

string (Timestamp format)

Output only. Time when the instance is created

deleteTime

string (Timestamp format)

Output only. Time when the instance was deleted. Empty if not deleted.

description

string

A description of the sfdc instance.

displayName

string

User selected unique name/alias to easily reference an instance.

name

string

Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.

serviceAuthority

string

URL used for API calls after authentication (the login authority is configured within the referenced AuthConfig).

sfdcOrgId

string

The SFDC Org Id. This is defined in salesforce.

updateTime

string (Timestamp format)

Output only. Time when the instance was last updated

GoogleCloudIntegrationsV1alphaStringParameterArray

This message only contains a field of string array.
Fields
stringValues[]

string

String array.

GoogleCloudIntegrationsV1alphaSuccessPolicy

Policy that dictates the behavior for the task after it completes successfully.
Fields
finalState

enum

State to which the execution snapshot status will be set if the task succeeds.

Enum type. Can be one of the following:
FINAL_STATE_UNSPECIFIED UNSPECIFIED.
SUCCEEDED The default behavior, where successful tasks will be marked as SUCCEEDED.
SUSPENDED Sets the state to SUSPENDED after executing. This is required for SuspensionTask; event execution will continue once the user calls ResolveSuspensions with the event_execution_info_id and the task number.

GoogleCloudIntegrationsV1alphaSuspension

A record representing a suspension.
Fields
approvalConfig

object (GoogleCloudIntegrationsV1alphaSuspensionApprovalConfig)

Controls the notifications and approval permissions for this suspension.

audit

object (GoogleCloudIntegrationsV1alphaSuspensionAudit)

Metadata pertaining to the resolution of this suspension.

createTime

string (Timestamp format)

Output only. Auto-generated.

eventExecutionInfoId

string

Required. ID of the associated execution.

integration

string

Required. The name of the originating integration.

lastModifyTime

string (Timestamp format)

Output only. Auto-generated.

name

string

Resource name for suspensions suspension/{suspension_id}

state

enum

Required. State of this suspension, indicating what action a resolver has taken.

Enum type. Can be one of the following:
RESOLUTION_STATE_UNSPECIFIED Unset state.
PENDING The suspension has not yet been resolved.
REJECTED The resolver has rejected the suspension.
LIFTED The resolver has lifted the suspension.
suspensionConfig

object (EnterpriseCrmEventbusProtoSuspensionConfig)

Controls the notifications and resolver permissions for this suspension.

taskId

string

Required. Task id of the associated SuspensionTask.

GoogleCloudIntegrationsV1alphaSuspensionApprovalConfig

Configurations for approving the Suspension.
Fields
customMessage

string

Information to provide for recipients.

emailAddresses[]

string

Email addresses to send approval request to.

expiration

object (GoogleCloudIntegrationsV1alphaSuspensionApprovalExpiration)

Indicates the next steps when no external actions happen on the suspension.

GoogleCloudIntegrationsV1alphaSuspensionApprovalExpiration

Expiration configs for the approval request.
Fields
expireTime

string (Timestamp format)

Output only. Time after which the suspension expires, if no action taken.

liftWhenExpired

boolean

Whether the suspension will be REJECTED or LIFTED upon expiration. REJECTED is the default behavior.

remindTime

string (Timestamp format)

Time after the previous suspension action reminder, if any, is sent using the selected notification option, for a suspension which is still PENDING_UNSPECIFIED.

GoogleCloudIntegrationsV1alphaSuspensionAudit

Contains when and by whom the suspension was resolved.
Fields
resolveTime

string (Timestamp format)

Time at which this suspension was resolved.

resolver

string

Email address of the person who resolved this suspension.

GoogleCloudIntegrationsV1alphaTakeoverEditLockResponse

Response for TakeoverEditLock.
Fields
integrationVersion

object (GoogleCloudIntegrationsV1alphaIntegrationVersion)

Version after the lock is acquired by the new user.

GoogleCloudIntegrationsV1alphaTaskConfig

The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.
Fields
description

string

Optional. User-provided description intended to give additional business context about the task.

displayName

string

Optional. User-provided label that is attached to this TaskConfig in the UI.

failurePolicy

object (GoogleCloudIntegrationsV1alphaFailurePolicy)

Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).

jsonValidationOption

enum

Optional. If set, overrides the option configured in the Task implementation class.

Enum type. Can be one of the following:
JSON_VALIDATION_OPTION_UNSPECIFIED As per the default behavior, no validation will be run. Will not override any option set in a Task.
SKIP Do not run any validation against JSON schemas.
PRE_EXECUTION Validate all potential input JSON parameters against schemas specified in IntegrationParameter.
POST_EXECUTION Validate all potential output JSON parameters against schemas specified in IntegrationParameter.
PRE_POST_EXECUTION Perform both PRE_EXECUTION and POST_EXECUTION validations.
nextTasks[]

object (GoogleCloudIntegrationsV1alphaNextTask)

Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by event_config_id. Each of these next tasks are executed only if the condition associated with them evaluates to true.

nextTasksExecutionPolicy

enum

Optional. The policy dictating the execution of the next set of tasks for the current task.

Enum type. Can be one of the following:
NEXT_TASKS_EXECUTION_POLICY_UNSPECIFIED Default.
RUN_ALL_MATCH Execute all the tasks that satisfy their associated condition.
RUN_FIRST_MATCH Execute the first task that satisfies the associated condition.
parameters

map (key: string, value: object (GoogleCloudIntegrationsV1alphaEventParameter))

Optional. The customized parameters the user can pass to this task.

successPolicy

object (GoogleCloudIntegrationsV1alphaSuccessPolicy)

Optional. Determines what action to take upon successful task completion.

synchronousCallFailurePolicy

object (GoogleCloudIntegrationsV1alphaFailurePolicy)

Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).

task

string

Optional. The name for the task.

taskExecutionStrategy

enum

Optional. The policy dictating the execution strategy of this task.

Enum type. Can be one of the following:
TASK_EXECUTION_STRATEGY_UNSPECIFIED Default. If the strategy is not set explicitly, it will default to WHEN_ALL_SUCCEED.
WHEN_ALL_SUCCEED Wait until all of its previous tasks finished execution, then verify at least one of the edge conditions is met, and execute if possible. This should be considered as WHEN_ALL_TASKS_SUCCEED.
WHEN_ANY_SUCCEED Start execution as long as any of its previous tasks finished execution and the corresponding edge condition is met (since we will execute if only that succeeding edge condition is met).
WHEN_ALL_TASKS_AND_CONDITIONS_SUCCEED Wait until all of its previous tasks finished execution, then verify the all edge conditions are met and execute if possible.
taskId

string

Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field next_tasks.task_id).

taskTemplate

string

Optional. Used to define task-template name if task is of type task-template

GoogleCloudIntegrationsV1alphaTaskExecutionDetails

Contains the details of the execution of this task.
Fields
taskAttemptStats[]

object (GoogleCloudIntegrationsV1alphaAttemptStats)

Status for the current task execution attempt.

taskExecutionState

enum

The execution state of this task.

Enum type. Can be one of the following:
TASK_EXECUTION_STATE_UNSPECIFIED Default value.
PENDING_EXECUTION Task is waiting for its precondition tasks to finish to start the execution.
IN_PROCESS Task is under processing.
SUCCEED Task execution successfully finished. There's no more change after this state.
FAILED Task execution failed. There's no more change after this state.
FATAL Task execution failed and cause the whole event execution to fail immediately. There's no more change after this state.
RETRY_ON_HOLD Task execution failed and waiting for retry.
SKIPPED Task execution skipped. This happens when its precondition wasn't met, or the event execution been canceled before reach to the task. There's no more changes after this state.
CANCELLED Task execution canceled when in progress. This happens when event execution been canceled or any other task fall in fatal state.
PENDING_ROLLBACK Task is waiting for its dependency tasks' rollback to finish to start its rollback.
ROLLBACK_IN_PROCESS Task is rolling back.
ROLLEDBACK Task is rolled back. This is the state we will set regardless of rollback succeeding or failing.
SUSPENDED Task is a SuspensionTask which has executed once, creating a pending suspension.
taskNumber

string

Pointer to the task config it used for execution.

GoogleCloudIntegrationsV1alphaTestIntegrationsRequest

The request for testing an integration.
Fields
clientId

string

Required. This is used to identify the client on whose behalf the event will be executed.

deadlineSecondsTime

string (Timestamp format)

Optional. custom deadline of the rpc

inputParameters

map (key: string, value: object (GoogleCloudIntegrationsV1alphaValueType))

Optional. Input parameters used during integration execution.

integrationVersion

object (GoogleCloudIntegrationsV1alphaIntegrationVersion)

Required. integration config to execute the workflow

parameters

object (EnterpriseCrmFrontendsEventbusProtoEventParameters)

Optional. Passed in as parameters to each integration execution.

testMode

boolean

Optional. Can be specified in the event request, otherwise false (default). If true, enables tasks with condition "test_mode = true". If false, disables tasks with condition "test_mode = true" if global test mode (set by platform) is also false {@link EventBusConfig}.

triggerId

string

Required. The trigger id of the integration trigger config. If both trigger_id and client_id is present, the integration is executed from the start tasks provided by the matching trigger config otherwise it is executed from the default start tasks.

GoogleCloudIntegrationsV1alphaTestIntegrationsResponse

The response for testing an integration.
Fields
eventParameters

object (EnterpriseCrmFrontendsEventbusProtoEventParameters)

Details for the integration that were executed.

executionFailed

boolean

Is true if any execution in the integration failed. False otherwise.

executionId

string

The id of the execution corresponding to this run of integration.

parameterEntries[]

object (EnterpriseCrmFrontendsEventbusProtoParameterEntry)

Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.

parameters

map (key: string, value: object (GoogleCloudIntegrationsV1alphaValueType))

Optional. Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.

GoogleCloudIntegrationsV1alphaTriggerConfig

Configuration detail of a trigger.
Fields
alertConfig[]

object (GoogleCloudIntegrationsV1alphaIntegrationAlertConfig)

Optional. An alert threshold configuration for the [trigger + client + integration] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + integration] when published.

cloudSchedulerConfig

object (GoogleCloudIntegrationsV1alphaCloudSchedulerConfig)

Optional. Cloud Scheduler Trigger related metadata

description

string

Optional. User-provided description intended to give additional business context about the task.

label

string

Optional. The user created label for a particular trigger.

nextTasksExecutionPolicy

enum

Optional. Dictates how next tasks will be executed.

Enum type. Can be one of the following:
NEXT_TASKS_EXECUTION_POLICY_UNSPECIFIED Default.
RUN_ALL_MATCH Execute all the tasks that satisfy their associated condition.
RUN_FIRST_MATCH Execute the first task that satisfies the associated condition.
properties

map (key: string, value: string)

Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Pub/sub triggers.

startTasks[]

object (GoogleCloudIntegrationsV1alphaNextTask)

Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph).

triggerId

string

Optional. The backend trigger ID.

triggerNumber

string

Required. A number to uniquely identify each trigger config within the integration on UI.

triggerType

enum

Optional. Type of trigger

Enum type. Can be one of the following:
TRIGGER_TYPE_UNSPECIFIED Unknown.
CRON Trigger by scheduled time.
API Trigger by API call.
SFDC_CHANNEL Trigger by Salesforce Channel.
CLOUD_PUBSUB_EXTERNAL Trigger by Pub/Sub external.
SFDC_CDC_CHANNEL SFDC Channel Trigger for CDC.
CLOUD_SCHEDULER Trigger by Cloud Scheduler job.

GoogleCloudIntegrationsV1alphaUpdateBundleRequest

THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. Request message for Bundle update
Fields
config

object (GoogleCloudIntegrationsV1alphaIntegrationBundleConfig)

It contains the updated bundle data

GoogleCloudIntegrationsV1alphaUpdateBundleResponse

Response message for Bundle update
Fields
config

object (GoogleCloudIntegrationsV1alphaIntegrationBundleConfig)

Contains updated bundle config

GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest

Request for UploadIntegrationVersion.
Fields
content

string

The textproto of the integration_version.

fileFormat

enum

File format for upload request.

Enum type. Can be one of the following:
FILE_FORMAT_UNSPECIFIED Unspecified file format
JSON JSON File Format
YAML YAML File Format

GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse

Response for UploadIntegrationVersion.
Fields
integrationVersion

object (GoogleCloudIntegrationsV1alphaIntegrationVersion)

The uploaded integration.

GoogleCloudIntegrationsV1alphaUsernameAndPassword

Username and password pair.
Fields
password

string

Password to be used

username

string

Username to be used

GoogleCloudIntegrationsV1alphaValueType

The type of the parameter.
Fields
booleanArray

object (GoogleCloudIntegrationsV1alphaBooleanParameterArray)

Boolean Array.

booleanValue

boolean

Boolean.

doubleArray

object (GoogleCloudIntegrationsV1alphaDoubleParameterArray)

Double Number Array.

doubleValue

number (double format)

Double Number.

intArray

object (GoogleCloudIntegrationsV1alphaIntParameterArray)

Integer Array.

intValue

string (int64 format)

Integer.

jsonValue

string

Json.

stringArray

object (GoogleCloudIntegrationsV1alphaStringParameterArray)

String Array.

stringValue

string

String.

GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest

Use this request to post all workflows associated with a given trigger id. Next available id: 10
Fields
clientId

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

boolean

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

object (EnterpriseCrmEventbusProtoEventParameters)

Passed in as parameters to each workflow execution. Optional.

priority

enum

The request priority this request should be processed at. For internal users:

Enum type. Can be one of the following:
UNSPCIFIED Unspecified
SHEDDABLE Frequent partial and occasional full unavailability is expected and not pageable. * Requests to this band will be shed before all other requests. * This is the default for async calls sent from batch jobs.
SHEDDABLE_PLUS Partial unavailability is expected and is not necessarily pageable. * Requests to this band will be shed before any critical traffic. * This is the default for async calls sent from production jobs.
CRITICAL Any outage is a pageable event. * During a production outage requests in this band will only be shed before CRITICAL_PLUS. * This is the default for sync calls sent from production jobs.
CRITICAL_PLUS Any outage is a pageable event. * The guideline is for < 10% of requests to a service to be in this band. * During a production outage requests in this band will be prioritized above all others. * Opt-in to CRITICAL_PLUS when your workflow triggers by human.
requestId

string

Optional. This is used to de-dup incoming request: if the duplicate request was detected, the response from the previous execution is returned. Must have no more than 36 characters and contain only alphanumeric characters and hyphens.

scheduledTime

string (int64 format)

Optional. Time in milliseconds since epoch when the given event would be scheduled.

testMode

boolean

Optional. Sets test mode in {@link enterprise/crm/eventbus/event_message.proto}.

triggerId

string

Matched against all {@link TriggerConfig}s across all workflows. i.e. TriggerConfig.trigger_id.equals(trigger_id) Required.

workflowName

string

Optional. If provided, the workflow_name is used to filter all the matched workflows having same trigger_id+client_id. A combination of trigger_id, client_id and workflow_name identifies a unique workflow.