Class: Akeyless::GatewayUpdateCache

Inherits:
Object
  • Object
show all
Defined in:
lib/akeyless/models/gateway_update_cache.rb

Overview

gatewayUpdateCache is a command that updates cache settings

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GatewayUpdateCache

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/akeyless/models/gateway_update_cache.rb', line 84

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Akeyless::GatewayUpdateCache` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Akeyless::GatewayUpdateCache`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'backup_interval')
    self.backup_interval = attributes[:'backup_interval']
  else
    self.backup_interval = '1'
  end

  if attributes.key?(:'enable_cache')
    self.enable_cache = attributes[:'enable_cache']
  end

  if attributes.key?(:'enable_proactive')
    self.enable_proactive = attributes[:'enable_proactive']
  end

  if attributes.key?(:'json')
    self.json = attributes[:'json']
  else
    self.json = false
  end

  if attributes.key?(:'minimum_fetch_interval')
    self.minimum_fetch_interval = attributes[:'minimum_fetch_interval']
  else
    self.minimum_fetch_interval = '5'
  end

  if attributes.key?(:'stale_timeout')
    self.stale_timeout = attributes[:'stale_timeout']
  else
    self.stale_timeout = '60'
  end

  if attributes.key?(:'token')
    self.token = attributes[:'token']
  end

  if attributes.key?(:'uid_token')
    self.uid_token = attributes[:'uid_token']
  end
end

Instance Attribute Details

#backup_interval ⇒ Object

Secure backup interval in minutes. To ensure service continuity in case of power cycle and network outage secrets will be backed up periodically per backup interval



20
21
22
 
# File 'lib/akeyless/models/gateway_update_cache.rb', line 20

def backup_interval
  @backup_interval
end

#enable_cache ⇒ Object

Enable cache [true/false]



23
24
25
 
# File 'lib/akeyless/models/gateway_update_cache.rb', line 23

def enable_cache
  @enable_cache
end

#enable_proactive ⇒ Object

Enable proactive caching [true/false]



26
27
28
 
# File 'lib/akeyless/models/gateway_update_cache.rb', line 26

def enable_proactive
  @enable_proactive
end

#json ⇒ Object

Set output format to JSON



29
30
31
 
# File 'lib/akeyless/models/gateway_update_cache.rb', line 29

def json
  @json
end

#minimum_fetch_interval ⇒ Object

When using Cache or/and Proactive Cache, additional secrets will be fetched upon requesting a secret, based on the requestor’s access policy. Define minimum fetching interval to avoid over fetching in a given time frame



32
33
34
 
# File 'lib/akeyless/models/gateway_update_cache.rb', line 32

def minimum_fetch_interval
  @minimum_fetch_interval
end

#stale_timeout ⇒ Object

Stale timeout in minutes, cache entries which are not accessed within timeout will be removed from cache



35
36
37
 
# File 'lib/akeyless/models/gateway_update_cache.rb', line 35

def stale_timeout
  @stale_timeout
end

#token ⇒ Object

Authentication token (see ‘/auth` and `/configure`)



38
39
40
 
# File 'lib/akeyless/models/gateway_update_cache.rb', line 38

def token
  @token
end

#uid_token ⇒ Object

The universal identity token, Required only for universal_identity authentication



41
42
43
 
# File 'lib/akeyless/models/gateway_update_cache.rb', line 41

def uid_token
  @uid_token
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/akeyless/models/gateway_update_cache.rb', line 207

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = Akeyless.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



58
59
60
 
# File 'lib/akeyless/models/gateway_update_cache.rb', line 58

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/akeyless/models/gateway_update_cache.rb', line 44

def self.attribute_map
  {
    :'backup_interval' => :'backup-interval',
    :'enable_cache' => :'enable-cache',
    :'enable_proactive' => :'enable-proactive',
    :'json' => :'json',
    :'minimum_fetch_interval' => :'minimum-fetch-interval',
    :'stale_timeout' => :'stale-timeout',
    :'token' => :'token',
    :'uid_token' => :'uid-token'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/akeyless/models/gateway_update_cache.rb', line 183

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



77
78
79
80
 
# File 'lib/akeyless/models/gateway_update_cache.rb', line 77

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/akeyless/models/gateway_update_cache.rb', line 63

def self.openapi_types
  {
    :'backup_interval' => :'String',
    :'enable_cache' => :'String',
    :'enable_proactive' => :'String',
    :'json' => :'Boolean',
    :'minimum_fetch_interval' => :'String',
    :'stale_timeout' => :'String',
    :'token' => :'String',
    :'uid_token' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/akeyless/models/gateway_update_cache.rb', line 155

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      backup_interval == o.backup_interval &&
      enable_cache == o.enable_cache &&
      enable_proactive == o.enable_proactive &&
      json == o.json &&
      minimum_fetch_interval == o.minimum_fetch_interval &&
      stale_timeout == o.stale_timeout &&
      token == o.token &&
      uid_token == o.uid_token
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/akeyless/models/gateway_update_cache.rb', line 278

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


170
171
172
 
# File 'lib/akeyless/models/gateway_update_cache.rb', line 170

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



176
177
178
 
# File 'lib/akeyless/models/gateway_update_cache.rb', line 176

def hash
  [backup_interval, enable_cache, enable_proactive, json, minimum_fetch_interval, stale_timeout, token, uid_token].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



140
141
142
143
144
 
# File 'lib/akeyless/models/gateway_update_cache.rb', line 140

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



254
255
256
 
# File 'lib/akeyless/models/gateway_update_cache.rb', line 254

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/akeyless/models/gateway_update_cache.rb', line 260

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



248
249
250
 
# File 'lib/akeyless/models/gateway_update_cache.rb', line 248

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



148
149
150
151
 
# File 'lib/akeyless/models/gateway_update_cache.rb', line 148

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end