Class: Verizon::ListRegionsResult

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/verizon/models/list_regions_result.rb

Overview

Response to return an array of all regions in the Verizon 5G Edge service. You can use the region IDs from the response to find optimal Edge platforms or service endpoints.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(regions = SKIP) ⇒ ListRegionsResult

Returns a new instance of ListRegionsResult.



37
38
39
 
# File 'lib/verizon/models/list_regions_result.rb', line 37

def initialize(regions = SKIP)
  @regions = regions unless regions == SKIP
end

Instance Attribute Details

#regions ⇒ Array[Region]

An array of all regions in the Verizon 5G Edge service.

Returns:



16
17
18
 
# File 'lib/verizon/models/list_regions_result.rb', line 16

def regions
  @regions
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/verizon/models/list_regions_result.rb', line 42

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  # Parameter is an array, so we need to iterate through it
  regions = nil
  unless hash['regions'].nil?
    regions = []
    hash['regions'].each do |structure|
      regions << (Region.from_hash(structure) if structure)
    end
  end

  regions = SKIP unless hash.key?('regions')

  # Create object from extracted values.
  ListRegionsResult.new(regions)
end

.names ⇒ Object

A mapping from model property names to API property names.



19
20
21
22
23
 
# File 'lib/verizon/models/list_regions_result.rb', line 19

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['regions'] = 'regions'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



33
34
35
 
# File 'lib/verizon/models/list_regions_result.rb', line 33

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



26
27
28
29
30
 
# File 'lib/verizon/models/list_regions_result.rb', line 26

def self.optionals
  %w[
    regions
  ]
end