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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ EnterpriseCrmFrontendsEventbusProtoTriggerConfig

Returns a new instance of EnterpriseCrmFrontendsEventbusProtoTriggerConfig.



4703
4704
4705
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4703

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:



4619
4620
4621
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4619

def alert_config
  @alert_config
end

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

Cloud Scheduler Trigger configuration Corresponds to the JSON property cloudSchedulerConfig

Returns:



4624
4625
4626
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4624

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) 


4630
4631
4632
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4630

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


4639
4640
4641
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4639

def enabled_clients
  @enabled_clients
end

#label ⇒ String

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

Returns:

  • (String) 


4644
4645
4646
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4644

def label
  @label
end

#next_tasks_execution_policy ⇒ String

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

Returns:

  • (String) 


4649
4650
4651
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4649

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) 


4657
4658
4659
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4657

def pause_workflow_executions
  @pause_workflow_executions
end

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

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

Returns:



4663
4664
4665
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4663

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


4670
4671
4672
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4670

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:



4678
4679
4680
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4678

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:



4685
4686
4687
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4685

def trigger_criteria
  @trigger_criteria
end

#trigger_id ⇒ String

The backend trigger ID. Corresponds to the JSON property triggerId

Returns:

  • (String) 


4690
4691
4692
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4690

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) 


4696
4697
4698
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4696

def trigger_number
  @trigger_number
end

#trigger_type ⇒ String

Corresponds to the JSON property triggerType

Returns:

  • (String) 


4701
4702
4703
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4701

def trigger_type
  @trigger_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4708

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