Class: Cadenya::Models::WidgetInfo

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/cadenya/models/widget_info.rb,
sig/cadenya/models/widget_info.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(agent: nil, created_by: nil, dns_label: nil, host: nil) ⇒ Object

Some parameter documentations has been truncated, see Cadenya::Models::WidgetInfo for more details.

WidgetInfo provides read-only server-derived data about a widget.

Parameters:

  • agent (Cadenya::Models::BareMetadata) (defaults to: nil) —

    BareMetadata contains the minimal metadata for a resource: the ID and an

  • created_by (Cadenya::Models::Profile) (defaults to: nil) —

    A profile identifies a user or non-human principal (such as an API key)

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

    The widget's DNS label — the single hostname label under the widgets

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

    The full hostname browsers talk to. Authoritative — clients must use this




# File 'lib/cadenya/models/widget_info.rb', line 42

Instance Attribute Details

#agent ⇒ Cadenya::BareMetadata? (readonly)

Returns the value of attribute agent.

Returns:



16
17
18
 
# File 'sig/cadenya/models/widget_info.rbs', line 16

def agent
  @agent
end

#created_by ⇒ Cadenya::Models::Profile?

A profile identifies a user or non-human principal (such as an API key) at the account level. Profiles are account-scoped and can be granted access to multiple workspaces.

Parameters:

Returns:



12
 
# File 'lib/cadenya/models/widget_info.rb', line 12

optional :created_by, -> { Cadenya::Profile }, api_name: :createdBy

#dns_label ⇒ String? (readonly)

Returns the value of attribute dns_label.

Returns:

  • (String, nil) 


20
21
22
 
# File 'sig/cadenya/models/widget_info.rbs', line 20

def dns_label
  @dns_label
end

#host ⇒ String? (readonly)

Returns the value of attribute host.

Returns:

  • (String, nil) 


24
25
26
 
# File 'sig/cadenya/models/widget_info.rbs', line 24

def host
  @host
end

Instance Method Details

#agent= ⇒ Cadenya::BareMetadata (readonly)

Parameters:

Returns:



18
 
# File 'sig/cadenya/models/widget_info.rbs', line 18

def agent=: (Cadenya::BareMetadata) -> Cadenya::BareMetadata

#dns_label= ⇒ String (readonly)

Parameters:

  • (String)

Returns:

  • (String) 


22
 
# File 'sig/cadenya/models/widget_info.rbs', line 22

def dns_label=: (String) -> String

#host= ⇒ String (readonly)

Parameters:

  • (String)

Returns:

  • (String) 


26
 
# File 'sig/cadenya/models/widget_info.rbs', line 26

def host=: (String) -> String

#to_hash ⇒ {

Returns:

  • ({) 


35
 
# File 'sig/cadenya/models/widget_info.rbs', line 35

def to_hash: -> {