Class: Telnyx::Models::GlobalIP

Inherits:
Record show all
Defined in:
lib/telnyx/models/global_ip.rb,
sig/telnyx/models/global_ip.rbs

Overview

See Also:

  • Telnyx::Resources::GlobalIPs#list

Direct Known Subclasses

GlobalIPCreateParams

Instance Attribute Summary collapse

Attributes inherited from Record

#created_at, #id, #record_type, #updated_at

Instance Method Summary collapse

Methods inherited from Record

#created_at=, #id=, #record_type=, #updated_at=

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(description: nil, ip_address: nil, name: nil, ports: nil) ⇒ Object

Parameters:

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

    A user specified description for the address.

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

    The Global IP address.

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

    A user specified name for the address.

  • ports (Hash{Symbol=>Object}) (defaults to: nil) —

    A Global IP ports grouped by protocol code.




# File 'lib/telnyx/models/global_ip.rb', line 33

Instance Attribute Details

#description ⇒ String?

A user specified description for the address.

Parameters:

  • _ (String)

Returns:

  • (String, nil) 


11
 
# File 'lib/telnyx/models/global_ip.rb', line 11

optional :description, String

#name ⇒ String?

A user specified name for the address.

Parameters:

  • _ (String)

Returns:

  • (String, nil) 


17
 
# File 'lib/telnyx/models/global_ip.rb', line 17

optional :name, String

#ports ⇒ Hash{Symbol=>Object}?

A Global IP ports grouped by protocol code.

Parameters:

  • _ (::Hash[Symbol, top])

Returns:

  • (Hash{Symbol=>Object}, nil) 


23
 
# File 'lib/telnyx/models/global_ip.rb', line 23

optional :ports, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]

Instance Method Details

#ip_address ⇒ String?

Returns:

  • (String, nil) 


24
 
# File 'sig/telnyx/models/global_ip.rbs', line 24

def ip_address: -> String?

#ip_address= ⇒ String

Parameters:

  • _ (String)

Returns:

  • (String) 


26
 
# File 'sig/telnyx/models/global_ip.rbs', line 26

def ip_address=: (String _) -> String

#to_hash ⇒ {

Returns:

  • ({) 


35
 
# File 'sig/telnyx/models/global_ip.rbs', line 35

def to_hash: -> {