Class: OCI::GloballyDistributedDatabase::Models::PrivateEndpoint

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/globally_distributed_database/models/private_endpoint.rb

Overview

PrivateEndpoint 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 = {}) ⇒ PrivateEndpoint

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

  • :vcn_id (String) —

    The value to assign to the #vcn_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :private_ip (String) —

    The value to assign to the #private_ip property

  • :nsg_ids (Array<String>) —

    The value to assign to the #nsg_ids property

  • :sharded_databases (Array<String>) —

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

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_state_details (String) —

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



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
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
 
# File 'lib/oci/globally_distributed_database/models/private_endpoint.rb', line 164

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

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

  self.sharded_databases = attributes[:'sharded_databases'] if attributes[:'sharded_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_state_details = attributes[:'lifecycleStateDetails'] if attributes[:'lifecycleStateDetails']

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

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

  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/globally_distributed_database/models/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>>) 


86
87
88
 
# File 'lib/oci/globally_distributed_database/models/private_endpoint.rb', line 86

def defined_tags
  @defined_tags
end

#description ⇒ String

PrivateEndpoint description.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/globally_distributed_database/models/private_endpoint.rb', line 45

def description
  @description
end

#display_name ⇒ String

[Required] PrivateEndpoint display name.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/globally_distributed_database/models/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>) 


80
81
82
 
# File 'lib/oci/globally_distributed_database/models/private_endpoint.rb', line 80

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The identifier of the Private Endpoint.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/globally_distributed_database/models/private_endpoint.rb', line 25

def id
  @id
end

#lifecycle_state ⇒ String

[Required] Lifecycle states for private endpoint.

Returns:

  • (String) 


70
71
72
 
# File 'lib/oci/globally_distributed_database/models/private_endpoint.rb', line 70

def lifecycle_state
  @lifecycle_state
end

#lifecycle_state_details ⇒ String

Detailed message for the lifecycle state.

Returns:

  • (String) 


74
75
76
 
# File 'lib/oci/globally_distributed_database/models/private_endpoint.rb', line 74

def lifecycle_state_details
  @lifecycle_state_details
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/globally_distributed_database/models/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/globally_distributed_database/models/private_endpoint.rb', line 49

def private_ip
  @private_ip
end

#sharded_databases ⇒ Array<String>

The OCIDs of sharded databases that consumes the given private endpoint.

Returns:

  • (Array<String>) 


58
59
60
 
# File 'lib/oci/globally_distributed_database/models/private_endpoint.rb', line 58

def sharded_databases
  @sharded_databases
end

#subnet_id ⇒ String

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

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/globally_distributed_database/models/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>>) 


92
93
94
 
# File 'lib/oci/globally_distributed_database/models/private_endpoint.rb', line 92

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


62
63
64
 
# File 'lib/oci/globally_distributed_database/models/private_endpoint.rb', line 62

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) 


66
67
68
 
# File 'lib/oci/globally_distributed_database/models/private_endpoint.rb', line 66

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/globally_distributed_database/models/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.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/oci/globally_distributed_database/models/private_endpoint.rb', line 95

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',
    'sharded_databases': :'shardedDatabases',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_state_details': :'lifecycleStateDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/oci/globally_distributed_database/models/private_endpoint.rb', line 119

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>',
    'sharded_databases': :'Array<String>',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_state_details': :'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



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/oci/globally_distributed_database/models/private_endpoint.rb', line 279

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 &&
    sharded_databases == other.sharded_databases &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_state_details == other.lifecycle_state_details &&
    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



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/oci/globally_distributed_database/models/private_endpoint.rb', line 324

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


304
305
306
 
# File 'lib/oci/globally_distributed_database/models/private_endpoint.rb', line 304

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



313
314
315
 
# File 'lib/oci/globally_distributed_database/models/private_endpoint.rb', line 313

def hash
  [id, compartment_id, subnet_id, vcn_id, display_name, description, private_ip, nsg_ids, sharded_databases, time_created, time_updated, lifecycle_state, lifecycle_state_details, 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



357
358
359
360
361
362
363
364
365
366
 
# File 'lib/oci/globally_distributed_database/models/private_endpoint.rb', line 357

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



351
352
353
 
# File 'lib/oci/globally_distributed_database/models/private_endpoint.rb', line 351

def to_s
  to_hash.to_s
end