Class: Google::Apis::IntegrationsV1::GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest

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

Use this request to post all workflows associated with a given trigger id. Next available id: 10

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest

Returns a new instance of GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest.



9664
9665
9666
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 9664

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

Instance Attribute Details

#client_id ⇒ String

Optional. If the client id is provided, then the combination of trigger id and client id is matched across all the workflows. If the client id is not provided, then workflows with matching trigger id are executed for each client id in the @link TriggerConfig. For Api Trigger, the client id is required and will be validated against the allowed clients. Corresponds to the JSON property clientId

Returns:

  • (String) 


9606
9607
9608
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 9606

def client_id
  @client_id
end

#ignore_error_if_no_active_workflow ⇒ Boolean Also known as: ignore_error_if_no_active_workflow?

Optional. Flag to determine whether clients would suppress a warning when no ACTIVE workflows are not found. If this flag is set to be true, an error will not be thrown if the requested trigger_id or client_id is not found in any ACTIVE workflow. Otherwise, the error is always thrown. The flag is set to be false by default. Corresponds to the JSON property ignoreErrorIfNoActiveWorkflow

Returns:

  • (Boolean) 


9615
9616
9617
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 9615

def ignore_error_if_no_active_workflow
  @ignore_error_if_no_active_workflow
end

#parameters ⇒ Google::Apis::IntegrationsV1::EnterpriseCrmEventbusProtoEventParameters

LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 Corresponds to the JSON property parameters

Returns:



9623
9624
9625
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 9623

def parameters
  @parameters
end

#priority ⇒ String

The request priority this request should be processed at. For internal users: Corresponds to the JSON property priority

Returns:

  • (String) 


9628
9629
9630
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 9628

def priority
  @priority
end

#request_id ⇒ String

Optional. This is used to de-dup incoming request: if the duplicate request was detected, the response from the previous execution is returned. Must have no more than 36 characters and contain only alphanumeric characters and hyphens. Corresponds to the JSON property requestId

Returns:

  • (String) 


9636
9637
9638
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 9636

def request_id
  @request_id
end

#scheduled_time ⇒ Fixnum

Optional. Time in milliseconds since epoch when the given event would be scheduled. Corresponds to the JSON property scheduledTime

Returns:

  • (Fixnum) 


9642
9643
9644
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 9642

def scheduled_time
  @scheduled_time
end

#test_mode ⇒ Boolean Also known as: test_mode?

Optional. Sets test mode in @link enterprise/crm/eventbus/event_message.proto . Corresponds to the JSON property testMode

Returns:

  • (Boolean) 


9648
9649
9650
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 9648

def test_mode
  @test_mode
end

#trigger_id ⇒ String

Matched against all @link TriggerConfigs across all workflows. i.e. TriggerConfig.trigger_id.equals(trigger_id) Required. Corresponds to the JSON property triggerId

Returns:

  • (String) 


9655
9656
9657
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 9655

def trigger_id
  @trigger_id
end

#workflow_name ⇒ String

Optional. If provided, the workflow_name is used to filter all the matched workflows having same trigger_id+client_id. A combination of trigger_id, client_id and workflow_name identifies a unique workflow. Corresponds to the JSON property workflowName

Returns:

  • (String) 


9662
9663
9664
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 9662

def workflow_name
  @workflow_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9669
9670
9671
9672
9673
9674
9675
9676
9677
9678
9679
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 9669

def update!(**args)
  @client_id = args[:client_id] if args.key?(:client_id)
  @ignore_error_if_no_active_workflow = args[:ignore_error_if_no_active_workflow] if args.key?(:ignore_error_if_no_active_workflow)
  @parameters = args[:parameters] if args.key?(:parameters)
  @priority = args[:priority] if args.key?(:priority)
  @request_id = args[:request_id] if args.key?(:request_id)
  @scheduled_time = args[:scheduled_time] if args.key?(:scheduled_time)
  @test_mode = args[:test_mode] if args.key?(:test_mode)
  @trigger_id = args[:trigger_id] if args.key?(:trigger_id)
  @workflow_name = args[:workflow_name] if args.key?(:workflow_name)
end