- 필수 기능
- 시작하기
- Glossary
- 표준 속성
- Guides
- Agent
- 통합
- 개방형텔레메트리
- 개발자
- Administrator's Guide
- API
- Datadog Mobile App
- CoScreen
- Cloudcraft
- 앱 내
- 서비스 관리
- 인프라스트럭처
- 애플리케이션 성능
- APM
- Continuous Profiler
- 스팬 시각화
- 데이터 스트림 모니터링
- 데이터 작업 모니터링
- 디지털 경험
- 소프트웨어 제공
- 보안
- AI Observability
- 로그 관리
- 관리
",t};e.buildCustomizationMenuUi=t;function n(e){let t='
",t}function s(e){let n=e.filter.currentValue||e.filter.defaultValue,t='${e.filter.label}
`,e.filter.options.forEach(s=>{let o=s.id===n;t+=``}),t+="${e.filter.label}
`,t+=`ancestors
Type: UNORDERED_LIST_STRING
cloud_kms_key
Type: STRING
Provider name: cloudKmsKey
Description: Optional. Cloud KMS resource name for the CMEK encryption key.
cloud_logging_details
Type: STRUCT
Provider name: cloudLoggingDetails
Description: Optional. Cloud Logging details for the integration version
cloud_logging_severity
STRING
cloudLoggingSeverity
CLOUD_LOGGING_SEVERITY_UNSPECIFIED
- UnspecifiedINFO
- If Severity selected is INFO
, then all the Integration Execution States (IN_PROCESS
, ON_HOLD
, SUCCEEDED
, SUSPENDED
, ERROR
, CANCELLED
) will be sent to Cloud Logging.ERROR
- If Severity selected is ERROR
, then only the following Integration Execution States (ERROR
, CANCELLED
) will be sent to Cloud Logging.WARNING
- If Severity selected is WARNING
, then only the following Integration Execution States (ERROR
, CANCELLED
) will be sent to Cloud Logging.enable_cloud_logging
BOOLEAN
enableCloudLogging
create_time
Type: TIMESTAMP
Provider name: createTime
Description: Output only. Auto-generated.
created_from_template
Type: STRING
Provider name: createdFromTemplate
Description: Optional. Optional. The resource name of the template from which the integration is created.
database_persistence_policy
Type: STRING
Provider name: databasePersistencePolicy
Description: Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index.
Possible values:
DATABASE_PERSISTENCE_POLICY_UNSPECIFIED
- Enables persistence for all execution data.DATABASE_PERSISTENCE_DISABLED
- Disables persistence for all execution data.DATABASE_PERSISTENCE_ASYNC
- Asynchronously persist all execution data.description
Type: STRING
Provider name: description
Description: Optional. The integration description.
enable_variable_masking
Type: BOOLEAN
Provider name: enableVariableMasking
Description: Optional. True if variable masking feature should be turned on for this version
error_catcher_configs
Type: UNORDERED_LIST_STRUCT
Provider name: errorCatcherConfigs
Description: Optional. Error Catch Task configuration for the integration. It’s optional.
description
STRING
description
error_catcher_id
STRING
errorCatcherId
error_catcher_number
STRING
errorCatcherNumber
label
STRING
label
position
STRUCT
position
x
INT32
x
y
INT32
y
start_error_tasks
UNORDERED_LIST_STRUCT
startErrorTasks
condition
STRING
condition
description
STRING
description
gcp_display_name
STRING
displayName
task_config_id
STRING
taskConfigId
task_id
STRING
taskId
gcp_status
Type: STRING
Provider name: status
Description: Output only. Generated by eventbus. User should not set it as an input.
Possible values:
UNKNOWN
DRAFT
ACTIVE
ARCHIVED
SNAPSHOT
integration_config_parameters
Type: UNORDERED_LIST_STRUCT
Provider name: integrationConfigParameters
Description: Optional. Config Parameters that are expected to be passed to the integration when an integration is published. This consists of all the parameters that are expected to provide configuration in the integration execution. This gives the user the ability to provide default values, value, add information like connection url, project based configuration value and also provide data types of each parameter.
parameter
STRUCT
parameter
contains_large_data
BOOLEAN
containsLargeData
data_type
STRING
dataType
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).NON_SERIALIZABLE_OBJECT
- // Non-serializable object (Internal use only).PROTO_ENUM
- Proto Enum (Internal use only).SERIALIZED_OBJECT_VALUE
- Serialized object (Internal use only).PROTO_ENUM_ARRAY
- Proto Enum Array (Internal use only).BYTES
- BYTES data types are not allowed for top-level params. They’re only meant to support protobufs with BYTES (sub)fields.BYTES_ARRAY
- BYTES_ARRAY data types are not allowed for top-level params. They’re only meant to support protobufs with BYTES (sub)fields.default_value
STRUCT
defaultValue
boolean_array
STRUCT
booleanArray
boolean_values
UNORDERED_LIST_BOOLEAN
booleanValues
boolean_value
BOOLEAN
booleanValue
double_array
STRUCT
doubleArray
double_values
UNORDERED_LIST_DOUBLE
doubleValues
double_value
DOUBLE
doubleValue
int_array
STRUCT
intArray
int_values
UNORDERED_LIST_INT64
intValues
int_value
INT64
intValue
json_value
STRING
jsonValue
string_array
STRUCT
stringArray
string_values
UNORDERED_LIST_STRING
stringValues
string_value
STRING
stringValue
description
STRING
description
gcp_display_name
STRING
displayName
input_output_type
STRING
inputOutputType
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.is_transient
BOOLEAN
isTransient
json_schema
STRING
jsonSchema
key
STRING
key
masked
BOOLEAN
masked
producer
STRING
producer
searchable
BOOLEAN
searchable
value
STRUCT
value
boolean_array
STRUCT
booleanArray
boolean_values
UNORDERED_LIST_BOOLEAN
booleanValues
boolean_value
BOOLEAN
booleanValue
double_array
STRUCT
doubleArray
double_values
UNORDERED_LIST_DOUBLE
doubleValues
double_value
DOUBLE
doubleValue
int_array
STRUCT
intArray
int_values
UNORDERED_LIST_INT64
intValues
int_value
INT64
intValue
json_value
STRING
jsonValue
string_array
STRUCT
stringArray
string_values
UNORDERED_LIST_STRING
stringValues
string_value
STRING
stringValue
integration_parameters
Type: UNORDERED_LIST_STRUCT
Provider name: integrationParameters
Description: 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.
contains_large_data
BOOLEAN
containsLargeData
data_type
STRING
dataType
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).NON_SERIALIZABLE_OBJECT
- // Non-serializable object (Internal use only).PROTO_ENUM
- Proto Enum (Internal use only).SERIALIZED_OBJECT_VALUE
- Serialized object (Internal use only).PROTO_ENUM_ARRAY
- Proto Enum Array (Internal use only).BYTES
- BYTES data types are not allowed for top-level params. They’re only meant to support protobufs with BYTES (sub)fields.BYTES_ARRAY
- BYTES_ARRAY data types are not allowed for top-level params. They’re only meant to support protobufs with BYTES (sub)fields.default_value
STRUCT
defaultValue
boolean_array
STRUCT
booleanArray
boolean_values
UNORDERED_LIST_BOOLEAN
booleanValues
boolean_value
BOOLEAN
booleanValue
double_array
STRUCT
doubleArray
double_values
UNORDERED_LIST_DOUBLE
doubleValues
double_value
DOUBLE
doubleValue
int_array
STRUCT
intArray
int_values
UNORDERED_LIST_INT64
intValues
int_value
INT64
intValue
json_value
STRING
jsonValue
string_array
STRUCT
stringArray
string_values
UNORDERED_LIST_STRING
stringValues
string_value
STRING
stringValue
description
STRING
description
gcp_display_name
STRING
displayName
input_output_type
STRING
inputOutputType
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.is_transient
BOOLEAN
isTransient
json_schema
STRING
jsonSchema
key
STRING
key
masked
BOOLEAN
masked
producer
STRING
producer
searchable
BOOLEAN
searchable
integration_parameters_internal
Type: STRUCT
Provider name: integrationParametersInternal
Description: Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
parameters
UNORDERED_LIST_STRUCT
parameters
attributes
STRUCT
attributes
data_type
STRING
dataType
DATA_TYPE_UNSPECIFIED
EMAIL
URL
CURRENCY
TIMESTAMP
DOMAIN_NAME
- Domain is a web url string with one top-level private domain and a suffix (for example: google.com, walmart.com)default_value
STRUCT
defaultValue
boolean_value
BOOLEAN
booleanValue
double_array
STRUCT
doubleArray
values
UNORDERED_LIST_DOUBLE
values
double_value
DOUBLE
doubleValue
int_array
STRUCT
intArray
values
UNORDERED_LIST_INT64
values
int_value
INT64
intValue
string_array
STRUCT
stringArray
values
UNORDERED_LIST_STRING
values
string_value
STRING
stringValue
is_required
BOOLEAN
isRequired
is_searchable
BOOLEAN
isSearchable
log_settings
STRUCT
logSettings
log_field_name
STRING
logFieldName
seed_period
STRING
seedPeriod
seed_scope
STRING
seedScope
masked
BOOLEAN
masked
read_only
BOOLEAN
readOnly
searchable
STRING
searchable
task_visibility
UNORDERED_LIST_STRING
taskVisibility
contains_large_data
BOOLEAN
containsLargeData
data_type
STRING
dataType
DATA_TYPE_UNSPECIFIED
STRING_VALUE
INT_VALUE
DOUBLE_VALUE
BOOLEAN_VALUE
PROTO_VALUE
SERIALIZED_OBJECT_VALUE
STRING_ARRAY
INT_ARRAY
DOUBLE_ARRAY
PROTO_ARRAY
PROTO_ENUM
BOOLEAN_ARRAY
PROTO_ENUM_ARRAY
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
NON_SERIALIZABLE_OBJECT
JSON_VALUE
default_value
STRUCT
defaultValue
boolean_array
Type: STRUCT
Provider name: booleanArray
boolean_values
UNORDERED_LIST_BOOLEAN
booleanValues
boolean_value
Type: BOOLEAN
Provider name: booleanValue
double_array
Type: STRUCT
Provider name: doubleArray
double_values
UNORDERED_LIST_DOUBLE
doubleValues
double_value
Type: DOUBLE
Provider name: doubleValue
int_array
Type: STRUCT
Provider name: intArray
int_values
UNORDERED_LIST_INT64
intValues
int_value
Type: INT64
Provider name: intValue
json_value
Type: STRING
Provider name: jsonValue
proto_array
Type: STRUCT
Provider name: protoArray
serialized_object_value
Type: STRUCT
Provider name: serializedObjectValue
string_array
Type: STRUCT
Provider name: stringArray
string_values
UNORDERED_LIST_STRING
stringValues
string_value
Type: STRING
Provider name: stringValue
description
STRING
description
in_out_type
STRING
inOutType
IN_OUT_TYPE_UNSPECIFIED
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.is_transient
BOOLEAN
isTransient
json_schema
STRING
jsonSchema
key
STRING
key
name
STRING
name
produced_by
STRUCT
producedBy
element_identifier
STRING
elementIdentifier
element_type
STRING
elementType
UNKNOWN_TYPE
TASK_CONFIG
TRIGGER_CONFIG
producer
STRING
producer
proto_def_name
STRING
protoDefName
proto_def_path
STRING
protoDefPath
required
BOOLEAN
required
labels
Type: UNORDERED_LIST_STRING
last_modifier_email
Type: STRING
Provider name: lastModifierEmail
Description: Optional. The last modifier’s email address. Generated based on the End User Credentials/LOAS role of the user making the call.
lock_holder
Type: STRING
Provider name: lockHolder
Description: Optional. The edit lock holder’s email address. Generated based on the End User Credentials/LOAS role of the user making the call.
name
Type: STRING
Provider name: name
Description: Output only. Auto-generated primary key.
organization_id
Type: STRING
origin
Type: STRING
Provider name: origin
Description: Optional. The origin that indicates where this integration is coming from.
Possible values:
UNSPECIFIED
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 ProvisioningTEST_CASE
- Workflow is being created via Test Case.parent
Type: STRING
parent_template_id
Type: STRING
Provider name: parentTemplateId
Description: Optional. The id of the template which was used to create this integration_version.
project_id
Type: STRING
project_number
Type: STRING
resource_name
Type: STRING
run_as_service_account
Type: STRING
Provider name: runAsServiceAccount
Description: Optional. The run-as service account email, if set and auth config is not configured, that will be used to generate auth token to be used in Connector task, Rest caller task and Cloud function task.
snapshot_number
Type: INT64
Provider name: snapshotNumber
Description: Output only. 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
Type: STRING
Provider name: state
Description: Output only. User should not set it as an input.
Possible values:
INTEGRATION_STATE_UNSPECIFIED
- Default.DRAFT
- Draft.ACTIVE
- Active.ARCHIVED
- Archived.SNAPSHOT
- Snapshot.tags
Type: UNORDERED_LIST_STRING
task_configs
Type: UNORDERED_LIST_STRUCT
Provider name: taskConfigs
Description: Optional. Task configuration for the integration. It’s optional, but the integration doesn’t do anything without task_configs.
conditional_failure_policies
STRUCT
conditionalFailurePolicies
default_failure_policy
STRUCT
defaultFailurePolicy
condition
STRING
condition
interval_time
TIMESTAMP
intervalTime
max_retries
INT32
maxRetries
retry_strategy
STRING
retryStrategy
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.failure_policies
UNORDERED_LIST_STRUCT
failurePolicies
condition
STRING
condition
interval_time
TIMESTAMP
intervalTime
max_retries
INT32
maxRetries
retry_strategy
STRING
retryStrategy
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.description
STRING
description
error_catcher_id
STRING
errorCatcherId
external_task_type
STRING
externalTaskType
EXTERNAL_TASK_TYPE_UNSPECIFIED
- Default value. External task type is not specifiedNORMAL_TASK
- Tasks belongs to the normal task flowsERROR_TASK
- Task belongs to the error catch task flowsfailure_policy
STRUCT
failurePolicy
condition
STRING
condition
interval_time
TIMESTAMP
intervalTime
max_retries
INT32
maxRetries
retry_strategy
STRING
retryStrategy
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.gcp_display_name
STRING
displayName
json_validation_option
STRING
jsonValidationOption
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.next_tasks
UNORDERED_LIST_STRUCT
nextTasks
event_config_id
. Each of these next tasks are executed only if the condition associated with them evaluates to true.condition
STRING
condition
description
STRING
description
gcp_display_name
STRING
displayName
task_config_id
STRING
taskConfigId
task_id
STRING
taskId
next_tasks_execution_policy
STRING
nextTasksExecutionPolicy
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.position
STRUCT
position
x
INT32
x
y
INT32
y
success_policy
STRUCT
successPolicy
final_state
STRING
finalState
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.synchronous_call_failure_policy
STRUCT
synchronousCallFailurePolicy
condition
STRING
condition
interval_time
TIMESTAMP
intervalTime
max_retries
INT32
maxRetries
retry_strategy
STRING
retryStrategy
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.task
STRING
task
task_execution_strategy
STRING
taskExecutionStrategy
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.task_id
STRING
taskId
next_tasks.task_id
).task_template
STRING
taskTemplate
task_configs_internal
Type: UNORDERED_LIST_STRUCT
Provider name: taskConfigsInternal
Description: Optional. Task configuration for the integration. It’s optional, but the integration doesn’t do anything without task_configs.
alert_configs
UNORDERED_LIST_STRUCT
alertConfigs
aggregation_period
STRING
aggregationPeriod
alert_disabled
BOOLEAN
alertDisabled
alert_name
STRING
alertName
client_id
STRING
clientId
duration_threshold_ms
INT64
durationThresholdMs
error_enum_list
STRUCT
errorEnumList
enum_strings
UNORDERED_LIST_STRING
enumStrings
filter_type
STRING
filterType
metric_type
STRING
metricType
num_aggregation_periods
INT32
numAggregationPeriods
only_final_attempt
BOOLEAN
onlyFinalAttempt
playbook_url
STRING
playbookUrl
threshold_type
STRING
thresholdType
UNSPECIFIED_THRESHOLD_TYPE
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
threshold_value
STRUCT
thresholdValue
absolute
INT64
absolute
percentage
INT32
percentage
warning_enum_list
STRUCT
warningEnumList
enum_strings
UNORDERED_LIST_STRING
enumStrings
filter_type
STRING
filterType
conditional_failure_policies
STRUCT
conditionalFailurePolicies
default_failure_policy
STRUCT
defaultFailurePolicy
interval_in_seconds
INT64
intervalInSeconds
max_num_retries
INT32
maxNumRetries
retry_condition
STRING
retryCondition
retry_strategy
STRING
retryStrategy
UNSPECIFIED
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.failure_policies
UNORDERED_LIST_STRUCT
failurePolicies
interval_in_seconds
INT64
intervalInSeconds
max_num_retries
INT32
maxNumRetries
retry_condition
STRING
retryCondition
retry_strategy
STRING
retryStrategy
UNSPECIFIED
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.create_time
TIMESTAMP
createTime
creator_email
STRING
creatorEmail
description
STRING
description
disable_strict_type_validation
BOOLEAN
disableStrictTypeValidation
error_catcher_id
STRING
errorCatcherId
external_task_type
STRING
externalTaskType
failure_policy
STRUCT
failurePolicy
interval_in_seconds
INT64
intervalInSeconds
max_num_retries
INT32
maxNumRetries
retry_condition
STRING
retryCondition
retry_strategy
STRING
retryStrategy
UNSPECIFIED
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.incoming_edge_count
INT32
incomingEdgeCount
json_validation_option
STRING
jsonValidationOption
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
label
last_modified_time
TIMESTAMP
lastModifiedTime
next_tasks
UNORDERED_LIST_STRUCT
nextTasks
event_config_id
. Each of these next tasks are executed only if the condition associated with them evaluates to true.combined_conditions
UNORDERED_LIST_STRUCT
combinedConditions
condition
conditions
UNORDERED_LIST_STRUCT
conditions
event_property_key
STRING
eventPropertyKey
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
STRING
operator
UNSET
EQUALS
CONTAINS
LESS_THAN
GREATER_THAN
EXISTS
DOES_NOT_EXIST
IS_EMPTY
IS_NOT_EMPTY
value
STRUCT
value
boolean_value
BOOLEAN
booleanValue
double_array
STRUCT
doubleArray
values
UNORDERED_LIST_DOUBLE
values
double_value
DOUBLE
doubleValue
int_array
STRUCT
intArray
values
UNORDERED_LIST_INT64
values
int_value
INT64
intValue
string_array
STRUCT
stringArray
values
UNORDERED_LIST_STRING
values
string_value
STRING
stringValue
condition
STRING
condition
description
STRING
description
label
STRING
label
task_config_id
STRING
taskConfigId
task_number
STRING
taskNumber
next_tasks_execution_policy
STRING
nextTasksExecutionPolicy
UNSPECIFIED
- DefaultRUN_ALL_MATCH
- Execute all the tasks that satisfy their associated condition.RUN_FIRST_MATCH
- Execute the first task that satisfies the associated condition.position
STRUCT
position
x
INT32
x
y
INT32
y
precondition
STRING
precondition
precondition_label
STRING
preconditionLabel
rollback_strategy
STRUCT
rollbackStrategy
parameters
STRUCT
parameters
parameters
UNORDERED_LIST_STRUCT
parameters
data_type
STRING
dataType
DATA_TYPE_UNSPECIFIED
STRING_VALUE
INT_VALUE
DOUBLE_VALUE
BOOLEAN_VALUE
PROTO_VALUE
SERIALIZED_OBJECT_VALUE
STRING_ARRAY
INT_ARRAY
DOUBLE_ARRAY
PROTO_ARRAY
PROTO_ENUM
BOOLEAN_ARRAY
PROTO_ENUM_ARRAY
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
NON_SERIALIZABLE_OBJECT
JSON_VALUE
key
STRING
key
masked
BOOLEAN
masked
value
STRUCT
value
boolean_array
Type: STRUCT
Provider name: booleanArray
boolean_values
UNORDERED_LIST_BOOLEAN
booleanValues
boolean_value
Type: BOOLEAN
Provider name: booleanValue
double_array
Type: STRUCT
Provider name: doubleArray
double_values
UNORDERED_LIST_DOUBLE
doubleValues
double_value
Type: DOUBLE
Provider name: doubleValue
int_array
Type: STRUCT
Provider name: intArray
int_values
UNORDERED_LIST_INT64
intValues
int_value
Type: INT64
Provider name: intValue
json_value
Type: STRING
Provider name: jsonValue
proto_array
Type: STRUCT
Provider name: protoArray
serialized_object_value
Type: STRUCT
Provider name: serializedObjectValue
string_array
Type: STRUCT
Provider name: stringArray
string_values
UNORDERED_LIST_STRING
stringValues
string_value
Type: STRING
Provider name: stringValue
rollback_task_implementation_class_name
STRING
rollbackTaskImplementationClassName
task_numbers_to_rollback
UNORDERED_LIST_STRING
taskNumbersToRollback
rollback_strategy.rollback_task_implementation_class_name
needs to be executed upon failure of this task.success_policy
STRUCT
successPolicy
final_state
STRING
finalState
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.synchronous_call_failure_policy
STRUCT
synchronousCallFailurePolicy
interval_in_seconds
INT64
intervalInSeconds
max_num_retries
INT32
maxNumRetries
retry_condition
STRING
retryCondition
retry_strategy
STRING
retryStrategy
UNSPECIFIED
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.task_entity
STRUCT
taskEntity
disabled_for_vpc_sc
BOOLEAN
disabledForVpcSc
metadata
STRUCT
metadata
active_task_name
STRING
activeTaskName
admins
UNORDERED_LIST_STRUCT
admins
google_group_email
STRING
googleGroupEmail
user_email
STRING
userEmail
category
STRING
category
code_search_link
STRING
codeSearchLink
default_json_validation_option
STRING
defaultJsonValidationOption
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.default_spec
STRING
defaultSpec
description
STRING
description
descriptive_name
STRING
descriptiveName
doc_markdown
STRING
docMarkdown
external_category
STRING
externalCategory
external_category_sequence
INT32
externalCategorySequence
external_doc_html
STRING
externalDocHtml
external_doc_link
STRING
externalDocLink
external_doc_markdown
STRING
externalDocMarkdown
g3_doc_link
STRING
g3DocLink
gcp_status
STRING
status
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.icon_link
STRING
iconLink
is_deprecated
BOOLEAN
isDeprecated
name
STRING
name
standalone_external_doc_html
STRING
standaloneExternalDocHtml
system
STRING
system
param_specs
STRUCT
paramSpecs
parameters
UNORDERED_LIST_STRUCT
parameters
class_name
STRING
className
collection_element_class_name
STRING
collectionElementClassName
config
STRUCT
config
descriptive_phrase
STRING
descriptivePhrase
help_text
STRING
helpText
hide_default_value
BOOLEAN
hideDefaultValue
input_display_option
STRING
inputDisplayOption
is_hidden
BOOLEAN
isHidden
label
STRING
label
parameter_name_option
STRING
parameterNameOption
sub_section_label
STRING
subSectionLabel
ui_placeholder_text
STRING
uiPlaceholderText
data_type
STRING
dataType
DATA_TYPE_UNSPECIFIED
STRING_VALUE
INT_VALUE
DOUBLE_VALUE
BOOLEAN_VALUE
PROTO_VALUE
SERIALIZED_OBJECT_VALUE
STRING_ARRAY
INT_ARRAY
DOUBLE_ARRAY
PROTO_ARRAY
PROTO_ENUM
BOOLEAN_ARRAY
PROTO_ENUM_ARRAY
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
NON_SERIALIZABLE_OBJECT
JSON_VALUE
default_value
STRUCT
defaultValue
boolean_array
Type: STRUCT
Provider name: booleanArray
boolean_values
UNORDERED_LIST_BOOLEAN
booleanValues
boolean_value
Type: BOOLEAN
Provider name: booleanValue
double_array
Type: STRUCT
Provider name: doubleArray
double_values
UNORDERED_LIST_DOUBLE
doubleValues
double_value
Type: DOUBLE
Provider name: doubleValue
int_array
Type: STRUCT
Provider name: intArray
int_values
UNORDERED_LIST_INT64
intValues
int_value
Type: INT64
Provider name: intValue
json_value
Type: STRING
Provider name: jsonValue
proto_array
Type: STRUCT
Provider name: protoArray
serialized_object_value
Type: STRUCT
Provider name: serializedObjectValue
string_array
Type: STRUCT
Provider name: stringArray
string_values
UNORDERED_LIST_STRING
stringValues
string_value
Type: STRING
Provider name: stringValue
is_deprecated
BOOLEAN
isDeprecated
is_output
BOOLEAN
isOutput
json_schema
STRING
jsonSchema
key
STRING
key
proto_def
STRUCT
protoDef
full_name
STRING
fullName
path
STRING
path
required
BOOLEAN
required
validation_rule
STRUCT
validationRule
double_range
STRUCT
doubleRange
max
DOUBLE
max
min
DOUBLE
min
int_range
STRUCT
intRange
max
INT64
max
min
INT64
min
string_regex
STRUCT
stringRegex
exclusive
BOOLEAN
exclusive
regex
STRING
regex
stats
STRUCT
stats
dimensions
STRUCT
dimensions
client_id
STRING
clientId
enum_filter_type
STRING
enumFilterType
DEFAULT_INCLUSIVE
EXCLUSIVE
error_enum_string
STRING
errorEnumString
retry_attempt
STRING
retryAttempt
task_name
STRING
taskName
task_number
STRING
taskNumber
trigger_id
STRING
triggerId
warning_enum_string
STRING
warningEnumString
workflow_id
STRING
workflowId
workflow_name
STRING
workflowName
duration_in_seconds
DOUBLE
durationInSeconds
error_rate
DOUBLE
errorRate
qps
DOUBLE
qps
warning_rate
DOUBLE
warningRate
task_type
STRING
taskType
TASK
- Normal IP taskASIS_TEMPLATE
- Task is of As-Is Template typeIO_TEMPLATE
- Task is of I/O template type with a different underlying taskui_config
STRUCT
uiConfig
task_ui_module_configs
UNORDERED_LIST_STRUCT
taskUiModuleConfigs
module_id
STRING
moduleId
UNSPECIFIED_TASK_MODULE
- DefaultLABEL
- 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 editorSUB_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.task_execution_strategy
STRING
taskExecutionStrategy
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.task_name
STRING
taskName
task_number
STRING
taskNumber
next_tasks.task_number
).task_spec
STRING
taskSpec
task_template_name
STRING
taskTemplateName
task_type
STRING
taskType
TASK
- Normal IP taskASIS_TEMPLATE
- Task is of As-Is Template typeIO_TEMPLATE
- Task is of I/O template type with a different underlying taskteardown
Type: STRUCT
Provider name: teardown
Description: 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.
teardown_task_configs
UNORDERED_LIST_STRUCT
teardownTaskConfigs
creator_email
STRING
creatorEmail
name
STRING
name
next_teardown_task
STRUCT
nextTeardownTask
name
STRING
name
parameters
STRUCT
parameters
parameters
UNORDERED_LIST_STRUCT
parameters
key
STRING
key
masked
BOOLEAN
masked
value
STRUCT
value
boolean_array
Type: STRUCT
Provider name: booleanArray
boolean_values
UNORDERED_LIST_BOOLEAN
booleanValues
boolean_value
Type: BOOLEAN
Provider name: booleanValue
double_array
Type: STRUCT
Provider name: doubleArray
double_values
UNORDERED_LIST_DOUBLE
doubleValues
double_value
Type: DOUBLE
Provider name: doubleValue
int_array
Type: STRUCT
Provider name: intArray
int_values
UNORDERED_LIST_INT64
intValues
int_value
Type: INT64
Provider name: intValue
proto_array
Type: STRUCT
Provider name: protoArray
serialized_object_value
Type: STRUCT
Provider name: serializedObjectValue
string_array
Type: STRUCT
Provider name: stringArray
string_values
UNORDERED_LIST_STRING
stringValues
string_value
Type: STRING
Provider name: stringValue
properties
STRUCT
properties
properties
UNORDERED_LIST_STRUCT
properties
key
STRING
key
value
STRUCT
value
boolean_value
BOOLEAN
booleanValue
double_array
STRUCT
doubleArray
values
UNORDERED_LIST_DOUBLE
values
double_value
DOUBLE
doubleValue
int_array
STRUCT
intArray
values
UNORDERED_LIST_INT64
values
int_value
INT64
intValue
string_array
STRUCT
stringArray
values
UNORDERED_LIST_STRING
values
string_value
STRING
stringValue
teardown_task_implementation_class_name
STRING
teardownTaskImplementationClassName
trigger_configs
Type: UNORDERED_LIST_STRUCT
Provider name: triggerConfigs
Description: Optional. Trigger configurations.
alert_config
UNORDERED_LIST_STRUCT
alertConfig
aggregation_period
STRING
aggregationPeriod
alert_threshold
INT32
alertThreshold
disable_alert
BOOLEAN
disableAlert
duration_threshold
STRING
durationThreshold
gcp_display_name
STRING
displayName
metric_type
STRING
metricType
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.only_final_attempt
BOOLEAN
onlyFinalAttempt
threshold_type
STRING
thresholdType
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.threshold_value
STRUCT
thresholdValue
absolute
INT64
absolute
percentage
INT32
percentage
cloud_scheduler_config
STRUCT
cloudSchedulerConfig
cron_tab
STRING
cronTab
error_message
STRING
errorMessage
location
STRING
location
service_account_email
STRING
serviceAccountEmail
description
STRING
description
error_catcher_id
STRING
errorCatcherId
input_variables
STRUCT
inputVariables
names
UNORDERED_LIST_STRING
names
label
STRING
label
next_tasks_execution_policy
STRING
nextTasksExecutionPolicy
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.output_variables
STRUCT
outputVariables
names
UNORDERED_LIST_STRING
names
position
STRUCT
position
x
INT32
x
y
INT32
y
start_tasks
UNORDERED_LIST_STRUCT
startTasks
condition
STRING
condition
description
STRING
description
gcp_display_name
STRING
displayName
task_config_id
STRING
taskConfigId
task_id
STRING
taskId
trigger
STRING
trigger
trigger_id
STRING
triggerId
trigger_number
STRING
triggerNumber
trigger_type
STRING
triggerType
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.INTEGRATION_CONNECTOR_TRIGGER
- Trigger by Connector EventPRIVATE_TRIGGER
- Trigger for private workflowCLOUD_PUBSUB
- Trigger by cloud pub/sub for internal ipEVENTARC_TRIGGER
- Trigger by Eventarctrigger_configs_internal
Type: UNORDERED_LIST_STRUCT
Provider name: triggerConfigsInternal
Description: Optional. Trigger configurations.
alert_config
UNORDERED_LIST_STRUCT
alertConfig
aggregation_period
STRING
aggregationPeriod
alert_disabled
BOOLEAN
alertDisabled
alert_name
STRING
alertName
client_id
STRING
clientId
duration_threshold_ms
INT64
durationThresholdMs
error_enum_list
STRUCT
errorEnumList
enum_strings
UNORDERED_LIST_STRING
enumStrings
filter_type
STRING
filterType
metric_type
STRING
metricType
num_aggregation_periods
INT32
numAggregationPeriods
only_final_attempt
BOOLEAN
onlyFinalAttempt
playbook_url
STRING
playbookUrl
threshold_type
STRING
thresholdType
UNSPECIFIED_THRESHOLD_TYPE
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
threshold_value
STRUCT
thresholdValue
absolute
INT64
absolute
percentage
INT32
percentage
warning_enum_list
STRUCT
warningEnumList
enum_strings
UNORDERED_LIST_STRING
enumStrings
filter_type
STRING
filterType
cloud_scheduler_config
STRUCT
cloudSchedulerConfig
cron_tab
STRING
cronTab
error_message
STRING
errorMessage
location
STRING
location
service_account_email
STRING
serviceAccountEmail
description
STRING
description
enabled_clients
UNORDERED_LIST_STRING
enabledClients
error_catcher_id
STRING
errorCatcherId
input_variables
STRUCT
inputVariables
names
UNORDERED_LIST_STRING
names
label
STRING
label
next_tasks_execution_policy
STRING
nextTasksExecutionPolicy
UNSPECIFIED
- DefaultRUN_ALL_MATCH
- Execute all the tasks that satisfy their associated condition.RUN_FIRST_MATCH
- Execute the first task that satisfies the associated condition.output_variables
STRUCT
outputVariables
names
UNORDERED_LIST_STRING
names
pause_workflow_executions
BOOLEAN
pauseWorkflowExecutions
position
STRUCT
position
x
INT32
x
y
INT32
y
start_tasks
UNORDERED_LIST_STRUCT
startTasks
combined_conditions
UNORDERED_LIST_STRUCT
combinedConditions
condition
conditions
UNORDERED_LIST_STRUCT
conditions
event_property_key
STRING
eventPropertyKey
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
STRING
operator
UNSET
EQUALS
CONTAINS
LESS_THAN
GREATER_THAN
EXISTS
DOES_NOT_EXIST
IS_EMPTY
IS_NOT_EMPTY
value
STRUCT
value
boolean_value
BOOLEAN
booleanValue
double_array
STRUCT
doubleArray
values
UNORDERED_LIST_DOUBLE
values
double_value
DOUBLE
doubleValue
int_array
STRUCT
intArray
values
UNORDERED_LIST_INT64
values
int_value
INT64
intValue
string_array
STRUCT
stringArray
values
UNORDERED_LIST_STRING
values
string_value
STRING
stringValue
condition
STRING
condition
description
STRING
description
label
STRING
label
task_config_id
STRING
taskConfigId
task_number
STRING
taskNumber
trigger_criteria
STRUCT
triggerCriteria
condition
STRING
condition
parameters
STRUCT
parameters
parameters
UNORDERED_LIST_STRUCT
parameters
key
STRING
key
masked
BOOLEAN
masked
value
STRUCT
value
boolean_array
Type: STRUCT
Provider name: booleanArray
boolean_values
UNORDERED_LIST_BOOLEAN
booleanValues
boolean_value
Type: BOOLEAN
Provider name: booleanValue
double_array
Type: STRUCT
Provider name: doubleArray
double_values
UNORDERED_LIST_DOUBLE
doubleValues
double_value
Type: DOUBLE
Provider name: doubleValue
int_array
Type: STRUCT
Provider name: intArray
int_values
UNORDERED_LIST_INT64
intValues
int_value
Type: INT64
Provider name: intValue
proto_array
Type: STRUCT
Provider name: protoArray
serialized_object_value
Type: STRUCT
Provider name: serializedObjectValue
string_array
Type: STRUCT
Provider name: stringArray
string_values
UNORDERED_LIST_STRING
stringValues
string_value
Type: STRING
Provider name: stringValue
trigger_criteria_task_implementation_class_name
STRING
triggerCriteriaTaskImplementationClassName
trigger_id
STRING
triggerId
trigger_name
STRING
triggerName
trigger_number
STRING
triggerNumber
trigger_type
STRING
triggerType
update_time
Type: TIMESTAMP
Provider name: updateTime
Description: Output only. Auto-generated.
user_label
Type: STRING
Provider name: userLabel
Description: Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.