Class: OCI::Waas::Models::Certificate

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/waas/models/certificate.rb

Overview

The details of the SSL certificate. Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Certificate

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/oci/waas/models/certificate.rb', line 166

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 }

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

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

  self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id']

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

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

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

  self.issued_by = attributes[:'issuedBy'] if attributes[:'issuedBy']

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

  self.issued_by = attributes[:'issued_by'] if attributes[:'issued_by']

  self.subject_name = attributes[:'subjectName'] if attributes[:'subjectName']

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

  self.subject_name = attributes[:'subject_name'] if attributes[:'subject_name']

  self.issuer_name = attributes[:'issuerName'] if attributes[:'issuerName']

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

  self.issuer_name = attributes[:'issuer_name'] if attributes[:'issuer_name']

  self.serial_number = attributes[:'serialNumber'] if attributes[:'serialNumber']

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

  self.serial_number = attributes[:'serial_number'] if attributes[:'serial_number']

  self.version = attributes[:'version'] if attributes[:'version']

  self.signature_algorithm = attributes[:'signatureAlgorithm'] if attributes[:'signatureAlgorithm']

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

  self.signature_algorithm = attributes[:'signature_algorithm'] if attributes[:'signature_algorithm']

  self.time_not_valid_before = attributes[:'timeNotValidBefore'] if attributes[:'timeNotValidBefore']

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

  self.time_not_valid_before = attributes[:'time_not_valid_before'] if attributes[:'time_not_valid_before']

  self.time_not_valid_after = attributes[:'timeNotValidAfter'] if attributes[:'timeNotValidAfter']

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

  self.time_not_valid_after = attributes[:'time_not_valid_after'] if attributes[:'time_not_valid_after']

  self.public_key_info = attributes[:'publicKeyInfo'] if attributes[:'publicKeyInfo']

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

  self.public_key_info = attributes[:'public_key_info'] if attributes[:'public_key_info']

  self.extensions = attributes[:'extensions'] if attributes[:'extensions']

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

  self.freeform_tags = attributes[:'freeform_tags'] if attributes[:'freeform_tags']

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

  self.defined_tags = attributes[:'defined_tags'] if attributes[:'defined_tags']

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

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

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

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

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the certificate’s compartment.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/waas/models/certificate.rb', line 27

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).

Example: ‘{"CostCenter": "42"}`

Returns:

  • (Hash<String, Hash<String, Object>>) 


83
84
85
 
# File 'lib/oci/waas/models/certificate.rb', line 83

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] The user-friendly name of the certificate.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/waas/models/certificate.rb', line 31

def display_name
  @display_name
end

#extensions ⇒ Array<OCI::Waas::Models::CertificateExtensions>

Additional attributes associated with users or public keys for managing relationships between Certificate Authorities.

Returns:



67
68
69
 
# File 'lib/oci/waas/models/certificate.rb', line 67

def extensions
  @extensions
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).

Example: ‘"Finance"`

Returns:

  • (Hash<String, String>) 


75
76
77
 
# File 'lib/oci/waas/models/certificate.rb', line 75

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the certificate.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/waas/models/certificate.rb', line 23

def id
  @id
end

#issued_by ⇒ String

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/waas/models/certificate.rb', line 34

def issued_by
  @issued_by
end

#issuer_name ⇒ OCI::Waas::Models::CertificateIssuerName

Returns:



40
41
42
 
# File 'lib/oci/waas/models/certificate.rb', line 40

def issuer_name
  @issuer_name
end

#lifecycle_state ⇒ String

The current lifecycle state of the SSL certificate.

Returns:

  • (String) 


87
88
89
 
# File 'lib/oci/waas/models/certificate.rb', line 87

def lifecycle_state
  @lifecycle_state
end

#public_key_info ⇒ OCI::Waas::Models::CertificatePublicKeyInfo

Returns:



63
64
65
 
# File 'lib/oci/waas/models/certificate.rb', line 63

def public_key_info
  @public_key_info
end

#serial_number ⇒ String

