Class: Zavudev::Models::Functions::TriggerListResponse::Trigger

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/zavudev/models/functions/trigger_list_response.rb,
sig/zavudev/models/functions/trigger_list_response.rbs

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(id:, active:, created_at:, event_type:, function_id:, updated_at:, cron: nil, last_run_at: nil, next_run_at: nil, sender_id: nil) ⇒ Object

Some parameter documentations has been truncated, see Zavudev::Models::Functions::TriggerListResponse::Trigger for more details.

A subscription that runs a Zavu Function when a messaging event fires.

Parameters:

  • id (String)
  • active (Boolean)
  • created_at (Time)
  • event_type (String) —

    Event type that fires the function. See GET /v1/functions/event-types for the su

  • function_id (String)
  • updated_at (Time)
  • cron (String, nil) (defaults to: nil) —

    5-field cron expression (minute hour day-of-month month day-of-week), evaluated

  • last_run_at (Time, nil) (defaults to: nil) —

    Last time the schedule fired. Null until the first fire.

  • next_run_at (Time, nil) (defaults to: nil) —

    Next scheduled fire time. Present only on cron triggers.

  • sender_id (String, nil) (defaults to: nil) —

    Restrict the trigger to a single sender. Null means all senders in the project.



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/zavudev/models/functions/trigger_list_response.rb', line 17

class Trigger < Zavudev::Internal::Type::BaseModel
  # @!attribute id
  #
  #   @return [String]
  required :id, String

  # @!attribute active
  #
  #   @return [Boolean]
  required :active, Zavudev::Internal::Type::Boolean

  # @!attribute created_at
  #
  #   @return [Time]
  required :created_at, Time, api_name: :createdAt

  # @!attribute event_type
  #   Event type that fires the function. See GET /v1/functions/event-types for the
  #   supported list. The special type `cron` fires on a schedule instead of a
  #   messaging event and carries a `cron` expression.
  #
  #   @return [String]
  required :event_type, String, api_name: :eventType

  # @!attribute function_id
  #
  #   @return [String]
  required :function_id, String, api_name: :functionId

  # @!attribute updated_at
  #
  #   @return [Time]
  required :updated_at, Time, api_name: :updatedAt

  # @!attribute cron
  #   5-field cron expression (minute hour day-of-month month day-of-week), evaluated
  #   in UTC. Present only on `cron` triggers.
  #
  #   @return [String, nil]
  optional :cron, String, nil?: true

  # @!attribute last_run_at
  #   Last time the schedule fired. Null until the first fire.
  #
  #   @return [Time, nil]
  optional :last_run_at, Time, api_name: :lastRunAt, nil?: true

  # @!attribute next_run_at
  #   Next scheduled fire time. Present only on `cron` triggers.
  #
  #   @return [Time, nil]
  optional :next_run_at, Time, api_name: :nextRunAt, nil?: true

  # @!attribute sender_id
  #   Restrict the trigger to a single sender. Null means all senders in the project.
  #
  #   @return [String, nil]
  optional :sender_id, String, api_name: :senderId, nil?: true

  # @!method initialize(id:, active:, created_at:, event_type:, function_id:, updated_at:, cron: nil, last_run_at: nil, next_run_at: nil, sender_id: nil)
  #   Some parameter documentations has been truncated, see
  #   {Zavudev::Models::Functions::TriggerListResponse::Trigger} for more details.
  #
  #   A subscription that runs a Zavu Function when a messaging event fires.
  #
  #   @param id [String]
  #
  #   @param active [Boolean]
  #
  #   @param created_at [Time]
  #
  #   @param event_type [String] Event type that fires the function. See GET /v1/functions/event-types for the su
  #
  #   @param function_id [String]
  #
  #   @param updated_at [Time]
  #
  #   @param cron [String, nil] 5-field cron expression (minute hour day-of-month month day-of-week), evaluated
  #
  #   @param last_run_at [Time, nil] Last time the schedule fired. Null until the first fire.
  #
  #   @param next_run_at [Time, nil] Next scheduled fire time. Present only on `cron` triggers.
  #
  #   @param sender_id [String, nil] Restrict the trigger to a single sender. Null means all senders in the project.
end

Instance Attribute Details

#active ⇒ Boolean

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


26
 
# File 'lib/zavudev/models/functions/trigger_list_response.rb', line 26

required :active, Zavudev::Internal::Type::Boolean

#created_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


31
 
# File 'lib/zavudev/models/functions/trigger_list_response.rb', line 31

required :created_at, Time, api_name: :createdAt

#cron ⇒ String?

5-field cron expression (minute hour day-of-month month day-of-week), evaluated in UTC. Present only on cron triggers.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


56
 
# File 'lib/zavudev/models/functions/trigger_list_response.rb', line 56

optional :cron, String, nil?: true

#event_type ⇒ String

Event type that fires the function. See GET /v1/functions/event-types for the supported list. The special type cron fires on a schedule instead of a messaging event and carries a cron expression.

Parameters:

  • value (String)

Returns:

  • (String) 


39
 
# File 'lib/zavudev/models/functions/trigger_list_response.rb', line 39

required :event_type, String, api_name: :eventType

#function_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


44
 
# File 'lib/zavudev/models/functions/trigger_list_response.rb', line 44

required :function_id, String, api_name: :functionId

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


21
 
# File 'lib/zavudev/models/functions/trigger_list_response.rb', line 21

required :id, String

#last_run_at ⇒ Time?

Last time the schedule fired. Null until the first fire.

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


62
 
# File 'lib/zavudev/models/functions/trigger_list_response.rb', line 62

optional :last_run_at, Time, api_name: :lastRunAt, nil?: true

#next_run_at ⇒ Time?

Next scheduled fire time. Present only on cron triggers.

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


68
 
# File 'lib/zavudev/models/functions/trigger_list_response.rb', line 68

optional :next_run_at, Time, api_name: :nextRunAt, nil?: true

#sender_id ⇒ String?

Restrict the trigger to a single sender. Null means all senders in the project.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


74
 
# File 'lib/zavudev/models/functions/trigger_list_response.rb', line 74

optional :sender_id, String, api_name: :senderId, nil?: true

#updated_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


49
 
# File 'lib/zavudev/models/functions/trigger_list_response.rb', line 49

required :updated_at, Time, api_name: :updatedAt

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


68
 
# File 'sig/zavudev/models/functions/trigger_list_response.rbs', line 68

def to_hash: -> {