Class: Fastly::AutomationTokenResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/fastly/models/automation_token_response.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AutomationTokenResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/fastly/models/automation_token_response.rb', line 140

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Fastly::AutomationTokenResponse` 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 `Fastly::AutomationTokenResponse`. 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?(:'name')
    self.name = attributes[:'name']
  end

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

  if attributes.key?(:'services')
    if (value = attributes[:'services']).is_a?(Array)
      self.services = value
    end
  end

  if attributes.key?(:'scope')
    self.scope = attributes[:'scope']
  else
    self.scope = 'global'
  end

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#created_at ⇒ Object

A UTC time-stamp of when the token was created.



31
32
33
 
# File 'lib/fastly/models/automation_token_response.rb', line 31

def created_at
  @created_at
end

#customer_id ⇒ Object

Returns the value of attribute customer_id.



41
42
43
 
# File 'lib/fastly/models/automation_token_response.rb', line 41

def customer_id
  @customer_id
end

#deleted_at ⇒ Object

Date and time in ISO 8601 format.



34
35
36
 
# File 'lib/fastly/models/automation_token_response.rb', line 34

def deleted_at
  @deleted_at
end

#expires_at ⇒ Object

(optional) A UTC time-stamp of when the token will expire.



28
29
30
 
# File 'lib/fastly/models/automation_token_response.rb', line 28

def expires_at
  @expires_at
end

#id ⇒ Object

Returns the value of attribute id.



39
40
41
 
# File 'lib/fastly/models/automation_token_response.rb', line 39

def id
  @id
end

#ip ⇒ Object

The IP address of the client that last used the token.



44
45
46
 
# File 'lib/fastly/models/automation_token_response.rb', line 44

def ip
  @ip
end

#last_used_at ⇒ Object

A UTC time-stamp of when the token was last used.



52
53
54
 
# File 'lib/fastly/models/automation_token_response.rb', line 52

def last_used_at
  @last_used_at
end

#name ⇒ Object

The name of the token.



17
18
19
 
# File 'lib/fastly/models/automation_token_response.rb', line 17

def name
  @name
end

#role ⇒ Object

Returns the value of attribute role.



19
20
21
 
# File 'lib/fastly/models/automation_token_response.rb', line 19

def role
  @role
end

#scope ⇒ Object

A space-delimited list of authorization scope.



25
26
27
 
# File 'lib/fastly/models/automation_token_response.rb', line 25

def scope
  @scope
end

#services ⇒ Object

(Optional) The service IDs of the services the token will have access to. Separate service IDs with a space. If no services are specified, the token will have access to all services on the account.



22
23
24
 
# File 'lib/fastly/models/automation_token_response.rb', line 22

def services
  @services
end

#sudo_expires_at ⇒ Object

Returns the value of attribute sudo_expires_at.



49
50
51
 
# File 'lib/fastly/models/automation_token_response.rb', line 49

def sudo_expires_at
  @sudo_expires_at
end

#updated_at ⇒ Object

Date and time in ISO 8601 format.



37
38
39
 
# File 'lib/fastly/models/automation_token_response.rb', line 37

def updated_at
  @updated_at
end

#user_agent ⇒ Object

The User-Agent header of the client that last used the token.



47
48
49
 
# File 'lib/fastly/models/automation_token_response.rb', line 47

def user_agent
  @user_agent
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



97
98
99
 
# File 'lib/fastly/models/automation_token_response.rb', line 97

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/fastly/models/automation_token_response.rb', line 77

def self.attribute_map
  {
    :'name' => :'name',
    :'role' => :'role',
    :'services' => :'services',
    :'scope' => :'scope',
    :'expires_at' => :'expires_at',
    :'created_at' => :'created_at',
    :'deleted_at' => :'deleted_at',
    :'updated_at' => :'updated_at',
    :'id' => :'id',
    :'customer_id' => :'customer_id',
    :'ip' => :'ip',
    :'user_agent' => :'user_agent',
    :'sudo_expires_at' => :'sudo_expires_at',
    :'last_used_at' => :'last_used_at'
  }
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



275
276
277
 
# File 'lib/fastly/models/automation_token_response.rb', line 275

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.fastly_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



130
131
132
133
134
135
136
 
# File 'lib/fastly/models/automation_token_response.rb', line 130

def self.fastly_all_of
  [
  :'AutomationToken',
  :'AutomationTokenResponseAllOf',
  :'Timestamps'
  ]
end

.fastly_nullable ⇒ Object

List of attributes with nullable: true



122
123
124
125
126
127
 
# File 'lib/fastly/models/automation_token_response.rb', line 122

def self.fastly_nullable
  Set.new([
    :'deleted_at',
    :'updated_at',
  ])
end

.fastly_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/fastly/models/automation_token_response.rb', line 102

def self.fastly_types
  {
    :'name' => :'String',
    :'role' => :'String',
    :'services' => :'Array<String>',
    :'scope' => :'String',
    :'expires_at' => :'String',
    :'created_at' => :'String',
    :'deleted_at' => :'Time',
    :'updated_at' => :'Time',
    :'id' => :'ReadOnlyId',
    :'customer_id' => :'ReadOnlyCustomerId',
    :'ip' => :'String',
    :'user_agent' => :'String',
    :'sudo_expires_at' => :'String',
    :'last_used_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/fastly/models/automation_token_response.rb', line 241

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      role == o.role &&
      services == o.services &&
      scope == o.scope &&
      expires_at == o.expires_at &&
      created_at == o.created_at &&
      deleted_at == o.deleted_at &&
      updated_at == o.updated_at &&
      id == o.id &&
      customer_id == o.customer_id &&
      ip == o.ip &&
      user_agent == o.user_agent &&
      sudo_expires_at == o.sudo_expires_at &&
      last_used_at == o.last_used_at
end

#_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



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/fastly/models/automation_token_response.rb', line 305

def _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 = Fastly.const_get(type)
    klass.respond_to?(:fastly_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
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



376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/fastly/models/automation_token_response.rb', line 376

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

#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



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/fastly/models/automation_token_response.rb', line 282

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.fastly_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.fastly_nullable.include?(key)
      self.send("#{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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


262
263
264
 
# File 'lib/fastly/models/automation_token_response.rb', line 262

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



268
269
270
 
# File 'lib/fastly/models/automation_token_response.rb', line 268

def hash
  [name, role, services, scope, expires_at, created_at, deleted_at, updated_at, id, customer_id, ip, user_agent, sudo_expires_at, last_used_at].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



216
217
218
219
 
# File 'lib/fastly/models/automation_token_response.rb', line 216

def list_invalid_properties
  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



352
353
354
 
# File 'lib/fastly/models/automation_token_response.rb', line 352

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



358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/fastly/models/automation_token_response.rb', line 358

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.fastly_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



346
347
348
 
# File 'lib/fastly/models/automation_token_response.rb', line 346

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



223
224
225
226
227
 
# File 'lib/fastly/models/automation_token_response.rb', line 223

def valid?
  scope_validator = EnumAttributeValidator.new('String', ["global", "purge_select", "purge_all", "global:read"])
  return false unless scope_validator.valid?(@scope)
  true
end