Class: Telnyx::Models::VirtualCrossConnectsCoverageListParams::Filter

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

Defined Under Namespace

Modules: CloudProvider

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(cloud_provider: nil, cloud_provider_region: nil, location_code: nil, location_pop: nil, location_region: nil, location_site: nil) ⇒ Object

Consolidated filter parameter (deepObject style). Originally: filter, filter, filter, filter, filter, filter

Parameters:

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

    The Virtual Private Cloud provider.

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

    The region of specific cloud provider.

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

    The code of associated location to filter on.

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

    The POP of associated location to filter on.

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

    The region of associated location to filter on.

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

    The site of associated location to filter on.



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/telnyx/models/virtual_cross_connects_coverage_list_params.rb', line 49

class Filter < Telnyx::Internal::Type::BaseModel
  # @!attribute cloud_provider
  #   The Virtual Private Cloud provider.
  #
  #   @return [Symbol, Telnyx::Models::VirtualCrossConnectsCoverageListParams::Filter::CloudProvider, nil]
  optional :cloud_provider,
           enum: -> { Telnyx::VirtualCrossConnectsCoverageListParams::Filter::CloudProvider }

  # @!attribute cloud_provider_region
  #   The region of specific cloud provider.
  #
  #   @return [String, nil]
  optional :cloud_provider_region, String

  # @!attribute location_code
  #   The code of associated location to filter on.
  #
  #   @return [String, nil]
  optional :location_code, String, api_name: :"location.code"

  # @!attribute location_pop
  #   The POP of associated location to filter on.
  #
  #   @return [String, nil]
  optional :location_pop, String, api_name: :"location.pop"

  # @!attribute location_region
  #   The region of associated location to filter on.
  #
  #   @return [String, nil]
  optional :location_region, String, api_name: :"location.region"

  # @!attribute location_site
  #   The site of associated location to filter on.
  #
  #   @return [String, nil]
  optional :location_site, String, api_name: :"location.site"

  # @!method initialize(cloud_provider: nil, cloud_provider_region: nil, location_code: nil, location_pop: nil, location_region: nil, location_site: nil)
  #   Consolidated filter parameter (deepObject style). Originally:
  #   filter[cloud_provider], filter[cloud_provider_region], filter[location.region],
  #   filter[location.site], filter[location.pop], filter[location.code]
  #
  #   @param cloud_provider [Symbol, Telnyx::Models::VirtualCrossConnectsCoverageListParams::Filter::CloudProvider] The Virtual Private Cloud provider.
  #
  #   @param cloud_provider_region [String] The region of specific cloud provider.
  #
  #   @param location_code [String] The code of associated location to filter on.
  #
  #   @param location_pop [String] The POP of associated location to filter on.
  #
  #   @param location_region [String] The region of associated location to filter on.
  #
  #   @param location_site [String] The site of associated location to filter on.

  # The Virtual Private Cloud provider.
  #
  # @see Telnyx::Models::VirtualCrossConnectsCoverageListParams::Filter#cloud_provider
  module CloudProvider
    extend Telnyx::Internal::Type::Enum

    AWS = :aws
    AZURE = :azure
    GCE = :gce

    # @!method self.values
    #   @return [Array<Symbol>]
  end
end

Instance Attribute Details

#cloud_provider ⇒ Symbol, ...

The Virtual Private Cloud provider.

Returns:



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

optional :cloud_provider,
enum: -> { Telnyx::VirtualCrossConnectsCoverageListParams::Filter::CloudProvider }

#cloud_provider_region ⇒ String?

The region of specific cloud provider.

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :cloud_provider_region, String

#location_code ⇒ String?

The code of associated location to filter on.

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :location_code, String, api_name: :"location.code"

#location_pop ⇒ String?

The POP of associated location to filter on.

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :location_pop, String, api_name: :"location.pop"

#location_region ⇒ String?

The region of associated location to filter on.

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :location_region, String, api_name: :"location.region"

#location_site ⇒ String?

The site of associated location to filter on.

Parameters:

  • (String)

Returns:

  • (String, nil) 


85
 
# File 'lib/telnyx/models/virtual_cross_connects_coverage_list_params.rb', line 85

optional :location_site, String, api_name: :"location.site"

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


98
 
# File 'sig/telnyx/models/virtual_cross_connects_coverage_list_params.rbs', line 98

def to_hash: -> {