Class: Azure::ARM::CognitiveServices::Models::CognitiveServicesAccountListResult

Inherits:
Object
  • Object
show all
Includes:
MsRest::JSONable, MsRestAzure
Defined in:
lib/generated/azure_mgmt_cognitive_services/models/cognitive_services_account_list_result.rb

Overview

The list of cognitive services accounts operation response.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

Returns The link used to get the next page of accounts.

Returns:

  • (String)

    The link used to get the next page of accounts.



17
18
19
# File 'lib/generated/azure_mgmt_cognitive_services/models/cognitive_services_account_list_result.rb', line 17

def next_link
  @next_link
end

#next_methodObject

return [Proc] with next page method call.



24
25
26
# File 'lib/generated/azure_mgmt_cognitive_services/models/cognitive_services_account_list_result.rb', line 24

def next_method
  @next_method
end

#valueArray<CognitiveServicesAccount>

Services accounts and their properties.

Returns:



21
22
23
# File 'lib/generated/azure_mgmt_cognitive_services/models/cognitive_services_account_list_result.rb', line 21

def value
  @value
end

Class Method Details

.mapperObject

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



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
# File 'lib/generated/azure_mgmt_cognitive_services/models/cognitive_services_account_list_result.rb', line 59

def self.mapper()
  {
    required: false,
    serialized_name: 'CognitiveServicesAccountListResult',
    type: {
      name: 'Composite',
      class_name: 'CognitiveServicesAccountListResult',
      model_properties: {
        next_link: {
          required: false,
          serialized_name: 'nextLink',
          type: {
            name: 'String'
          }
        },
        value: {
          required: false,
          read_only: true,
          serialized_name: 'value',
          type: {
            name: 'Sequence',
            element: {
                required: false,
                serialized_name: 'CognitiveServicesAccountElementType',
                type: {
                  name: 'Composite',
                  class_name: 'CognitiveServicesAccount'
                }
            }
          }
        }
      }
    }
  }
end

Instance Method Details

#get_all_itemsArray<CognitiveServicesAccount>

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

Returns:



31
32
33
34
35
36
37
38
39
# File 'lib/generated/azure_mgmt_cognitive_services/models/cognitive_services_account_list_result.rb', line 31

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_pageCognitiveServicesAccountListResult

Gets the next page of results.

Returns:



46
47
48
49
50
51
52
53
# File 'lib/generated/azure_mgmt_cognitive_services/models/cognitive_services_account_list_result.rb', line 46

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