Class: OCI::Bds::Models::BdsCertificateConfiguration

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/bds/models/bds_certificate_configuration.rb

Overview

The BDS certificate configuration information.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
TYPE_ENUM = 
[
  TYPE_SELF_SIGNED = 'SELF_SIGNED'.freeze,
  TYPE_OCI_CERTIFICATE = 'OCI_CERTIFICATE'.freeze,
  TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BdsCertificateConfiguration

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :bds_instance_id (String) —

    The value to assign to the #bds_instance_id property

  • :id (String) —

    The value to assign to the #id property

  • :certificate_authority_id (String) —

    The value to assign to the #certificate_authority_id property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :time_last_refreshed_or_generated (DateTime) —

    The value to assign to the #time_last_refreshed_or_generated property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :type (String) —

    The value to assign to the #type property

  • :is_default_configuration (BOOLEAN) —

    The value to assign to the #is_default_configuration property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
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
 
# File 'lib/oci/bds/models/bds_certificate_configuration.rb', line 127

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.bds_instance_id = attributes[:'bdsInstanceId'] if attributes[:'bdsInstanceId']

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

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

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

  self.certificate_authority_id = attributes[:'certificateAuthorityId'] if attributes[:'certificateAuthorityId']

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

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

  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.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.time_last_refreshed_or_generated = attributes[:'timeLastRefreshedOrGenerated'] if attributes[:'timeLastRefreshedOrGenerated']

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

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

  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']

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

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

  self.is_default_configuration = attributes[:'isDefaultConfiguration'] unless attributes[:'isDefaultConfiguration'].nil?

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

  self.is_default_configuration = attributes[:'is_default_configuration'] unless attributes[:'is_default_configuration'].nil?

  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']
end

Instance Attribute Details

#bds_instance_id ⇒ String

[Required] The OCID of the bdsInstance which is the parent resource id.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/bds/models/bds_certificate_configuration.rb', line 30

def bds_instance_id
  @bds_instance_id
end

#certificate_authority_id ⇒ String

The OCID of the certificate authority which is associated with this certificate configuration. The value is Null when this BDS certificate configuration type is SELF_SIGNED.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/bds/models/bds_certificate_configuration.rb', line 38

def certificate_authority_id
  @certificate_authority_id
end

#compartment_id ⇒ String

The OCID of the compartment of the certificate authority connecting to this certificate configuration.

Returns:

  • (String) 


70
71
72
 
# File 'lib/oci/bds/models/bds_certificate_configuration.rb', line 70

def compartment_id
  @compartment_id
end

#display_name ⇒ String

[Required] The display name of the BDS certificate configuration.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/bds/models/bds_certificate_configuration.rb', line 46

def display_name
  @display_name
end

#id ⇒ String

[Required] The ID of the BDS certificate configuration defined under BDS resources, not OCID.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/bds/models/bds_certificate_configuration.rb', line 34

def id
  @id
end

#is_default_configuration ⇒ BOOLEAN

[Required] If this BDS certificate configuration is a default configuration or not. There will be only one Default certificate configuration per BDS cluster.

Returns:

  • (BOOLEAN) 


66
67
68
 
# File 'lib/oci/bds/models/bds_certificate_configuration.rb', line 66

def is_default_configuration
  @is_default_configuration
end

#lifecycle_state ⇒ String

[Required] The lifecycle status of the BDS certificate configuration.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/bds/models/bds_certificate_configuration.rb', line 42

def lifecycle_state
  @lifecycle_state
end

#time_created ⇒ DateTime

[Required] The time when the BDS certificate configuration was created, shown as an RFC 3339 formatted datetime string.

Returns:

  • (DateTime) 


54
55
56
 
# File 'lib/oci/bds/models/bds_certificate_configuration.rb', line 54

def time_created
  @time_created
end

#time_last_refreshed_or_generated ⇒ DateTime

The last time the BDS certificate configuration was used to generate or renew the certificate(s).

Returns:

  • (DateTime) 


50
51
52
 
# File 'lib/oci/bds/models/bds_certificate_configuration.rb', line 50

def time_last_refreshed_or_generated
  @time_last_refreshed_or_generated
end

#time_updated ⇒ DateTime

[Required] The time the BDS certificate configuration was updated, shown as an RFC 3339 formatted datetime string.

Returns:

  • (DateTime) 


58
59
60
 
# File 'lib/oci/bds/models/bds_certificate_configuration.rb', line 58

def time_updated
  @time_updated
end

#type ⇒ String

[Required] The type of the BDS certificate configuration, also the type of the BDS certificates which will be generated by the BDS certificate configuration.

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/bds/models/bds_certificate_configuration.rb', line 62

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/oci/bds/models/bds_certificate_configuration.rb', line 73

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'bds_instance_id': :'bdsInstanceId',
    'id': :'id',
    'certificate_authority_id': :'certificateAuthorityId',
    'lifecycle_state': :'lifecycleState',
    'display_name': :'displayName',
    'time_last_refreshed_or_generated': :'timeLastRefreshedOrGenerated',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'type': :'type',
    'is_default_configuration': :'isDefaultConfiguration',
    'compartment_id': :'compartmentId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/oci/bds/models/bds_certificate_configuration.rb', line 92

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'bds_instance_id': :'String',
    'id': :'String',
    'certificate_authority_id': :'String',
    'lifecycle_state': :'String',
    'display_name': :'String',
    'time_last_refreshed_or_generated': :'DateTime',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'type': :'String',
    'is_default_configuration': :'BOOLEAN',
    'compartment_id': :'String'
    # 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



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/oci/bds/models/bds_certificate_configuration.rb', line 225

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

  self.class == other.class &&
    bds_instance_id == other.bds_instance_id &&
    id == other.id &&
    certificate_authority_id == other.certificate_authority_id &&
    lifecycle_state == other.lifecycle_state &&
    display_name == other.display_name &&
    time_last_refreshed_or_generated == other.time_last_refreshed_or_generated &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    type == other.type &&
    is_default_configuration == other.is_default_configuration &&
    compartment_id == other.compartment_id
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



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/oci/bds/models/bds_certificate_configuration.rb', line 265

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


245
246
247
 
# File 'lib/oci/bds/models/bds_certificate_configuration.rb', line 245

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



254
255
256
 
# File 'lib/oci/bds/models/bds_certificate_configuration.rb', line 254

def hash
  [bds_instance_id, id, certificate_authority_id, lifecycle_state, display_name, time_last_refreshed_or_generated, time_created, time_updated, type, is_default_configuration, compartment_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



298
299
300
301
302
303
304
305
306
307
 
# File 'lib/oci/bds/models/bds_certificate_configuration.rb', line 298

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



292
293
294
 
# File 'lib/oci/bds/models/bds_certificate_configuration.rb', line 292

def to_s
  to_hash.to_s
end