Class: Google::Apis::IntegrationsV1::EnterpriseCrmFrontendsEventbusProtoTriggerConfig

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

Overview

Configuration detail of a trigger. Next available id: 22

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ EnterpriseCrmFrontendsEventbusProtoTriggerConfig

Returns a new instance of EnterpriseCrmFrontendsEventbusProtoTriggerConfig.



4860
4861
4862
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4860

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

Instance Attribute Details

#alert_config ⇒ Array<Google::Apis::IntegrationsV1::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:



4753
4754
4755
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4753

def alert_config
  @alert_config
end

#cloud_scheduler_config ⇒ Google::Apis::IntegrationsV1::EnterpriseCrmEventbusProtoCloudSchedulerConfig

Cloud Scheduler Trigger configuration Corresponds to the JSON property cloudSchedulerConfig

Returns:



4758
4759
4760
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4758

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) 


4764
4765
4766
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4764

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


4773
4774
4775
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4773

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) 


4779
4780
4781
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4779

def error_catcher_id
  @error_catcher_id
end

#input_variables ⇒ Google::Apis::IntegrationsV1::EnterpriseCrmFrontendsEventbusProtoTriggerConfigVariables

Variables names mapped to api trigger. Corresponds to the JSON property inputVariables

Returns:



4784
4785
4786
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4784

def input_variables
  @input_variables
end

#label ⇒ String

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

Returns:

  • (String) 


4789
4790
4791
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4789

def label
  @label
end

#next_tasks_execution_policy ⇒ String

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

Returns:

  • (String) 


4794
4795
4796
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4794

def next_tasks_execution_policy
  @next_tasks_execution_policy
end

#output_variables ⇒ Google::Apis::IntegrationsV1::EnterpriseCrmFrontendsEventbusProtoTriggerConfigVariables

Variables names mapped to api trigger. Corresponds to the JSON property outputVariables

Returns:



4799
4800
4801
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4799

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


4807
4808
4809
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4807

def pause_workflow_executions
  @pause_workflow_executions
end

#position ⇒ Google::Apis::IntegrationsV1::EnterpriseCrmEventbusProtoCoordinate

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

Returns:



4813
4814
4815
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4813

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


4820
4821
4822
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4820

def properties
  @properties
end

#start_tasks ⇒ Array<Google::Apis::IntegrationsV1::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:



4828
4829
4830
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4828

def start_tasks
  @start_tasks
end

#trigger_criteria ⇒ Google::Apis::IntegrationsV1::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:



4835
4836
4837
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4835

def trigger_criteria
  @trigger_criteria
end

#trigger_id ⇒ String

The backend trigger ID. Corresponds to the JSON property triggerId

Returns:

  • (String) 


4840
4841
4842
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4840

def trigger_id
  @trigger_id
end

#trigger_name ⇒ String

Optional. Name of the trigger This is added to identify the type of trigger. This is avoid the logic on triggerId to identify the trigger_type and push the same to monitoring. Corresponds to the JSON property triggerName

Returns:

  • (String) 


4847
4848
4849
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4847

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


4853
4854
4855
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4853

def trigger_number
  @trigger_number
end

#trigger_type ⇒ String

Corresponds to the JSON property triggerType

Returns:

  • (String) 


4858
4859
4860
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4858

def trigger_type
  @trigger_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4865

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)
  @input_variables = args[:input_variables] if args.key?(:input_variables)
  @label = args[:label] if args.key?(:label)
  @next_tasks_execution_policy = args[:next_tasks_execution_policy] if args.key?(:next_tasks_execution_policy)
  @output_variables = args[:output_variables] if args.key?(:output_variables)
  @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_name = args[:trigger_name] if args.key?(:trigger_name)
  @trigger_number = args[:trigger_number] if args.key?(:trigger_number)
  @trigger_type = args[:trigger_type] if args.key?(:trigger_type)
end