Class: OCI::KeyManagement::Models::EkmsPrivateEndpoint

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/key_management/models/ekms_private_endpoint.rb

Overview

EKMS private endpoint created in customer subnet used to connect to external key manager system

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_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EkmsPrivateEndpoint

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :subnet_id (String) —

    The value to assign to the #subnet_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_updated (DateTime) —

    The value to assign to the #time_updated property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details property

  • :external_key_manager_ip (String) —

    The value to assign to the #external_key_manager_ip property

  • :port (Integer) —

    The value to assign to the #port property

  • :ca_bundle (String) —

    The value to assign to the #ca_bundle property

  • :private_endpoint_ip (String) —

    The value to assign to the #private_endpoint_ip property



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
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
 
# File 'lib/oci/key_management/models/ekms_private_endpoint.rb', line 147

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

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

  self.subnet_id = attributes[:'subnet_id'] if attributes[:'subnet_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.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.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.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

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

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

  self.external_key_manager_ip = attributes[:'externalKeyManagerIp'] if attributes[:'externalKeyManagerIp']

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

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

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

  self.ca_bundle = attributes[:'caBundle'] if attributes[:'caBundle']

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

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

  self.private_endpoint_ip = attributes[:'privateEndpointIp'] if attributes[:'privateEndpointIp']

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

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

Instance Attribute Details

#ca_bundle ⇒ String

CABundle to validate TLS certificate of the external key manager system in PEM format

Returns:

  • (String) 


77
78
79
 
# File 'lib/oci/key_management/models/ekms_private_endpoint.rb', line 77

def ca_bundle
  @ca_bundle
end

#compartment_id ⇒ String

[Required] Compartment Identifier.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/key_management/models/ekms_private_endpoint.rb', line 27

def compartment_id
  @compartment_id
end

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

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

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


55
56
57
 
# File 'lib/oci/key_management/models/ekms_private_endpoint.rb', line 55

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] EKMS Private Endpoint display name

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/key_management/models/ekms_private_endpoint.rb', line 35

def display_name
  @display_name
end

#external_key_manager_ip ⇒ String

[Required] Private IP of the external key manager system to connect to from the EKMS private endpoint

Returns:

  • (String) 


68
69
70
 
# File 'lib/oci/key_management/models/ekms_private_endpoint.rb', line 68

def external_key_manager_ip
  @external_key_manager_ip
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


49
50
51
 
# File 'lib/oci/key_management/models/ekms_private_endpoint.rb', line 49

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] Unique identifier that is immutable

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/key_management/models/ekms_private_endpoint.rb', line 23

def id
  @id
end

#lifecycle_details ⇒ String

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in 'Failed' state.

Returns:

  • (String) 


63
64
65
 
# File 'lib/oci/key_management/models/ekms_private_endpoint.rb', line 63

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the EKMS private endpoint resource.

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/key_management/models/ekms_private_endpoint.rb', line 59

def lifecycle_state
  @lifecycle_state
end

#port ⇒ Integer

The port of the external key manager system

Returns:

  • (Integer) 


72
73
74
 
# File 'lib/oci/key_management/models/ekms_private_endpoint.rb', line 72

def port
  @port
end

#private_endpoint_ip ⇒ String

The IP address in the customer's VCN for the EKMS private endpoint. This is taken from subnet

Returns:

  • (String) 


81
82
83
 
# File 'lib/oci/key_management/models/ekms_private_endpoint.rb', line 81

def private_endpoint_ip
  @private_endpoint_ip
end

#subnet_id ⇒ String

[Required] Subnet Identifier

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/key_management/models/ekms_private_endpoint.rb', line 31

def subnet_id
  @subnet_id
end

#time_created ⇒ DateTime

[Required] The time the EKMS private endpoint was created. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


39
40
41
 
# File 'lib/oci/key_management/models/ekms_private_endpoint.rb', line 39

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The time the EKMS private endpoint was updated. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


43
44
45
 
# File 'lib/oci/key_management/models/ekms_private_endpoint.rb', line 43

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/oci/key_management/models/ekms_private_endpoint.rb', line 84

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'subnet_id': :'subnetId',
    'display_name': :'displayName',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'external_key_manager_ip': :'externalKeyManagerIp',
    'port': :'port',
    'ca_bundle': :'caBundle',
    'private_endpoint_ip': :'privateEndpointIp'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/oci/key_management/models/ekms_private_endpoint.rb', line 106

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'subnet_id': :'String',
    'display_name': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'external_key_manager_ip': :'String',
    'port': :'Integer',
    'ca_bundle': :'String',
    'private_endpoint_ip': :'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



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/oci/key_management/models/ekms_private_endpoint.rb', line 250

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    subnet_id == other.subnet_id &&
    display_name == other.display_name &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    external_key_manager_ip == other.external_key_manager_ip &&
    port == other.port &&
    ca_bundle == other.ca_bundle &&
    private_endpoint_ip == other.private_endpoint_ip
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



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/oci/key_management/models/ekms_private_endpoint.rb', line 293

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


273
274
275
 
# File 'lib/oci/key_management/models/ekms_private_endpoint.rb', line 273

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



282
283
284
 
# File 'lib/oci/key_management/models/ekms_private_endpoint.rb', line 282

def hash
  [id, compartment_id, subnet_id, display_name, time_created, time_updated, freeform_tags, defined_tags, lifecycle_state, lifecycle_details, external_key_manager_ip, port, ca_bundle, private_endpoint_ip].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



326
327
328
329
330
331
332
333
334
335
 
# File 'lib/oci/key_management/models/ekms_private_endpoint.rb', line 326

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



320
321
322
 
# File 'lib/oci/key_management/models/ekms_private_endpoint.rb', line 320

def to_s
  to_hash.to_s
end