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.



20792
20793
20794
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20792

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

Instance Attribute Details

#action_typeFixnum

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)


20728
20729
20730
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20728

def action_type
  @action_type
end

#batch_time_usFixnum

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)


20736
20737
20738
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20736

def batch_time_us
  @batch_time_us
end

#dispatch_idFixnum

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

Returns:

  • (Fixnum)


20741
20742
20743
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20741

def dispatch_id
  @dispatch_id
end

#dispatcherString

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

Returns:

  • (String)


20746
20747
20748
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20746

def dispatcher
  @dispatcher
end

#fire_time_usFixnum

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)


20753
20754
20755
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20753

def fire_time_us
  @fire_time_us
end

#jobsetted_server_specGoogle::Apis::CloudsearchV1::JobsettedServerSpec

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



20758
20759
20760
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20758

def jobsetted_server_spec
  @jobsetted_server_spec
end

#keyString

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

Returns:

  • (String)


20763
20764
20765
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20763

def key
  @key
end

#rpc_optionsGoogle::Apis::CloudsearchV1::RpcOptions

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



20768
20769
20770
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20768

def rpc_options
  @rpc_options
end

#slice_fire_time_usFixnum

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)


20779
20780
20781
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20779

def slice_fire_time_us
  @slice_fire_time_us
end

#trigger_actionGoogle::Apis::CloudsearchV1::TriggerAction

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



20784
20785
20786
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20784

def trigger_action
  @trigger_action
end

#trigger_keyGoogle::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



20790
20791
20792
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20790

def trigger_key
  @trigger_key
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



20797
20798
20799
20800
20801
20802
20803
20804
20805
20806
20807
20808
20809
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20797

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