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

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest

Returns a new instance of GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest.



11819
11820
11821
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 11819

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) 


11740
11741
11742
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 11740

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) 


11749
11750
11751
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 11749

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

Returns:



11757
11758
11759
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 11757

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) 


11762
11763
11764
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 11762

def priority
  @priority
end

#quota_retry_count ⇒ Fixnum

Optional. This is a field to see the quota retry count for integration execution Corresponds to the JSON property quotaRetryCount

Returns:

  • (Fixnum) 


11768
11769
11770
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 11768

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


11776
11777
11778
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 11776

def request_id
  @request_id
end

#resource_name ⇒ String

This field is only required when using Admin Access. The resource name of target, or the parent resource name. For example: "projects//locations// integrations/*" Corresponds to the JSON property resourceName

Returns:

  • (String) 


11783
11784
11785
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 11783

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


11789
11790
11791
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 11789

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) 


11795
11796
11797
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 11795

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) 


11802
11803
11804
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 11802

def trigger_id
  @trigger_id
end

#user_generated_execution_id ⇒ String

This is a unique id provided by the method caller. If provided this will be used as the execution_id when a new execution info is created. This is a string representation of a UUID. Must have no more than 36 characters and contain only alphanumeric characters and hyphens. Corresponds to the JSON property userGeneratedExecutionId

Returns:

  • (String) 


11810
11811
11812
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 11810

def user_generated_execution_id
  @user_generated_execution_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) 


11817
11818
11819
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 11817

def workflow_name
  @workflow_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11824
11825
11826
11827
11828
11829
11830
11831
11832
11833
11834
11835
11836
11837
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 11824

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)
  @quota_retry_count = args[:quota_retry_count] if args.key?(:quota_retry_count)
  @request_id = args[:request_id] if args.key?(:request_id)
  @resource_name = args[:resource_name] if args.key?(:resource_name)
  @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)
  @user_generated_execution_id = args[:user_generated_execution_id] if args.key?(:user_generated_execution_id)
  @workflow_name = args[:workflow_name] if args.key?(:workflow_name)
end