Class: Azure::KeyVault::V7_2_preview::Models::KeyListResult

Inherits:
Object
  • Object
show all
Includes:
MsRest::JSONable, MsRestAzure
Defined in:
lib/7.2-preview/generated/azure_key_vault/models/key_list_result.rb

Overview

The key list result.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

Returns The URL to get the next set of keys.

Returns:

  • (String) —

    The URL to get the next set of keys.



21
22
23
 
# File 'lib/7.2-preview/generated/azure_key_vault/models/key_list_result.rb', line 21

def next_link
  @next_link
end

#next_method ⇒ Object

return [Proc] with next page method call.



24
25
26
 
# File 'lib/7.2-preview/generated/azure_key_vault/models/key_list_result.rb', line 24

def next_method
  @next_method
end

#value ⇒ Array<KeyItem>

in the key vault along with a link to the next page of keys.

Returns:

  • (Array<KeyItem>) —

    A response message containing a list of keys



18
19
20
 
# File 'lib/7.2-preview/generated/azure_key_vault/models/key_list_result.rb', line 18

def value
  @value
end

Class Method Details

.mapper ⇒ Object

Mapper for KeyListResult 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
94
95
96
97
98
 
# File 'lib/7.2-preview/generated/azure_key_vault/models/key_list_result.rb', line 59

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

Instance Method Details

#get_all_items ⇒ Array<KeyItem>

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

Returns:

  • (Array<KeyItem>) —

    operation results.



31
32
33
34
35
36
37
38
39
 
# File 'lib/7.2-preview/generated/azure_key_vault/models/key_list_result.rb', line 31

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

#get_next_page ⇒ KeyListResult

Gets the next page of results.

Returns:



46
47
48
49
50
51
52
53
 
# File 'lib/7.2-preview/generated/azure_key_vault/models/key_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