Class: Telnyx::Models::TrafficPolicyProfile

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

Overview

See Also:

  • Telnyx::Resources::TrafficPolicyProfiles#list

Defined Under Namespace

Modules: Type

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(id: nil, created_at: nil, domains: nil, ip_ranges: nil, limit_bw_kbps: nil, record_type: nil, services: nil, type: nil, updated_at: nil) ⇒ Object

Parameters:

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

    Identifies the resource.

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

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

  • domains (Array<String>) (defaults to: nil) —

    Array of domain names.

  • ip_ranges (Array<String>) (defaults to: nil) —

    Array of IP ranges in CIDR notation.

  • limit_bw_kbps (Integer, nil) (defaults to: nil) —

    Bandwidth limit in kbps.

  • record_type (String) (defaults to: nil)
  • services (Array<String>) (defaults to: nil) —

    Array of PCEF service IDs included in the profile.

  • type (Symbol, Telnyx::Models::TrafficPolicyProfile::Type) (defaults to: nil) —

    The type of the traffic policy profile.

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

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




# File 'lib/telnyx/models/traffic_policy_profile.rb', line 62

Instance Attribute Details

#created_at ⇒ String? (readonly)

Returns the value of attribute created_at.

Returns:

  • (String, nil) 


41
42
43
 
# File 'sig/telnyx/models/traffic_policy_profile.rbs', line 41

def created_at
  @created_at
end

#domains ⇒ Array<String>?

Array of domain names.

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


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

optional :domains, Telnyx::Internal::Type::ArrayOf[String]

#id ⇒ String? (readonly)

Returns the value of attribute id.

Returns:

  • (String, nil) 


37
38
39
 
# File 'sig/telnyx/models/traffic_policy_profile.rbs', line 37

def id
  @id
end

#ip_ranges ⇒ Array<String>?

Array of IP ranges in CIDR notation.

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


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

optional :ip_ranges, Telnyx::Internal::Type::ArrayOf[String]

#limit_bw_kbps ⇒ Integer?

Bandwidth limit in kbps.

Parameters:

  • value (Integer, nil)

Returns:

  • (Integer, nil) 


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

optional :limit_bw_kbps, Integer, nil?: true

#record_type ⇒ String? (readonly)

Returns the value of attribute record_type.

Returns:

  • (String, nil) 


45
46
47
 
# File 'sig/telnyx/models/traffic_policy_profile.rbs', line 45

def record_type
  @record_type
end

#services ⇒ Array<String>?

Array of PCEF service IDs included in the profile.

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


29
 
# File 'lib/telnyx/models/traffic_policy_profile.rb', line 29

optional :services, Telnyx::Internal::Type::ArrayOf[String]

#type ⇒ Symbol, ...

The type of the traffic policy profile.

Returns:



35
 
# File 'lib/telnyx/models/traffic_policy_profile.rb', line 35

optional :type, enum: -> { Telnyx::TrafficPolicyProfile::Type }

#updated_at ⇒ String? (readonly)

Returns the value of attribute updated_at.

Returns:

  • (String, nil) 


49
50
51
 
# File 'sig/telnyx/models/traffic_policy_profile.rbs', line 49

def updated_at
  @updated_at
end

Instance Method Details

#created_at= ⇒ String (readonly)

Parameters:

  • (String)

Returns:

  • (String) 


43
 
# File 'sig/telnyx/models/traffic_policy_profile.rbs', line 43

def created_at=: (String) -> String

#id= ⇒ String (readonly)

Parameters:

  • (String)

Returns:

  • (String) 


39
 
# File 'sig/telnyx/models/traffic_policy_profile.rbs', line 39

def id=: (String) -> String

#record_type= ⇒ String (readonly)

Parameters:

  • (String)

Returns:

  • (String) 


47
 
# File 'sig/telnyx/models/traffic_policy_profile.rbs', line 47

def record_type=: (String) -> String

#to_hash ⇒ {

Returns:

  • ({) 


65
 
# File 'sig/telnyx/models/traffic_policy_profile.rbs', line 65

def to_hash: -> {

#updated_at= ⇒ String (readonly)

Parameters:

  • (String)

Returns:

  • (String) 


51
 
# File 'sig/telnyx/models/traffic_policy_profile.rbs', line 51

def updated_at=: (String) -> String