Class: Google::Apis::IntegrationsV1alpha::GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest

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

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest

Returns a new instance of GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest.



9245
9246
9247
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 9245

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

Instance Attribute Details

#client_idString

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)


9180
9181
9182
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 9180

def client_id
  @client_id
end

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


9189
9190
9191
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 9189

def ignore_error_if_no_active_workflow
  @ignore_error_if_no_active_workflow
end

#parametersGoogle::Apis::IntegrationsV1alpha::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



9197
9198
9199
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 9197

def parameters
  @parameters
end

#priorityString

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

Returns:

  • (String)


9202
9203
9204
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 9202

def priority
  @priority
end

#request_idString

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)


9210
9211
9212
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 9210

def request_id
  @request_id
end

#resource_nameString

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)


9217
9218
9219
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 9217

def resource_name
  @resource_name
end

#scheduled_timeFixnum

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

Returns:

  • (Fixnum)


9223
9224
9225
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 9223

def scheduled_time
  @scheduled_time
end

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


9229
9230
9231
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 9229

def test_mode
  @test_mode
end

#trigger_idString

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)


9236
9237
9238
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 9236

def trigger_id
  @trigger_id
end

#workflow_nameString

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)


9243
9244
9245
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 9243

def workflow_name
  @workflow_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9250
9251
9252
9253
9254
9255
9256
9257
9258
9259
9260
9261
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 9250

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