class Fastly::AutomationTokenCreateResponse

Attributes

access_token[RW]
created_at[RW]

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

customer_id[RW]
deleted_at[RW]

Date and time in ISO 8601 format.

expires_at[RW]

A UTC time-stamp of when the token expires.

id[RW]
last_used_at[RW]

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

name[RW]

The name of the token.

role[RW]

The role on the token.

scope[RW]

A space-delimited list of authorization scope.

services[RW]

(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.

sudo_expires_at[RW]
updated_at[RW]

Date and time in ISO 8601 format.

user_agent[RW]

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

user_id[RW]

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/fastly/models/automation_token_create_response.rb, line 100
def self.acceptable_attributes
  attribute_map.values
end
attribute_map() click to toggle source

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

# File lib/fastly/models/automation_token_create_response.rb, line 79
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',
    :'user_id' => :'user_id',
    :'customer_id' => :'customer_id',
    :'sudo_expires_at' => :'sudo_expires_at',
    :'access_token' => :'access_token',
    :'last_used_at' => :'last_used_at',
    :'user_agent' => :'user_agent'
  }
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/fastly/models/automation_token_create_response.rb, line 296
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
fastly_all_of() click to toggle source

List of class defined in allOf (OpenAPI v3)

# File lib/fastly/models/automation_token_create_response.rb, line 134
def self.fastly_all_of
  [
  :'AutomationToken',
  :'AutomationTokenCreateResponseAllOf',
  :'Timestamps'
  ]
end
fastly_nullable() click to toggle source

List of attributes with nullable: true

# File lib/fastly/models/automation_token_create_response.rb, line 126
def self.fastly_nullable
  Set.new([
    :'deleted_at',
    :'updated_at',
  ])
end
fastly_types() click to toggle source

Attribute type mapping.

# File lib/fastly/models/automation_token_create_response.rb, line 105
def self.fastly_types
  {
    :'name' => :'String',
    :'role' => :'String',
    :'services' => :'Array<String>',
    :'scope' => :'String',
    :'expires_at' => :'String',
    :'created_at' => :'Time',
    :'deleted_at' => :'Time',
    :'updated_at' => :'Time',
    :'id' => :'ReadOnlyId',
    :'user_id' => :'ReadOnlyUserId',
    :'customer_id' => :'ReadOnlyCustomerId',
    :'sudo_expires_at' => :'Time',
    :'access_token' => :'String',
    :'last_used_at' => :'Time',
    :'user_agent' => :'String'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/fastly/models/automation_token_create_response.rb, line 144
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Fastly::AutomationTokenCreateResponse` 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::AutomationTokenCreateResponse`. 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?(:'user_id')
    self.user_id = attributes[:'user_id']
  end

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

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

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

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

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

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/fastly/models/automation_token_create_response.rb, line 261
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 &&
      user_id == o.user_id &&
      customer_id == o.customer_id &&
      sudo_expires_at == o.sudo_expires_at &&
      access_token == o.access_token &&
      last_used_at == o.last_used_at &&
      user_agent == o.user_agent
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/fastly/models/automation_token_create_response.rb, line 326
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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/fastly/models/automation_token_create_response.rb, line 397
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/fastly/models/automation_token_create_response.rb, line 303
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) click to toggle source

@see the ‘==` method @param [Object] Object to be compared

# File lib/fastly/models/automation_token_create_response.rb, line 283
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/fastly/models/automation_token_create_response.rb, line 289
def hash
  [name, role, services, scope, expires_at, created_at, deleted_at, updated_at, id, user_id, customer_id, sudo_expires_at, access_token, last_used_at, user_agent].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/fastly/models/automation_token_create_response.rb, line 224
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
role=(role) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] role Object to be assigned

# File lib/fastly/models/automation_token_create_response.rb, line 241
def role=(role)
  validator = EnumAttributeValidator.new('String', ["billing", "engineer", "user"])
  unless validator.valid?(role)
    fail ArgumentError, "invalid value for \"role\", must be one of #{validator.allowable_values}."
  end
  @role = role
end
scope=(scope) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] scope Object to be assigned

# File lib/fastly/models/automation_token_create_response.rb, line 251
def scope=(scope)
  validator = EnumAttributeValidator.new('String', ["global", "purge_select", "purge_all", "global:read"])
  unless validator.valid?(scope)
    fail ArgumentError, "invalid value for \"scope\", must be one of #{validator.allowable_values}."
  end
  @scope = scope
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/fastly/models/automation_token_create_response.rb, line 373
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/fastly/models/automation_token_create_response.rb, line 379
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/fastly/models/automation_token_create_response.rb, line 367
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/fastly/models/automation_token_create_response.rb, line 231
def valid?
  role_validator = EnumAttributeValidator.new('String', ["billing", "engineer", "user"])
  return false unless role_validator.valid?(@role)
  scope_validator = EnumAttributeValidator.new('String', ["global", "purge_select", "purge_all", "global:read"])
  return false unless scope_validator.valid?(@scope)
  true
end