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: 19

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ EnterpriseCrmFrontendsEventbusProtoTriggerConfig

Returns a new instance of EnterpriseCrmFrontendsEventbusProtoTriggerConfig.



4608
4609
4610
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4608

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:



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

def alert_config
  @alert_config
end

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

Cloud Scheduler Trigger configuration Corresponds to the JSON property cloudSchedulerConfig

Returns:



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

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) 


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

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>) 


4538
4539
4540
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4538

def enabled_clients
  @enabled_clients
end

#error_catcher_id ⇒ String

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

Returns:

  • (String) 


4544
4545
4546
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4544

def error_catcher_id
  @error_catcher_id
end

#label ⇒ String

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

Returns:

  • (String) 


4549
4550
4551
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4549

def label
  @label
end

#next_tasks_execution_policy ⇒ String

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

Returns:

  • (String) 


4554
4555
4556
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4554

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) 


4562
4563
4564
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4562

def pause_workflow_executions
  @pause_workflow_executions
end

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

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

Returns:



4568
4569
4570
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4568

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>) 


4575
4576
4577
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4575

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:



4583
4584
4585
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4583

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:



4590
4591
4592
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4590

def trigger_criteria
  @trigger_criteria
end

#trigger_id ⇒ String

The backend trigger ID. Corresponds to the JSON property triggerId

Returns:

  • (String) 


4595
4596
4597
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4595

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) 


4601
4602
4603
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4601

def trigger_number
  @trigger_number
end

#trigger_type ⇒ String

Corresponds to the JSON property triggerType

Returns:

  • (String) 


4606
4607
4608
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4606

def trigger_type
  @trigger_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4613

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_id = args[:error_catcher_id] if args.key?(:error_catcher_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