Class: OCI::DatabaseTools::Models::DatabaseToolsPrivateEndpoint

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database_tools/models/database_tools_private_endpoint.rb

Overview

Allows the Database Tools service to connect to databases in a customer's virtual cloud network (VCN).

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.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 = {}) ⇒ DatabaseToolsPrivateEndpoint

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/oci/database_tools/models/database_tools_private_endpoint.rb', line 210

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

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

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

  self.security_attributes = attributes[:'securityAttributes'] if attributes[:'securityAttributes']

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

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

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

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

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

  self.endpoint_service_id = attributes[:'endpointServiceId'] if attributes[:'endpointServiceId']

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

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

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

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

  self.vcn_id = attributes[:'vcn_id'] if attributes[:'vcn_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.private_endpoint_vnic_id = attributes[:'privateEndpointVnicId'] if attributes[:'privateEndpointVnicId']

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

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

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

  self.endpoint_fqdn = attributes[:'endpointFqdn'] if attributes[:'endpointFqdn']

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

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

  self.additional_fqdns = attributes[:'additionalFqdns'] if attributes[:'additionalFqdns']

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

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

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

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

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

  self.reverse_connection_configuration = attributes[:'reverseConnectionConfiguration'] if attributes[:'reverseConnectionConfiguration']

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

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

Instance Attribute Details

#additional_fqdns ⇒ Array<String>

A list of additional FQDNs that can be also be used for the private endpoint.

Returns:

  • (Array<String>) 


102
103
104
 
# File 'lib/oci/database_tools/models/database_tools_private_endpoint.rb', line 102

def additional_fqdns
  @additional_fqdns
end

#compartment_id ⇒ String

[Required] The OCID of the compartment containing the Database Tools private endpoint.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/database_tools/models/database_tools_private_endpoint.rb', line 25

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. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

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


31
32
33
 
# File 'lib/oci/database_tools/models/database_tools_private_endpoint.rb', line 31

def defined_tags
  @defined_tags
end

#description ⇒ String

A description of the Database Tools private endpoint.

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/database_tools/models/database_tools_private_endpoint.rb', line 62

def description
  @description
end

#display_name ⇒ String

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/database_tools/models/database_tools_private_endpoint.rb', line 58

def display_name
  @display_name
end

#endpoint_fqdn ⇒ String

Then FQDN to use for the private endpoint.

Returns:

  • (String) 


98
99
100
 
# File 'lib/oci/database_tools/models/database_tools_private_endpoint.rb', line 98

def endpoint_fqdn
  @endpoint_fqdn
end

#endpoint_service_id ⇒ String

[Required] The OCID of the Database Tools Endpoint Service.

Returns:

  • (String) 


70
71
72
 
# File 'lib/oci/database_tools/models/database_tools_private_endpoint.rb', line 70

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


37
38
39
 
# File 'lib/oci/database_tools/models/database_tools_private_endpoint.rb', line 37

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the Database Tools private endpoint.

Returns:

  • (String) 


66
67
68
 
# File 'lib/oci/database_tools/models/database_tools_private_endpoint.rb', line 66

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) 


110
111
112
 
# File 'lib/oci/database_tools/models/database_tools_private_endpoint.rb', line 110

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the Database Tools private endpoint.

Returns:

  • (String) 


106
107
108
 
# File 'lib/oci/database_tools/models/database_tools_private_endpoint.rb', line 106

def lifecycle_state
  @lifecycle_state
end

#locks ⇒ Array<OCI::DatabaseTools::Models::ResourceLock>

Locks associated with this resource.

Returns:



54
55
56
 
# File 'lib/oci/database_tools/models/database_tools_private_endpoint.rb', line 54

def locks
  @locks
end

#nsg_ids ⇒ Array<String>

The OCID of the network security groups that the private endpoint's VNIC belongs to. For more information about NSGs, see NetworkSecurityGroup.

Returns:

  • (Array<String>) 


117
118
119
 
# File 'lib/oci/database_tools/models/database_tools_private_endpoint.rb', line 117

def nsg_ids
  @nsg_ids
end

#private_endpoint_ip ⇒ String

The private IP address that represents the access point for the associated endpoint service.

Returns:

  • (String) 


94
95
96
 
# File 'lib/oci/database_tools/models/database_tools_private_endpoint.rb', line 94

def private_endpoint_ip
  @private_endpoint_ip
end

#private_endpoint_vnic_id ⇒ String

The OCID of the private endpoint's VNIC.

Returns:

  • (String) 


90
91
92
 
# File 'lib/oci/database_tools/models/database_tools_private_endpoint.rb', line 90

def private_endpoint_vnic_id
  @private_endpoint_vnic_id
end

#reverse_connection_configuration ⇒ OCI::DatabaseTools::Models::DatabaseToolsPrivateEndpointReverseConnectionConfiguration

Returns:



120
121
122
 
# File 'lib/oci/database_tools/models/database_tools_private_endpoint.rb', line 120

def reverse_connection_configuration
  @reverse_connection_configuration
end

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

