Class: OracleBMC::Identity::Models::ApiKey

Inherits:
Object
  • Object
show all
Defined in:
lib/oraclebmc/identity/models/api_key.rb

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[LIFECYCLE_STATE_CREATING = 'CREATING',
LIFECYCLE_STATE_ACTIVE = 'ACTIVE',
LIFECYCLE_STATE_INACTIVE = 'INACTIVE',
LIFECYCLE_STATE_DELETING = 'DELETING',
LIFECYCLE_STATE_DELETED = 'DELETED',
LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ApiKey

Initializes the object

Parameters:

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

    Model attributes in the form of hash



53
54
55
56
57
58
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
 
# File 'lib/oraclebmc/identity/models/api_key.rb', line 53

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  
  if attributes[:'keyId']
    self.key_id = attributes[:'keyId']
  end
  
  if attributes[:'keyValue']
    self.key_value = attributes[:'keyValue']
  end
  
  if attributes[:'fingerprint']
    self.fingerprint = attributes[:'fingerprint']
  end
  
  if attributes[:'userId']
    self.user_id = attributes[:'userId']
  end
  
  if attributes[:'timeCreated']
    self.time_created = attributes[:'timeCreated']
  end
  
  if attributes[:'lifecycleState']
    self.lifecycle_state = attributes[:'lifecycleState']
  end
  
  if attributes[:'inactiveStatus']
    self.inactive_status = attributes[:'inactiveStatus']
  end
  
end

Instance Attribute Details

#fingerprint ⇒ String

The key’s fingerprint (e.g., 12:34:56:78:90:ab:cd:ef:12:34:56:78:90:ab:cd:ef).

Returns:

  • (String) 


27
28
29
 
# File 'lib/oraclebmc/identity/models/api_key.rb', line 27

def fingerprint
  @fingerprint
end

#inactive_status ⇒ Integer

The detailed status of INACTIVE lifecycleState.

Returns:

  • (Integer) 


48
49
50
 
# File 'lib/oraclebmc/identity/models/api_key.rb', line 48

def inactive_status
  @inactive_status
end

#key_id ⇒ String

An Oracle-assigned identifier for the key, in this format: TENANCY_OCID/USER_OCID/KEY_FINGERPRINT.

Returns:

  • (String) 


19
20
21
 
# File 'lib/oraclebmc/identity/models/api_key.rb', line 19

def key_id
  @key_id
end

#key_value ⇒ String

The key’s value.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oraclebmc/identity/models/api_key.rb', line 23

def key_value
  @key_value
end

#lifecycle_state ⇒ String

The API key’s current state. After creating an ‘ApiKey` object, make sure its `lifecycleState` changes from CREATING to ACTIVE before using it.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oraclebmc/identity/models/api_key.rb', line 44

def lifecycle_state
  @lifecycle_state
end

#time_created ⇒ DateTime

Date and time the ‘ApiKey` object was created, in the format defined by RFC3339.

Example: ‘2016-08-25T21:10:29.600Z`

Returns:

  • (DateTime) 


38
39
40
 
# File 'lib/oraclebmc/identity/models/api_key.rb', line 38

def time_created
  @time_created
end

#user_id ⇒ String

The OCID of the user the key belongs to.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oraclebmc/identity/models/api_key.rb', line 31

def user_id
  @user_id
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/oraclebmc/identity/models/api_key.rb', line 102

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      key_id == other_object.key_id &&
      key_value == other_object.key_value &&
      fingerprint == other_object.fingerprint &&
      user_id == other_object.user_id &&
      time_created == other_object.time_created &&
      lifecycle_state == other_object.lifecycle_state &&
      inactive_status == other_object.inactive_status
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



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/oraclebmc/identity/models/api_key.rb', line 129

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the 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| OracleBMC::Internal::Util.convert_to_type($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", OracleBMC::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other_object) ⇒ Boolean

Parameters:

  • other_object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


116
117
118
 
# File 'lib/oraclebmc/identity/models/api_key.rb', line 116

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



122
123
124
 
# File 'lib/oraclebmc/identity/models/api_key.rb', line 122

def hash
  [key_id, key_value, fingerprint, user_id, time_created, lifecycle_state, inactive_status].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



154
155
156
157
158
159
160
161
162
 
# File 'lib/oraclebmc/identity/models/api_key.rb', line 154

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



148
149
150
 
# File 'lib/oraclebmc/identity/models/api_key.rb', line 148

def to_s
  to_hash.to_s
end