Class: Zavudev::Models::FunctionRetrieveResponse::Function

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/zavudev/models/function_retrieve_response.rb

Overview

See Also:

Defined Under Namespace

Modules: Runtime, Status

Instance Attribute Summary collapse

Class Method 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:, created_at:, dependencies:, http_enabled:, memory_mb:, name:, runtime:, slug:, status:, timeout_sec:, updated_at:, active_deployment_id: nil, description: nil, public_url: nil) ⇒ Object

Some parameter documentations has been truncated, see Zavudev::Models::FunctionRetrieveResponse::Function for more details.

A Zavu Function — user-supplied TypeScript that runs in Zavu Cloud and reacts to messaging events or HTTP requests.

Parameters:

  • id (String)
  • created_at (Time)
  • dependencies (Hash{Symbol=>String}) —

    npm dependencies installed in the function bundle. Keys are package names, value

  • http_enabled (Boolean) —

    Whether the function can be invoked over HTTPS via its public URL.

  • memory_mb (Integer) —

    Memory allocation in MB.

  • name (String)
  • runtime (Symbol, Zavudev::Models::FunctionRetrieveResponse::Function::Runtime) —

    Runtime the function is deployed on.

  • slug (String) —

    URL-safe identifier, unique per project.

  • status (Symbol, Zavudev::Models::FunctionRetrieveResponse::Function::Status) —

    Lifecycle status of a Zavu Function.

  • timeout_sec (Integer) —

    Per-invocation timeout in seconds.

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

    ID of the deployment currently serving traffic.

  • description (String, nil) (defaults to: nil)
  • public_url (String, nil) (defaults to: nil) —

    HTTPS endpoint when httpEnabled is true.




# File 'lib/zavudev/models/function_retrieve_response.rb', line 102

Instance Attribute Details

#active_deployment_id ⇒ String?

ID of the deployment currently serving traffic.

Returns:

  • (String, nil) 


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

optional :active_deployment_id, String, api_name: :activeDeploymentId, nil?: true

#created_at ⇒ Time

Returns:

  • (Time) 


30
 
# File 'lib/zavudev/models/function_retrieve_response.rb', line 30

required :created_at, Time, api_name: :createdAt

#dependencies ⇒ Hash{Symbol=>String}

npm dependencies installed in the function bundle. Keys are package names, values are semver ranges.

Returns:

  • (Hash{Symbol=>String}) 


37
 
# File 'lib/zavudev/models/function_retrieve_response.rb', line 37

required :dependencies, Zavudev::Internal::Type::HashOf[String]

#description ⇒ String?

Returns:

  • (String, nil) 


94
 
# File 'lib/zavudev/models/function_retrieve_response.rb', line 94

optional :description, String, nil?: true

#http_enabled ⇒ Boolean

Whether the function can be invoked over HTTPS via its public URL.

Returns:

  • (Boolean) 


43
 
# File 'lib/zavudev/models/function_retrieve_response.rb', line 43

required :http_enabled, Zavudev::Internal::Type::Boolean, api_name: :httpEnabled

#id ⇒ String

Returns:

  • (String) 


25
 
# File 'lib/zavudev/models/function_retrieve_response.rb', line 25

required :id, String

#memory_mb ⇒ Integer

Memory allocation in MB.

Returns:

  • (Integer) 


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

required :memory_mb, Integer, api_name: :memoryMb

#name ⇒ String

Returns:

  • (String) 


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

required :name, String

#public_url ⇒ String?

HTTPS endpoint when httpEnabled is true.

Returns:

  • (String, nil) 


100
 
# File 'lib/zavudev/models/function_retrieve_response.rb', line 100

optional :public_url, String, api_name: :publicUrl, nil?: true

#runtime ⇒ Symbol, Zavudev::Models::FunctionRetrieveResponse::Function::Runtime

Runtime the function is deployed on.

Returns:



60
 
# File 'lib/zavudev/models/function_retrieve_response.rb', line 60

required :runtime, enum: -> { Zavudev::Models::FunctionRetrieveResponse::Function::Runtime }

#slug ⇒ String

URL-safe identifier, unique per project.

Returns:

  • (String) 


66
 
# File 'lib/zavudev/models/function_retrieve_response.rb', line 66

required :slug, String

#status ⇒ Symbol, Zavudev::Models::FunctionRetrieveResponse::Function::Status

Lifecycle status of a Zavu Function.

Returns:



72
 
# File 'lib/zavudev/models/function_retrieve_response.rb', line 72

required :status, enum: -> { Zavudev::Models::FunctionRetrieveResponse::Function::Status }

#timeout_sec ⇒ Integer

Per-invocation timeout in seconds.

Returns:

  • (Integer) 


78
 
# File 'lib/zavudev/models/function_retrieve_response.rb', line 78

required :timeout_sec, Integer, api_name: :timeoutSec

#updated_at ⇒ Time

Returns:

  • (Time) 


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

required :updated_at, Time, api_name: :updatedAt

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/zavudev/models/function_retrieve_response.rb', line 145