Class: OCI::Identity::Models::CustomerSecretKeySummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/identity/models/customer_secret_key_summary.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 = {}) ⇒ CustomerSecretKeySummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
89
 
# File 'lib/oci/identity/models/customer_secret_key_summary.rb', line 55

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[:'id']
    self.id = attributes[:'id']
  end

  if attributes[:'userId']
    self.user_id = attributes[:'userId']
  end

  if attributes[:'displayName']
    self.display_name = attributes[:'displayName']
  end

  if attributes[:'timeCreated']
    self.time_created = attributes[:'timeCreated']
  end

  if attributes[:'timeExpires']
    self.time_expires = attributes[:'timeExpires']
  end

  if attributes[:'lifecycleState']
    self.lifecycle_state = attributes[:'lifecycleState']
  end

  if attributes[:'inactiveStatus']
    self.inactive_status = attributes[:'inactiveStatus']
  end

end

Instance Attribute Details

#display_name ⇒ String

The displayName you assign to the secret key. Does not have to be unique, and it’s changeable.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/identity/models/customer_secret_key_summary.rb', line 25

def display_name
  @display_name
end

#id ⇒ String

The OCID of the secret key.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/identity/models/customer_secret_key_summary.rb', line 17

def id
  @id
end

#inactive_status ⇒ Integer

The detailed status of INACTIVE lifecycleState.

Returns:

  • (Integer) 


50
51
52
 
# File 'lib/oci/identity/models/customer_secret_key_summary.rb', line 50

def inactive_status
  @inactive_status
end

#lifecycle_state ⇒ String

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

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/identity/models/customer_secret_key_summary.rb', line 46

def lifecycle_state
  @lifecycle_state
end

#time_created ⇒ DateTime

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

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

Returns:

  • (DateTime) 


32
33
34
 
# File 'lib/oci/identity/models/customer_secret_key_summary.rb', line 32

def time_created
  @time_created
end

#time_expires ⇒ DateTime

Date and time when this password will expire, in the format defined by RFC3339. Null if it never expires.

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

Returns:

  • (DateTime) 


40
41
42
 
# File 'lib/oci/identity/models/customer_secret_key_summary.rb', line 40

def time_expires
  @time_expires
end

#user_id ⇒ String

The OCID of the user the password belongs to.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/identity/models/customer_secret_key_summary.rb', line 21

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



103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/oci/identity/models/customer_secret_key_summary.rb', line 103

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      id == other_object.id &&
      user_id == other_object.user_id &&
      display_name == other_object.display_name &&
      time_created == other_object.time_created &&
      time_expires == other_object.time_expires &&
      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



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

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| OCI::Internal::Util.convert_to_type($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", OCI::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


117
118
119
 
# File 'lib/oci/identity/models/customer_secret_key_summary.rb', line 117

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



123
124
125
 
# File 'lib/oci/identity/models/customer_secret_key_summary.rb', line 123

def hash
  [id, user_id, display_name, time_created, time_expires, 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



155
156
157
158
159
160
161
162
163
 
# File 'lib/oci/identity/models/customer_secret_key_summary.rb', line 155

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



149
150
151
 
# File 'lib/oci/identity/models/customer_secret_key_summary.rb', line 149

def to_s
  to_hash.to_s
end