Class: Google::Apis::CloudsearchV1::Trigger

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Trigger

Returns a new instance of Trigger.



20613
20614
20615
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20613

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

Instance Attribute Details

#action_type ⇒ Fixnum

Each dispatcher should use an enum to for the actions that it supports. If a dispatcher has only one action, this does not need to be set. (It can be expanded later, defining the default behaviour as type 0.) For purposes such as batching, the type of a trigger is (dispatcher, action_type). Corresponds to the JSON property actionType

Returns:

  • (Fixnum) 


20549
20550
20551
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20549

def action_type
  @action_type
end

#batch_time_us ⇒ Fixnum

Maximum possible delay in micros that can be tolerated so triggers can be batched, which makes processing more efficient compared to firing triggers individually. Note that the actual fire time will be somewhere in the timerange interval [fire_time_us, fire_time_us + batch_time_us). Corresponds to the JSON property batchTimeUs

Returns:

  • (Fixnum) 


20557
20558
20559
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20557

def batch_time_us
  @batch_time_us
end

#dispatch_id ⇒ Fixnum

Must be set for DISPATCHER_STUBBY_DISPATCHER. Corresponds to the JSON property dispatchId

Returns:

  • (Fixnum) 


20562
20563
20564
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20562

def dispatch_id
  @dispatch_id
end

#dispatcher ⇒ String

Which server should interpret action_type. Corresponds to the JSON property dispatcher

Returns:

  • (String) 


20567
20568
20569
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20567

def dispatcher
  @dispatcher
end

#fire_time_us ⇒ Fixnum

Earliest time to fire at in microseconds. The actual time that the trigger will fire will be in the timerange: [fire_time_us, fire_time_us + batch_time_us). Corresponds to the JSON property fireTimeUs

Returns:

  • (Fixnum) 


20574
20575
20576
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20574

def fire_time_us
  @fire_time_us
end

#jobsetted_server_spec ⇒ Google::Apis::CloudsearchV1::JobsettedServerSpec

Identifies a jobsetted server as a target for Trigger dispatch. Corresponds to the JSON property jobsettedServerSpec

Returns:



20579
20580
20581
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20579

def jobsetted_server_spec
  @jobsetted_server_spec
end

#key ⇒ String

The trigger key, if applicable. Corresponds to the JSON property key

Returns:

  • (String) 


20584
20585
20586
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20584

def key
  @key
end

#rpc_options ⇒ Google::Apis::CloudsearchV1::RpcOptions

Options for Triggers dispatched via RPC. Corresponds to the JSON property rpcOptions

Returns:



20589
20590
20591
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20589

def rpc_options
  @rpc_options
end

#slice_fire_time_us ⇒ Fixnum

The slice_fire_time_us is automatically computed and stored as part of the trigger write. It represents the exact fire time at which the trigger will be queued to fire and will satisfy fire_time_us < slice_fire_time_us <= fire_time_us + batch_time_us Triggers have an index row in the slice trigger index with the row prefix matching this time. Note that this field is internal to gmail_cp and is ignored if set by external clients when adding / updating triggers. Corresponds to the JSON property sliceFireTimeUs

Returns:

  • (Fixnum) 


20600
20601
20602
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20600

def slice_fire_time_us
  @slice_fire_time_us
end

#trigger_action ⇒ Google::Apis::CloudsearchV1::TriggerAction

Trigger action to perform. This should always be set. Corresponds to the JSON property triggerAction

Returns:



20605
20606
20607
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20605

def trigger_action
  @trigger_action
end

#trigger_key ⇒ Google::Apis::CloudsearchV1::TriggerKey

A TriggerKey (type + instance_id) uniquely identifies a trigger within a message for a message-trigger and within an account for an account-trigger. Corresponds to the JSON property triggerKey

Returns:



20611
20612
20613
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20611

def trigger_key
  @trigger_key
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



20618
20619
20620
20621
20622
20623
20624
20625
20626
20627
20628
20629
20630
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20618

def update!(**args)
  @action_type = args[:action_type] if args.key?(:action_type)
  @batch_time_us = args[:batch_time_us] if args.key?(:batch_time_us)
  @dispatch_id = args[:dispatch_id] if args.key?(:dispatch_id)
  @dispatcher = args[:dispatcher] if args.key?(:dispatcher)
  @fire_time_us = args[:fire_time_us] if args.key?(:fire_time_us)
  @jobsetted_server_spec = args[:jobsetted_server_spec] if args.key?(:jobsetted_server_spec)
  @key = args[:key] if args.key?(:key)
  @rpc_options = args[:rpc_options] if args.key?(:rpc_options)
  @slice_fire_time_us = args[:slice_fire_time_us] if args.key?(:slice_fire_time_us)
  @trigger_action = args[:trigger_action] if args.key?(:trigger_action)
  @trigger_key = args[:trigger_key] if args.key?(:trigger_key)
end