Class: Zavudev::Models::Functions::TriggerCreateResponse::Trigger

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/zavudev/models/functions/trigger_create_response.rb,
sig/zavudev/models/functions/trigger_create_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::TriggerCreateResponse::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.



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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/zavudev/models/functions/trigger_create_response.rb', line 32

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::TriggerCreateResponse::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) 


41
 
# File 'lib/zavudev/models/functions/trigger_create_response.rb', line 41

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

#created_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


46
 
# File 'lib/zavudev/models/functions/trigger_create_response.rb', line 46

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) 


71
 
# File 'lib/zavudev/models/functions/trigger_create_response.rb', line 71

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) 


54
 
# File 'lib/zavudev/models/functions/trigger_create_response.rb', line 54

required :event_type, String, api_name: :eventType

#function_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


59
 
# File 'lib/zavudev/models/functions/trigger_create_response.rb', line 59

required :function_id, String, api_name: :functionId

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


36
 
# File 'lib/zavudev/models/functions/trigger_create_response.rb', line 36

required :id, String

#last_run_at ⇒ Time?

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

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


77
 
# File 'lib/zavudev/models/functions/trigger_create_response.rb', line 77

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) 


83
 
# File 'lib/zavudev/models/functions/trigger_create_response.rb', line 83

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) 


89
 
# File 'lib/zavudev/models/functions/trigger_create_response.rb', line 89

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

#updated_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


64
 
# File 'lib/zavudev/models/functions/trigger_create_response.rb', line 64

required :updated_at, Time, api_name: :updatedAt

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


78
 
# File 'sig/zavudev/models/functions/trigger_create_response.rbs', line 78

def to_hash: -> {