Class: OCI::Identity::Models::CustomerSecretKey

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/identity/models/customer_secret_key.rb

Overview

A ‘CustomerSecretKey` is an Oracle-provided key for using the Object Storage Service’s [Amazon S3 compatible API](docs.us-phoenix-1.oraclecloud.com/Content/Object/Tasks/s3compatibleapi.htm). A user can have up to two secret keys at a time.

Note: The secret key is always an Oracle-generated string; you can’t change it to a string of your choice.

For more information, see [Managing User Credentials](docs.us-phoenix-1.oraclecloud.com/Content/Identity/Tasks/managingcredentials.htm).

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 = {}) ⇒ CustomerSecretKey

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :key (String) —

    The value to assign to the #key property

  • :id (String) —

    The value to assign to the #id property

  • :user_id (String) —

    The value to assign to the #user_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_expires (DateTime) —

    The value to assign to the #time_expires property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :inactive_status (Integer) —

    The value to assign to the #inactive_status property



76
77
78
79
80
81
82
83
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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/oci/identity/models/customer_secret_key.rb', line 76

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

  if attributes[:'id']
    self.id = attributes[:'id']
  end

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

  raise 'You cannot provide both :userId and :user_id' if attributes.key?(:'userId') && attributes.key?(:'user_id')

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

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

  raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name')

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

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

  raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created')

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

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

  raise 'You cannot provide both :timeExpires and :time_expires' if attributes.key?(:'timeExpires') && attributes.key?(:'time_expires')

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

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

  raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state')

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

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

  raise 'You cannot provide both :inactiveStatus and :inactive_status' if attributes.key?(:'inactiveStatus') && attributes.key?(:'inactive_status')

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

end

Instance Attribute Details

#display_name ⇒ String

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

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/identity/models/customer_secret_key.rb', line 38

def display_name
  @display_name
end

#id ⇒ String

The OCID of the secret key.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/identity/models/customer_secret_key.rb', line 30

def id
  @id
end

#inactive_status ⇒ Integer

The detailed status of INACTIVE lifecycleState.

Returns:

  • (Integer) 


63
64
65
 
# File 'lib/oci/identity/models/customer_secret_key.rb', line 63

def inactive_status
  @inactive_status
end

#key ⇒ String

The secret key.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/identity/models/customer_secret_key.rb', line 26

def key
  @key
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) 


59
60
61
 
# File 'lib/oci/identity/models/customer_secret_key.rb', line 59

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) 


45
46
47
 
# File 'lib/oci/identity/models/customer_secret_key.rb', line 45

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) 


53
54
55
 
# File 'lib/oci/identity/models/customer_secret_key.rb', line 53

def time_expires
  @time_expires
end

#user_id ⇒ String

The OCID of the user the password belongs to.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/identity/models/customer_secret_key.rb', line 34

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



164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/oci/identity/models/customer_secret_key.rb', line 164

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      key == other_object.key &&
      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



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/oci/identity/models/customer_secret_key.rb', line 192

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.public_method("#{key}=").call(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.public_method("#{key}=").call(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


179
180
181
 
# File 'lib/oci/identity/models/customer_secret_key.rb', line 179

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



185
186
187
 
# File 'lib/oci/identity/models/customer_secret_key.rb', line 185

def hash
  [key, 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



217
218
219
220
221
222
223
224
225
 
# File 'lib/oci/identity/models/customer_secret_key.rb', line 217

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    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



211
212
213
 
# File 'lib/oci/identity/models/customer_secret_key.rb', line 211

def to_s
  to_hash.to_s
end