Class: OCI::DistributedDatabase::Models::DistributedDatabasePrivateEndpoint

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/distributed_database/models/distributed_database_private_endpoint.rb

Overview

DistributedDatabasePrivateEndpoint resource.

Constant Summary collapse

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/oci/distributed_database/models/distributed_database_private_endpoint.rb', line 180

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

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

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

  self.globally_distributed_autonomous_databases = attributes[:'globallyDistributedAutonomousDatabases'] if attributes[:'globallyDistributedAutonomousDatabases']

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

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

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

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

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] Identifier of the compartment in which private endpoint exists.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/distributed_database/models/distributed_database_private_endpoint.rb', line 29

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>>) 


96
97
98
 
# File 'lib/oci/distributed_database/models/distributed_database_private_endpoint.rb', line 96

def defined_tags
  @defined_tags
end

#description ⇒ String

DistributedDatabasePrivateEndpoint description.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/distributed_database/models/distributed_database_private_endpoint.rb', line 45

def description
  @description
end

#display_name ⇒ String

[Required] DistributedDatabasePrivateEndpoint display name.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/distributed_database/models/distributed_database_private_endpoint.rb', line 41

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


90
91
92
 
# File 'lib/oci/distributed_database/models/distributed_database_private_endpoint.rb', line 90

def freeform_tags
  @freeform_tags
end

#globally_distributed_autonomous_databases ⇒ Array<OCI::DistributedDatabase::Models::DistributedAutonomousDatabaseAssociatedWithPrivateEndpoint>

This field is deprecated. Support for this field will be removed after Mon, 1 Mar 2027 00:00:00 GMT.

Returns:



64
65
66
 
# File 'lib/oci/distributed_database/models/distributed_database_private_endpoint.rb', line 64

def globally_distributed_autonomous_databases
  @globally_distributed_autonomous_databases
end

#globally_distributed_databases ⇒ Array<OCI::DistributedDatabase::Models::DistributedDatabaseAssociatedWithPrivateEndpoint>

This field is deprecated. Support for this field will be removed after Mon, 1 Mar 2027 00:00:00 GMT.

Returns:



59
60
61
 
# File 'lib/oci/distributed_database/models/distributed_database_private_endpoint.rb', line 59

def globally_distributed_databases
  @globally_distributed_databases
end

#id ⇒ String

[Required] The identifier of the Private Endpoint.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/distributed_database/models/distributed_database_private_endpoint.rb', line 25

def id
  @id
end

#lifecycle_details ⇒ String

Detailed message for the lifecycle state.

Returns:

  • (String) 


80
81
82
 
# File 'lib/oci/distributed_database/models/distributed_database_private_endpoint.rb', line 80

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] Lifecycle states for private endpoint.

Returns:

  • (String) 


76
77
78
 
# File 'lib/oci/distributed_database/models/distributed_database_private_endpoint.rb', line 76

def lifecycle_state
  @lifecycle_state
end

#nsg_ids ⇒ Array<String>

The OCIDs of the network security groups that the private endpoint belongs to.

Returns:

  • (Array<String>) 


54
55
56
 
# File 'lib/oci/distributed_database/models/distributed_database_private_endpoint.rb', line 54

def nsg_ids
  @nsg_ids
end

#private_ip ⇒ String

IP address of the Private Endpoint.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/distributed_database/models/distributed_database_private_endpoint.rb', line 49

def private_ip
  @private_ip
end

#proxy_compute_instance_id ⇒ String

The identifier of the proxy compute instance.

Returns:

  • (String) 


84
85
86
 
# File 'lib/oci/distributed_database/models/distributed_database_private_endpoint.rb', line 84

def proxy_compute_instance_id
  @proxy_compute_instance_id
end

#subnet_id ⇒ String

[Required] Identifier of the subnet in which private endpoint exists.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/distributed_database/models/distributed_database_private_endpoint.rb', line 33

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>>) 


102
103
104
 
# File 'lib/oci/distributed_database/models/distributed_database_private_endpoint.rb', line 102

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The time the DistributedDatabasePrivateEndpoint was first created. An RFC3339 formatted datetime string

Returns:

  • (DateTime) 


68
69
70
 
# File 'lib/oci/distributed_database/models/distributed_database_private_endpoint.rb', line 68

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] The time the Private Endpoint was last updated. An RFC3339 formatted datetime string

Returns:

  • (DateTime) 


72
73
74
 
# File 'lib/oci/distributed_database/models/distributed_database_private_endpoint.rb', line 72

def time_updated
  @time_updated
end

#vcn_id ⇒ String

[Required] Identifier of the VCN in which subnet exists.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/distributed_database/models/distributed_database_private_endpoint.rb', line 37

def vcn_id
  @vcn_id
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'subnet_id': :'subnetId',
    'vcn_id': :'vcnId',
    'display_name': :'displayName',
    'description': :'description',
    'private_ip': :'privateIp',
    'nsg_ids': :'nsgIds',
    'globally_distributed_databases': :'globallyDistributedDatabases',
    'globally_distributed_autonomous_databases': :'globallyDistributedAutonomousDatabases',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'proxy_compute_instance_id': :'proxyComputeInstanceId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/oci/distributed_database/models/distributed_database_private_endpoint.rb', line 131

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'subnet_id': :'String',
    'vcn_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'private_ip': :'String',
    'nsg_ids': :'Array<String>',
    'globally_distributed_databases': :'Array<OCI::DistributedDatabase::Models::DistributedDatabaseAssociatedWithPrivateEndpoint>',
    'globally_distributed_autonomous_databases': :'Array<OCI::DistributedDatabase::Models::DistributedAutonomousDatabaseAssociatedWithPrivateEndpoint>',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'proxy_compute_instance_id': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'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



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/oci/distributed_database/models/distributed_database_private_endpoint.rb', line 307

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    subnet_id == other.subnet_id &&
    vcn_id == other.vcn_id &&
    display_name == other.display_name &&
    description == other.description &&
    private_ip == other.private_ip &&
    nsg_ids == other.nsg_ids &&
    globally_distributed_databases == other.globally_distributed_databases &&
    globally_distributed_autonomous_databases == other.globally_distributed_autonomous_databases &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    proxy_compute_instance_id == other.proxy_compute_instance_id &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags
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



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/oci/distributed_database/models/distributed_database_private_endpoint.rb', line 354

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


334
335
336
 
# File 'lib/oci/distributed_database/models/distributed_database_private_endpoint.rb', line 334

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



343
344
345
 
# File 'lib/oci/distributed_database/models/distributed_database_private_endpoint.rb', line 343

def hash
  [id, compartment_id, subnet_id, vcn_id, display_name, description, private_ip, nsg_ids, globally_distributed_databases, globally_distributed_autonomous_databases, time_created, time_updated, lifecycle_state, lifecycle_details, proxy_compute_instance_id, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



387
388
389
390
391
392
393
394
395
396
 
# File 'lib/oci/distributed_database/models/distributed_database_private_endpoint.rb', line 387

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



381
382
383
 
# File 'lib/oci/distributed_database/models/distributed_database_private_endpoint.rb', line 381

def to_s
  to_hash.to_s
end