Class: OCI::DatabaseManagement::Models::DbManagementPrivateEndpoint

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database_management/models/db_management_private_endpoint.rb

Overview

A Database Management private endpoint allows Database Management to connect to databases in a 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_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DbManagementPrivateEndpoint

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

  • :name (String) —

    The value to assign to the #name property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :is_cluster (BOOLEAN) —

    The value to assign to the #is_cluster property

  • :is_dns_resolution_enabled (BOOLEAN) —

    The value to assign to the #is_dns_resolution_enabled property

  • :vcn_id (String) —

    The value to assign to the #vcn_id property

  • :subnet_id (String) —

    The value to assign to the #subnet_id property

  • :private_ip (String) —

    The value to assign to the #private_ip property

  • :description (String) —

    The value to assign to the #description property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :nsg_ids (Array<String>) —

    The value to assign to the #nsg_ids 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

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

    The value to assign to the #system_tags property

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

    The value to assign to the #security_attributes property



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
262
 
# File 'lib/oci/database_management/models/db_management_private_endpoint.rb', line 173

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

  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.is_cluster = attributes[:'isCluster'] unless attributes[:'isCluster'].nil?

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

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

  self.is_dns_resolution_enabled = attributes[:'isDnsResolutionEnabled'] unless attributes[:'isDnsResolutionEnabled'].nil?

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

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

  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_ip = attributes[:'privateIp'] if attributes[:'privateIp']

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

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

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/database_management/models/db_management_private_endpoint.rb', line 32

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. Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

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


84
85
86
 
# File 'lib/oci/database_management/models/db_management_private_endpoint.rb', line 84

def defined_tags
  @defined_tags
end

#description ⇒ String

The description of the Database Management private endpoint.

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/database_management/models/db_management_private_endpoint.rb', line 57

def description
  @description
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. Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


77
78
79
 
# File 'lib/oci/database_management/models/db_management_private_endpoint.rb', line 77

def freeform_tags
  @freeform_tags
end

#id ⇒ String

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

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/database_management/models/db_management_private_endpoint.rb', line 24

def id
  @id
end

#is_cluster ⇒ BOOLEAN

Specifies whether the Database Management private endpoint can be used for Oracle Databases in a cluster.

Returns:

  • (BOOLEAN) 


36
37
38
 
# File 'lib/oci/database_management/models/db_management_private_endpoint.rb', line 36

def is_cluster
  @is_cluster
end

#is_dns_resolution_enabled ⇒ BOOLEAN

Specifies whether the Database Management private endpoint has DNS proxy server enabled to resolve private host name.

Returns:

  • (BOOLEAN) 


40
41
42
 
# File 'lib/oci/database_management/models/db_management_private_endpoint.rb', line 40

def is_dns_resolution_enabled
  @is_dns_resolution_enabled
end

#lifecycle_state ⇒ String

The current lifecycle state of the Database Management private endpoint.

Returns:

  • (String) 


65
66
67
 
# File 'lib/oci/database_management/models/db_management_private_endpoint.rb', line 65

def lifecycle_state
  @lifecycle_state
end

#name ⇒ String

[Required] The display name of the Database Management private endpoint.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/database_management/models/db_management_private_endpoint.rb', line 28

def name
  @name
end

#nsg_ids ⇒ Array<String>

The OCIDs of the Network Security Groups to which the Database Management private endpoint belongs.

Returns:

  • (Array<String>) 


70
71
72
 
# File 'lib/oci/database_management/models/db_management_private_endpoint.rb', line 70

def nsg_ids
  @nsg_ids
end

#private_ip ⇒ String

The IP addresses assigned to the Database Management private endpoint.

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/database_management/models/db_management_private_endpoint.rb', line 53

def private_ip
  @private_ip
end

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

Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {\"Oracle-ZPR\": {\"MaxEgressCount\": {\"value\": \"42\", \"mode\": \"enforce\"}}}

Returns:

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


101
102
103
 
# File 'lib/oci/database_management/models/db_management_private_endpoint.rb', line 101

def security_attributes
  @security_attributes
end

#subnet_id ⇒ String

[Required] The OCID of the subnet.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/database_management/models/db_management_private_endpoint.rb', line 48

def subnet_id
  @subnet_id
end

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

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system.

Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


93
94
95
 
# File 'lib/oci/database_management/models/db_management_private_endpoint.rb', line 93

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

The date and time the Database Managament private endpoint was created, in the format defined by RFC3339.

Returns:

  • (DateTime) 


61
62
63
 
# File 'lib/oci/database_management/models/db_management_private_endpoint.rb', line 61

def time_created
  @time_created
end

#vcn_id ⇒ String

[Required] The OCID of the VCN.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/database_management/models/db_management_private_endpoint.rb', line 44

def vcn_id
  @vcn_id
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'name': :'name',
    'compartment_id': :'compartmentId',
    'is_cluster': :'isCluster',
    'is_dns_resolution_enabled': :'isDnsResolutionEnabled',
    'vcn_id': :'vcnId',
    'subnet_id': :'subnetId',
    'private_ip': :'privateIp',
    'description': :'description',
    'time_created': :'timeCreated',
    'lifecycle_state': :'lifecycleState',
    'nsg_ids': :'nsgIds',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'security_attributes': :'securityAttributes'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/oci/database_management/models/db_management_private_endpoint.rb', line 128

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'name': :'String',
    'compartment_id': :'String',
    'is_cluster': :'BOOLEAN',
    'is_dns_resolution_enabled': :'BOOLEAN',
    'vcn_id': :'String',
    'subnet_id': :'String',
    'private_ip': :'String',
    'description': :'String',
    'time_created': :'DateTime',
    'lifecycle_state': :'String',
    'nsg_ids': :'Array<String>',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'security_attributes': :'Hash<String, Hash<String, Object>>'
    # 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



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

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

  self.class == other.class &&
    id == other.id &&
    name == other.name &&
    compartment_id == other.compartment_id &&
    is_cluster == other.is_cluster &&
    is_dns_resolution_enabled == other.is_dns_resolution_enabled &&
    vcn_id == other.vcn_id &&
    subnet_id == other.subnet_id &&
    private_ip == other.private_ip &&
    description == other.description &&
    time_created == other.time_created &&
    lifecycle_state == other.lifecycle_state &&
    nsg_ids == other.nsg_ids &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags &&
    security_attributes == other.security_attributes
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/database_management/models/db_management_private_endpoint.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/database_management/models/db_management_private_endpoint.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/database_management/models/db_management_private_endpoint.rb', line 318

def hash
  [id, name, compartment_id, is_cluster, is_dns_resolution_enabled, vcn_id, subnet_id, private_ip, description, time_created, lifecycle_state, nsg_ids, freeform_tags, defined_tags, system_tags, security_attributes].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/database_management/models/db_management_private_endpoint.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/database_management/models/db_management_private_endpoint.rb', line 356

def to_s
  to_hash.to_s
end