Class: Zavudev::Models::Functions::TriggerCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/zavudev/models/functions/trigger_create_params.rb,
sig/zavudev/models/functions/trigger_create_params.rbs

Overview

See Also:

  • Zavudev::Resources::Functions::Triggers#create

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(function_id:, event_types:, sender_ids:, cron: nil, request_options: {}) ⇒ Object

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

Parameters:

  • function_id (String)
  • event_types (Array<String>) —

    Event types to subscribe to.

  • sender_ids (Array<String, nil>) —

    Senders to scope the triggers to. Use null for all senders.

  • cron (String) (defaults to: nil) —

    Required when eventTypes includes cron: a 5-field cron expression (minute hour

  • request_options (Zavudev::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/zavudev/models/functions/trigger_create_params.rb', line 35

Instance Attribute Details

#cron ⇒ String?

Required when eventTypes includes cron: a 5-field cron expression (minute hour day-of-month month day-of-week), evaluated in UTC.

Parameters:

  • (String)

Returns:

  • (String, nil) 


33
 
# File 'lib/zavudev/models/functions/trigger_create_params.rb', line 33

optional :cron, String

#event_types ⇒ Array<String>

Event types to subscribe to.

Parameters:

  • value (::Array[String])

Returns:

  • (Array<String>) 


20
 
# File 'lib/zavudev/models/functions/trigger_create_params.rb', line 20

required :event_types, Zavudev::Internal::Type::ArrayOf[String], api_name: :eventTypes

#function_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


14
 
# File 'lib/zavudev/models/functions/trigger_create_params.rb', line 14

required :function_id, String

#sender_ids ⇒ Array<String, nil>

Senders to scope the triggers to. Use null for all senders.

Parameters:

  • value (::Array[String?])

Returns:

  • (Array<String, nil>) 


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

required :sender_ids, Zavudev::Internal::Type::ArrayOf[String, nil?: true], api_name: :senderIds

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


35
 
# File 'sig/zavudev/models/functions/trigger_create_params.rbs', line 35

def to_hash: -> {