Zero trust Packet Routing (ZPR) Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see ZPR Artifacts. Example: {\"Oracle-ZPR\": {\"MaxEgressCount\": {\"value\": \"42\", \"mode\": \"audit\"}}}

Returns:

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


50
51
52
 
# File 'lib/oci/database_tools/models/database_tools_private_endpoint.rb', line 50

def security_attributes
  @security_attributes
end

#subnet_id ⇒ String

[Required] The OCID of the subnet that the private endpoint belongs to.

Returns:

  • (String) 


86
87
88
 
# File 'lib/oci/database_tools/models/database_tools_private_endpoint.rb', line 86

def subnet_id
  @subnet_id
end

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

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


43
44
45
 
# File 'lib/oci/database_tools/models/database_tools_private_endpoint.rb', line 43

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


74
75
76
 
# File 'lib/oci/database_tools/models/database_tools_private_endpoint.rb', line 74

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] The time the Database Tools private endpoint was updated. An RFC3339 formatted datetime string

Returns:

  • (DateTime) 


78
79
80
 
# File 'lib/oci/database_tools/models/database_tools_private_endpoint.rb', line 78

def time_updated
  @time_updated
end

#vcn_id ⇒ String

The OCID of the VCN that the private endpoint belongs to.

Returns:

  • (String) 


82
83
84
 
# File 'lib/oci/database_tools/models/database_tools_private_endpoint.rb', line 82

def vcn_id
  @vcn_id
end

Class Method Details

.attribute_map ⇒ Object

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



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/database_tools/models/database_tools_private_endpoint.rb', line 123

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'defined_tags': :'definedTags',
    'freeform_tags': :'freeformTags',
    'system_tags': :'systemTags',
    'security_attributes': :'securityAttributes',
    'locks': :'locks',
    'display_name': :'displayName',
    'description': :'description',
    'id': :'id',
    'endpoint_service_id': :'endpointServiceId',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'vcn_id': :'vcnId',
    'subnet_id': :'subnetId',
    'private_endpoint_vnic_id': :'privateEndpointVnicId',
    'private_endpoint_ip': :'privateEndpointIp',
    'endpoint_fqdn': :'endpointFqdn',
    'additional_fqdns': :'additionalFqdns',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'nsg_ids': :'nsgIds',
    'reverse_connection_configuration': :'reverseConnectionConfiguration'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/oci/database_tools/models/database_tools_private_endpoint.rb', line 153

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'freeform_tags': :'Hash<String, String>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'security_attributes': :'Hash<String, Hash<String, Object>>',
    'locks': :'Array<OCI::DatabaseTools::Models::ResourceLock>',
    'display_name': :'String',
    'description': :'String',
    'id': :'String',
    'endpoint_service_id': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'vcn_id': :'String',
    'subnet_id': :'String',
    'private_endpoint_vnic_id': :'String',
    'private_endpoint_ip': :'String',
    'endpoint_fqdn': :'String',
    'additional_fqdns': :'Array<String>',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'nsg_ids': :'Array<String>',
    'reverse_connection_configuration': :'OCI::DatabaseTools::Models::DatabaseToolsPrivateEndpointReverseConnectionConfiguration'
    # 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



357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/oci/database_tools/models/database_tools_private_endpoint.rb', line 357

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    defined_tags == other.defined_tags &&
    freeform_tags == other.freeform_tags &&
    system_tags == other.system_tags &&
    security_attributes == other.security_attributes &&
    locks == other.locks &&
    display_name == other.display_name &&
    description == other.description &&
    id == other.id &&
    endpoint_service_id == other.endpoint_service_id &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    vcn_id == other.vcn_id &&
    subnet_id == other.subnet_id &&
    private_endpoint_vnic_id == other.private_endpoint_vnic_id &&
    private_endpoint_ip == other.private_endpoint_ip &&
    endpoint_fqdn == other.endpoint_fqdn &&
    additional_fqdns == other.additional_fqdns &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    nsg_ids == other.nsg_ids &&
    reverse_connection_configuration == other.reverse_connection_configuration
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



408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/oci/database_tools/models/database_tools_private_endpoint.rb', line 408

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


388
389
390
 
# File 'lib/oci/database_tools/models/database_tools_private_endpoint.rb', line 388

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



397
398
399
 
# File 'lib/oci/database_tools/models/database_tools_private_endpoint.rb', line 397

def hash
  [compartment_id, defined_tags, freeform_tags, system_tags, security_attributes, locks, display_name, description, id, endpoint_service_id, time_created, time_updated, vcn_id, subnet_id, private_endpoint_vnic_id, private_endpoint_ip, endpoint_fqdn, additional_fqdns, lifecycle_state, lifecycle_details, nsg_ids, reverse_connection_configuration].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



441
442
443
444
445
446
447
448
449
450
 
# File 'lib/oci/database_tools/models/database_tools_private_endpoint.rb', line 441

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



435
436
437
 
# File 'lib/oci/database_tools/models/database_tools_private_endpoint.rb', line 435

def to_s
  to_hash.to_s
end