Class: OCI::DataCatalog::Models::CatalogPrivateEndpoint

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_catalog/models/catalog_private_endpoint.rb

Overview

A private network reverse connection creates a connection from service to customer subnet over a private network.

Constant Summary collapse

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

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

  • :dns_zones (Array<String>) —

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

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

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

  • :attached_catalogs (Array<String>) —

    The value to assign to the #attached_catalogs property

  • :locks (Array<OCI::DataCatalog::Models::ResourceLock>) —

    The value to assign to the #locks property



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
229
230
231
232
233
234
235
236
 
# File 'lib/oci/data_catalog/models/catalog_private_endpoint.rb', line 155

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

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

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

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

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

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

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

Instance Attribute Details

#attached_catalogs ⇒ Array<String>

The list of catalogs using the private reverse connection endpoint

Returns:

  • (Array<String>) 


85
86
87
 
# File 'lib/oci/data_catalog/models/catalog_private_endpoint.rb', line 85

def attached_catalogs
  @attached_catalogs
end

#compartment_id ⇒ String

[Required] Compartment Identifier.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/data_catalog/models/catalog_private_endpoint.rb', line 30

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


73
74
75
 
# File 'lib/oci/data_catalog/models/catalog_private_endpoint.rb', line 73

def defined_tags
  @defined_tags
end

#display_name ⇒ String

Private Reverse Connection Endpoint display name

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/data_catalog/models/catalog_private_endpoint.rb', line 38

def display_name
  @display_name
end

#dns_zones ⇒ Array<String>

[Required] List of DNS zones to be used by the data assets to be harvested. Example: custpvtsubnet.oraclevcn.com for data asset: db.custpvtsubnet.oraclevcn.com

Returns:

  • (Array<String>) 


44
45
46
 
# File 'lib/oci/data_catalog/models/catalog_private_endpoint.rb', line 44

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


58
59
60
 
# File 'lib/oci/data_catalog/models/catalog_private_endpoint.rb', line 58

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] Unique identifier that is immutable

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/data_catalog/models/catalog_private_endpoint.rb', line 26

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) 


81
82
83
 
# File 'lib/oci/data_catalog/models/catalog_private_endpoint.rb', line 81

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

The current state of the private endpoint resource.

Returns:

  • (String) 


77
78
79
 
# File 'lib/oci/data_catalog/models/catalog_private_endpoint.rb', line 77

def lifecycle_state
  @lifecycle_state
end

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

Locks associated with this resource.

Returns:



89
90
91
 
# File 'lib/oci/data_catalog/models/catalog_private_endpoint.rb', line 89

def locks
  @locks
end

#subnet_id ⇒ String

[Required] Subnet Identifier

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/data_catalog/models/catalog_private_endpoint.rb', line 34

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


67
68
69
 
# File 'lib/oci/data_catalog/models/catalog_private_endpoint.rb', line 67

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


48
49
50
 
# File 'lib/oci/data_catalog/models/catalog_private_endpoint.rb', line 48

def time_created
  @time_created
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


52
53
54
 
# File 'lib/oci/data_catalog/models/catalog_private_endpoint.rb', line 52

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/oci/data_catalog/models/catalog_private_endpoint.rb', line 92

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'subnet_id': :'subnetId',
    'display_name': :'displayName',
    'dns_zones': :'dnsZones',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'freeform_tags': :'freeformTags',
    'system_tags': :'systemTags',
    'defined_tags': :'definedTags',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'attached_catalogs': :'attachedCatalogs',
    'locks': :'locks'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/oci/data_catalog/models/catalog_private_endpoint.rb', line 114

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'subnet_id': :'String',
    'display_name': :'String',
    'dns_zones': :'Array<String>',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'freeform_tags': :'Hash<String, String>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'attached_catalogs': :'Array<String>',
    'locks': :'Array<OCI::DataCatalog::Models::ResourceLock>'
    # 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



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/oci/data_catalog/models/catalog_private_endpoint.rb', line 258

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 &&
    dns_zones == other.dns_zones &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    freeform_tags == other.freeform_tags &&
    system_tags == other.system_tags &&
    defined_tags == other.defined_tags &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    attached_catalogs == other.attached_catalogs &&
    locks == other.locks
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



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/oci/data_catalog/models/catalog_private_endpoint.rb', line 301

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


281
282
283
 
# File 'lib/oci/data_catalog/models/catalog_private_endpoint.rb', line 281

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



290
291
292
 
# File 'lib/oci/data_catalog/models/catalog_private_endpoint.rb', line 290

def hash
  [id, compartment_id, subnet_id, display_name, dns_zones, time_created, time_updated, freeform_tags, system_tags, defined_tags, lifecycle_state, lifecycle_details, attached_catalogs, locks].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



334
335
336
337
338
339
340
341
342
343
 
# File 'lib/oci/data_catalog/models/catalog_private_endpoint.rb', line 334

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



328
329
330
 
# File 'lib/oci/data_catalog/models/catalog_private_endpoint.rb', line 328

def to_s
  to_hash.to_s
end