Class: Telnyx::Models::VirtualCrossConnectCombined

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/virtual_cross_connect_combined.rb,
sig/telnyx/models/virtual_cross_connect_combined.rbs

Overview

See Also:

  • Telnyx::Resources::VirtualCrossConnects#list

Defined Under Namespace

Modules: CloudProvider Classes: Region

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: nil, bandwidth_mbps: nil, bgp_asn: nil, cloud_provider: nil, cloud_provider_region: nil, created_at: nil, name: nil, network_id: nil, primary_bgp_key: nil, primary_cloud_account_id: nil, primary_cloud_ip: nil, primary_enabled: nil, primary_routing_announcement: nil, primary_telnyx_ip: nil, record_type: nil, region: nil, region_code: nil, status: nil, updated_at: nil) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::VirtualCrossConnectCombined for more details.

Parameters:

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

    Identifies the resource.

  • bandwidth_mbps (Float) (defaults to: nil) —

    The desired throughput in Megabits per Second (Mbps) for your Virtual Cross Conn

  • bgp_asn (Float) (defaults to: nil) —

    The Border Gateway Protocol (BGP) Autonomous System Number (ASN).

  • cloud_provider (Symbol, Telnyx::Models::VirtualCrossConnectCombined::CloudProvider) (defaults to: nil) —

    The Virtual Private Cloud with which you would like to establish a cross connect

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

    The region where your Virtual Private Cloud hosts are located.

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

    ISO 8601 formatted date-time indicating when the resource was created.

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

    A user specified name for the interface.

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

    The id of the network associated with the interface.

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

    The authentication key for BGP peer configuration.

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

    The identifier for your Virtual Private Cloud.

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

    The IP address assigned for your side of the Virtual Cross Connect.

  • primary_enabled (Boolean) (defaults to: nil) —

    Indicates whether the primary circuit is enabled.

  • primary_routing_announcement (Boolean) (defaults to: nil) —

    Whether

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

    The IP address assigned to the Telnyx side of the Virtual Cross Connect.

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

    Identifies the type of the resource.

  • region (Telnyx::Models::VirtualCrossConnectCombined::Region) (defaults to: nil)
  • region_code (String) (defaults to: nil) —

    The region interface is deployed to.

  • status (Symbol, Telnyx::Models::InterfaceStatus) (defaults to: nil) —

    The current status of the interface deployment.

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

    ISO 8601 formatted date-time indicating when the resource was updated.




# File 'lib/telnyx/models/virtual_cross_connect_combined.rb', line 124

Instance Attribute Details

#bandwidth_mbps ⇒ Float?

The desired throughput in Megabits per Second (Mbps) for your Virtual Cross Connect.

Parameters:

  • (Float)

Returns:

  • (Float, nil) 


12
 
# File 'lib/telnyx/models/virtual_cross_connect_combined.rb', line 12

optional :bandwidth_mbps, Float

#bgp_asn ⇒ Float?

The Border Gateway Protocol (BGP) Autonomous System Number (ASN).

Parameters:

  • (Float)

Returns:

  • (Float, nil) 


18
 
# File 'lib/telnyx/models/virtual_cross_connect_combined.rb', line 18

optional :bgp_asn, Float

#cloud_provider ⇒ Symbol, ...

The Virtual Private Cloud with which you would like to establish a cross connect.

Returns:



25
 
# File 'lib/telnyx/models/virtual_cross_connect_combined.rb', line 25

optional :cloud_provider, enum: -> { Telnyx::VirtualCrossConnectCombined::CloudProvider }

#cloud_provider_region ⇒ String?

The region where your Virtual Private Cloud hosts are located.

Parameters:

  • (String)

Returns:

  • (String, nil) 


31
 
# File 'lib/telnyx/models/virtual_cross_connect_combined.rb', line 31

optional :cloud_provider_region, String

#created_at ⇒ String? (readonly)

Returns the value of attribute created_at.

Returns:

  • (String, nil) 


91
92
93
 
# File 'sig/telnyx/models/virtual_cross_connect_combined.rbs', line 91

def created_at
  @created_at
end

#id ⇒ String? (readonly)

Returns the value of attribute id.

Returns:

  • (String, nil) 


87
88
89
 
# File 'sig/telnyx/models/virtual_cross_connect_combined.rbs', line 87

def id
  @id
end

#name ⇒ String?

A user specified name for the interface.

Parameters:

  • (String)

Returns:

  • (String, nil) 


37
 
# File 'lib/telnyx/models/virtual_cross_connect_combined.rb', line 37

optional :name, String

#network_id ⇒ String?

The id of the network associated with the interface.

