Class: Google::Apis::IntegrationsV1alpha::EnterpriseCrmFrontendsEventbusProtoTriggerConfig

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/integrations_v1alpha/classes.rb,
lib/google/apis/integrations_v1alpha/representations.rb,
lib/google/apis/integrations_v1alpha/representations.rb

Overview

Configuration detail of a trigger. Next available id: 18

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ EnterpriseCrmFrontendsEventbusProtoTriggerConfig

Returns a new instance of EnterpriseCrmFrontendsEventbusProtoTriggerConfig.



4530
4531
4532
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4530

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#alert_config ⇒ Array<Google::Apis::IntegrationsV1alpha::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. Corresponds to the JSON property alertConfig

Returns:



4440
4441
4442
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4440

def alert_config
  @alert_config
end

#cloud_scheduler_config ⇒ Google::Apis::IntegrationsV1alpha::EnterpriseCrmEventbusProtoCloudSchedulerConfig

Cloud Scheduler Trigger configuration Corresponds to the JSON property cloudSchedulerConfig

Returns:



4445
4446
4447
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4445

def cloud_scheduler_config
  @cloud_scheduler_config
end

#description ⇒ String

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

Returns:

  • (String) 


4451
4452
4453
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4451

def description
  @description
end

#enabled_clients ⇒ Array<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. Corresponds to the JSON property enabledClients

Returns:

  • (Array<String>) 


4460
4461
4462
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4460

def enabled_clients
  @enabled_clients
end

#error_catcher_config_id ⇒ String

Optional Error catcher config id of the error catch flow which will be executed when execution error happens in the task Corresponds to the JSON property errorCatcherConfigId

Returns:

  • (String) 


4466
4467
4468
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4466

def error_catcher_config_id
  @error_catcher_config_id
end

#label ⇒ String

The user created label for a particular trigger. Corresponds to the JSON property label

Returns:

  • (String) 


4471
4472
4473
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4471

def label
  @label
end

#next_tasks_execution_policy ⇒ String

Dictates how next tasks will be executed. Corresponds to the JSON property nextTasksExecutionPolicy

Returns:

  • (String) 


4476
4477
4478
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4476

def next_tasks_execution_policy
  @next_tasks_execution_policy
end

#pause_workflow_executions ⇒ Boolean Also known as: pause_workflow_executions?

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. Corresponds to the JSON property pauseWorkflowExecutions

Returns:

  • (Boolean) 


4484
4485
4486
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4484

def pause_workflow_executions
  @pause_workflow_executions
end

#position ⇒ Google::Apis::IntegrationsV1alpha::EnterpriseCrmEventbusProtoCoordinate

Represents two-dimensional positions. Corresponds to the JSON property position

Returns:



4490
4491
4492
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4490

def position
  @position
end

#properties ⇒ Hash<String,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. Corresponds to the JSON property properties

Returns:

  • (Hash<String,String>) 


4497
4498
4499
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4497

def properties
  @properties
end

#start_tasks ⇒ Array<Google::Apis::IntegrationsV1alpha::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). Corresponds to the JSON property startTasks

Returns:



4505
4506
4507
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4505

def start_tasks
  @start_tasks
end

#trigger_criteria ⇒ Google::Apis::IntegrationsV1alpha::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. Corresponds to the JSON property triggerCriteria

Returns:



4512
4513
4514
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4512

def trigger_criteria
  @trigger_criteria
end

#trigger_id ⇒ String

The backend trigger ID. Corresponds to the JSON property triggerId

Returns:

  • (String) 


4517
4518
4519
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4517

def trigger_id
  @trigger_id
end

#trigger_number ⇒ String

Required. A number to uniquely identify each trigger config within the workflow on UI. Corresponds to the JSON property triggerNumber

Returns:

  • (String) 


4523
4524
4525
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4523

def trigger_number
  @trigger_number
end

#trigger_type ⇒ String

Corresponds to the JSON property triggerType

Returns:

  • (String) 


4528
4529
4530
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4528

def trigger_type
  @trigger_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4535

def update!(**args)
  @alert_config = args[:alert_config] if args.key?(:alert_config)
  @cloud_scheduler_config = args[:cloud_scheduler_config] if args.key?(:cloud_scheduler_config)
  @description = args[:description] if args.key?(:description)
  @enabled_clients = args[:enabled_clients] if args.key?(:enabled_clients)
  @error_catcher_config_id = args[:error_catcher_config_id] if args.key?(:error_catcher_config_id)
  @label = args[:label] if args.key?(:label)
  @next_tasks_execution_policy = args[:next_tasks_execution_policy] if args.key?(:next_tasks_execution_policy)
  @pause_workflow_executions = args[:pause_workflow_executions] if args.key?(:pause_workflow_executions)
  @position = args[:position] if args.key?(:position)
  @properties = args[:properties] if args.key?(:properties)
  @start_tasks = args[:start_tasks] if args.key?(:start_tasks)
  @trigger_criteria = args[:trigger_criteria] if args.key?(:trigger_criteria)
  @trigger_id = args[:trigger_id] if args.key?(:trigger_id)
  @trigger_number = args[:trigger_number] if args.key?(:trigger_number)
  @trigger_type = args[:trigger_type] if args.key?(:trigger_type)
end