Class: Azure::ARM::Web::Models::HostingEnvironmentCollection

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/generated/azure_mgmt_web/models/hosting_environment_collection.rb

Overview

Collection of hosting environments (App Service Environments)

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

Returns Link to next page of resources.

Returns:

  • (String) —

    Link to next page of resources



19
20
21
 
# File 'lib/generated/azure_mgmt_web/models/hosting_environment_collection.rb', line 19

def next_link
  @next_link
end

#next_method ⇒ Object

return [Proc] with next page method call.



22
23
24
 
# File 'lib/generated/azure_mgmt_web/models/hosting_environment_collection.rb', line 22

def next_method
  @next_method
end

#value ⇒ Array<HostingEnvironment>

Returns Collection of resources.

Returns:



16
17
18
 
# File 'lib/generated/azure_mgmt_web/models/hosting_environment_collection.rb', line 16

def value
  @value
end

Class Method Details

.mapper ⇒ Object

Mapper for HostingEnvironmentCollection class as Ruby Hash. This will be used for serialization/deserialization.



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
 
# File 'lib/generated/azure_mgmt_web/models/hosting_environment_collection.rb', line 57

def self.mapper()
  {
    required: false,
    serialized_name: 'HostingEnvironmentCollection',
    type: {
      name: 'Composite',
      class_name: 'HostingEnvironmentCollection',
      model_properties: {
        value: {
          required: false,
          serialized_name: 'value',
          type: {
            name: 'Sequence',
            element: {
                required: false,
                serialized_name: 'HostingEnvironmentElementType',
                type: {
                  name: 'Composite',
                  class_name: 'HostingEnvironment'
                }
            }
          }
        },
        next_link: {
          required: false,
          serialized_name: 'nextLink',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end

Instance Method Details

#get_all_items ⇒ Array<HostingEnvironment>

Gets the rest of the items for the request, enabling auto-pagination.

Returns:



29
30
31
32
33
34
35
36
37
 
# File 'lib/generated/azure_mgmt_web/models/hosting_environment_collection.rb', line 29

def get_all_items
  items = @value
  page = self
  while page.next_link != nil do
    page = page.get_next_page
    items.concat(page.value)
  end
  items
end

#get_next_page ⇒ HostingEnvironmentCollection

Gets the next page of results.

Returns:



44
45
46
47
48
49
50
51
 
# File 'lib/generated/azure_mgmt_web/models/hosting_environment_collection.rb', line 44

def get_next_page
  response = @next_method.call(@next_link).value! unless @next_method.nil?
  unless response.nil?
    @next_link = response.body.next_link
    @value = response.body.value
    self
  end
end