Parameters:

  • (String)

Returns:

  • (String, nil) 


43
 
# File 'lib/telnyx/models/virtual_cross_connect_combined.rb', line 43

optional :network_id, String

#primary_bgp_key ⇒ String?

The authentication key for BGP peer configuration.

Parameters:

  • (String)

Returns:

  • (String, nil) 


49
 
# File 'lib/telnyx/models/virtual_cross_connect_combined.rb', line 49

optional :primary_bgp_key, String

#primary_cloud_account_id ⇒ String?

The identifier for your Virtual Private Cloud.

Parameters:

  • (String)

Returns:

  • (String, nil) 


55
 
# File 'lib/telnyx/models/virtual_cross_connect_combined.rb', line 55

optional :primary_cloud_account_id, String

#primary_cloud_ip ⇒ String?

The IP address assigned for your side of the Virtual Cross Connect.

Parameters:

  • (String)

Returns:

  • (String, nil) 


61
 
# File 'lib/telnyx/models/virtual_cross_connect_combined.rb', line 61

optional :primary_cloud_ip, String

#primary_enabled ⇒ Boolean?

Indicates whether the primary circuit is enabled.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


67
 
# File 'lib/telnyx/models/virtual_cross_connect_combined.rb', line 67

optional :primary_enabled, Telnyx::Internal::Type::Boolean

#primary_routing_announcement ⇒ Boolean?

Whether

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


73
 
# File 'lib/telnyx/models/virtual_cross_connect_combined.rb', line 73

optional :primary_routing_announcement, Telnyx::Internal::Type::Boolean

#primary_telnyx_ip ⇒ String?

The IP address assigned to the Telnyx side of the Virtual Cross Connect.

Parameters:

  • (String)

Returns:

  • (String, nil) 


79
 
# File 'lib/telnyx/models/virtual_cross_connect_combined.rb', line 79

optional :primary_telnyx_ip, String

#record_type ⇒ String? (readonly)

Returns the value of attribute record_type.

Returns:

  • (String, nil) 


95
96
97
 
# File 'sig/telnyx/models/virtual_cross_connect_combined.rbs', line 95

def record_type
  @record_type
end

#region ⇒ Telnyx::Models::VirtualCrossConnectCombined::Region?

Returns:



84
 
# File 'lib/telnyx/models/virtual_cross_connect_combined.rb', line 84

optional :region, -> { Telnyx::VirtualCrossConnectCombined::Region }

#region_code ⇒ String?

The region interface is deployed to.

Parameters:

  • (String)

Returns:

  • (String, nil) 


90
 
# File 'lib/telnyx/models/virtual_cross_connect_combined.rb', line 90

optional :region_code, String

#status ⇒ Telnyx::Models::interface_status? (readonly)

Returns the value of attribute status.

Returns:

  • (Telnyx::Models::interface_status, nil) 


99
100
101
 
# File 'sig/telnyx/models/virtual_cross_connect_combined.rbs', line 99

def status
  @status
end

#updated_at ⇒ String? (readonly)

Returns the value of attribute updated_at.

Returns:

  • (String, nil) 


105
106
107
 
# File 'sig/telnyx/models/virtual_cross_connect_combined.rbs', line 105

def updated_at
  @updated_at
end

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/telnyx/models/virtual_cross_connect_combined.rb', line 177

Instance Method Details

#created_at= ⇒ String (readonly)

Parameters:

  • (String)

Returns:

  • (String) 


93
 
# File 'sig/telnyx/models/virtual_cross_connect_combined.rbs', line 93

def created_at=: (String) -> String

#id= ⇒ String (readonly)

Parameters:

  • (String)

Returns:

  • (String) 


89
 
# File 'sig/telnyx/models/virtual_cross_connect_combined.rbs', line 89

def id=: (String) -> String

#record_type= ⇒ String (readonly)

Parameters:

  • (String)

Returns:

  • (String) 


97
 
# File 'sig/telnyx/models/virtual_cross_connect_combined.rbs', line 97

def record_type=: (String) -> String

#status= ⇒ Object (readonly) 



101
 
# File 'sig/telnyx/models/virtual_cross_connect_combined.rbs', line 101

def status=: (

#to_hash ⇒ {

Returns:

  • ({) 


131
 
# File 'sig/telnyx/models/virtual_cross_connect_combined.rbs', line 131

def to_hash: -> {

#updated_at= ⇒ String (readonly)

Parameters:

  • (String)

Returns:

  • (String) 


107
 
# File 'sig/telnyx/models/virtual_cross_connect_combined.rbs', line 107

def updated_at=: (String) -> String