[Required] A unique, positive integer assigned by the Certificate Authority (CA). The issuer name and serial number identify a unique certificate.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/waas/models/certificate.rb', line 44

def serial_number
  @serial_number
end

#signature_algorithm ⇒ String

[Required] The identifier for the cryptographic algorithm used by the Certificate Authority (CA) to sign this certificate.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/waas/models/certificate.rb', line 52

def signature_algorithm
  @signature_algorithm
end

#subject_name ⇒ OCI::Waas::Models::CertificateSubjectName

Returns:



37
38
39
 
# File 'lib/oci/waas/models/certificate.rb', line 37

def subject_name
  @subject_name
end

#time_created ⇒ DateTime

The date and time the certificate was created, expressed in RFC 3339 timestamp format.

Returns:

  • (DateTime) 


91
92
93
 
# File 'lib/oci/waas/models/certificate.rb', line 91

def time_created
  @time_created
end

#time_not_valid_after ⇒ DateTime

[Required] The date and time the certificate will expire, expressed in RFC 3339 timestamp format.

Returns:

  • (DateTime) 


60
61
62
 
# File 'lib/oci/waas/models/certificate.rb', line 60

def time_not_valid_after
  @time_not_valid_after
end

#time_not_valid_before ⇒ DateTime

[Required] The date and time the certificate will become valid, expressed in RFC 3339 timestamp format.

Returns:

  • (DateTime) 


56
57
58
 
# File 'lib/oci/waas/models/certificate.rb', line 56

def time_not_valid_before
  @time_not_valid_before
end

#version ⇒ Integer

[Required] The version of the encoded certificate.

Returns:

  • (Integer) 


48
49
50
 
# File 'lib/oci/waas/models/certificate.rb', line 48

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/oci/waas/models/certificate.rb', line 94

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'issued_by': :'issuedBy',
    'subject_name': :'subjectName',
    'issuer_name': :'issuerName',
    'serial_number': :'serialNumber',
    'version': :'version',
    'signature_algorithm': :'signatureAlgorithm',
    'time_not_valid_before': :'timeNotValidBefore',
    'time_not_valid_after': :'timeNotValidAfter',
    'public_key_info': :'publicKeyInfo',
    'extensions': :'extensions',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/oci/waas/models/certificate.rb', line 119

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'issued_by': :'String',
    'subject_name': :'OCI::Waas::Models::CertificateSubjectName',
    'issuer_name': :'OCI::Waas::Models::CertificateIssuerName',
    'serial_number': :'String',
    'version': :'Integer',
    'signature_algorithm': :'String',
    'time_not_valid_before': :'DateTime',
    'time_not_valid_after': :'DateTime',
    'public_key_info': :'OCI::Waas::Models::CertificatePublicKeyInfo',
    'extensions': :'Array<OCI::Waas::Models::CertificateExtensions>',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'lifecycle_state': :'String',
    'time_created': :'DateTime'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/oci/waas/models/certificate.rb', line 283

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    issued_by == other.issued_by &&
    subject_name == other.subject_name &&
    issuer_name == other.issuer_name &&
    serial_number == other.serial_number &&
    version == other.version &&
    signature_algorithm == other.signature_algorithm &&
    time_not_valid_before == other.time_not_valid_before &&
    time_not_valid_after == other.time_not_valid_after &&
    public_key_info == other.public_key_info &&
    extensions == other.extensions &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created
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



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/oci/waas/models/certificate.rb', line 329

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

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


309
310
311
 
# File 'lib/oci/waas/models/certificate.rb', line 309

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



318
319
320
 
# File 'lib/oci/waas/models/certificate.rb', line 318

def hash
  [id, compartment_id, display_name, issued_by, subject_name, issuer_name, serial_number, version, signature_algorithm, time_not_valid_before, time_not_valid_after, public_key_info, extensions, freeform_tags, defined_tags, lifecycle_state, time_created].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



362
363
364
365
366
367
368
369
370
371
 
# File 'lib/oci/waas/models/certificate.rb', line 362

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



356
357
358
 
# File 'lib/oci/waas/models/certificate.rb', line 356

def to_s
  to_hash.to_s
end