Class: OCI::DataSafe::Models::DataSafePrivateEndpoint

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_safe/models/data_safe_private_endpoint.rb

Overview

A Data Safe private endpoint that allows Data Safe 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_NA = 'NA'.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 = {}) ⇒ DataSafePrivateEndpoint

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

  • :display_name (String)

    The value to assign to the #display_name property

  • :compartment_id (String)

    The value to assign to the #compartment_id 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_endpoint_id (String)

    The value to assign to the #private_endpoint_id property

  • :private_endpoint_ip (String)

    The value to assign to the #private_endpoint_ip property

  • :endpoint_fqdn (String)

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



150
151
152
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
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
# File 'lib/oci/data_safe/models/data_safe_private_endpoint.rb', line 150

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

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

  self.private_endpoint_id = attributes[:'private_endpoint_id'] if attributes[:'private_endpoint_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.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']
end

Instance Attribute Details

#compartment_idString

[Required] The OCID of the compartment.

Returns:

  • (String)


32
33
34
# File 'lib/oci/data_safe/models/data_safe_private_endpoint.rb', line 32

def compartment_id
  @compartment_id
end

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

Returns:

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


84
85
86
# File 'lib/oci/data_safe/models/data_safe_private_endpoint.rb', line 84

def defined_tags
  @defined_tags
end

#descriptionString

The description of the private endpoint.

Returns:

  • (String)


57
58
59
# File 'lib/oci/data_safe/models/data_safe_private_endpoint.rb', line 57

def description
  @description
end

#display_nameString

[Required] The display name of the private endpoint.

Returns:

  • (String)


28
29
30
# File 'lib/oci/data_safe/models/data_safe_private_endpoint.rb', line 28

def display_name
  @display_name
end

#endpoint_fqdnString

The three-label fully qualified domain name (FQDN) of the private endpoint. The customer VCN's DNS records are updated with this FQDN.

Returns:

  • (String)


53
54
55
# File 'lib/oci/data_safe/models/data_safe_private_endpoint.rb', line 53

def endpoint_fqdn
  @endpoint_fqdn
end

#freeform_tagsHash<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/data_safe/models/data_safe_private_endpoint.rb', line 77

def freeform_tags
  @freeform_tags
end

#idString

[Required] The OCID of the Data Safe private endpoint.

Returns:

  • (String)


24
25
26
# File 'lib/oci/data_safe/models/data_safe_private_endpoint.rb', line 24

def id
  @id
end

#lifecycle_stateString

The current state of the private endpoint.

Returns:

  • (String)


65
66
67
# File 'lib/oci/data_safe/models/data_safe_private_endpoint.rb', line 65

def lifecycle_state
  @lifecycle_state
end

#nsg_idsArray<String>

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

Returns:

  • (Array<String>)


70
71
72
# File 'lib/oci/data_safe/models/data_safe_private_endpoint.rb', line 70

def nsg_ids
  @nsg_ids
end

#private_endpoint_idString

[Required] The OCID of the underlying private endpoint.

Returns:

  • (String)


44
45
46
# File 'lib/oci/data_safe/models/data_safe_private_endpoint.rb', line 44

def private_endpoint_id
  @private_endpoint_id
end

#private_endpoint_ipString

The private IP address of the private endpoint.

Returns:

  • (String)


49
50
51
# File 'lib/oci/data_safe/models/data_safe_private_endpoint.rb', line 49

def private_endpoint_ip
  @private_endpoint_ip
end

#subnet_idString

[Required] The OCID of the subnet.

Returns:

  • (String)


40
41
42
# File 'lib/oci/data_safe/models/data_safe_private_endpoint.rb', line 40

def subnet_id
  @subnet_id
end

#time_createdDateTime

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

Returns:

  • (DateTime)


61
62
63
# File 'lib/oci/data_safe/models/data_safe_private_endpoint.rb', line 61

def time_created
  @time_created
end

#vcn_idString

[Required] The OCID of the VCN.

Returns:

  • (String)


36
37
38
# File 'lib/oci/data_safe/models/data_safe_private_endpoint.rb', line 36

def vcn_id
  @vcn_id
end

Class Method Details

.attribute_mapObject

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



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
# File 'lib/oci/data_safe/models/data_safe_private_endpoint.rb', line 87

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'vcn_id': :'vcnId',
    'subnet_id': :'subnetId',
    'private_endpoint_id': :'privateEndpointId',
    'private_endpoint_ip': :'privateEndpointIp',
    'endpoint_fqdn': :'endpointFqdn',
    'description': :'description',
    'time_created': :'timeCreated',
    'lifecycle_state': :'lifecycleState',
    'nsg_ids': :'nsgIds',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
# File 'lib/oci/data_safe/models/data_safe_private_endpoint.rb', line 109

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'vcn_id': :'String',
    'subnet_id': :'String',
    'private_endpoint_id': :'String',
    'private_endpoint_ip': :'String',
    'endpoint_fqdn': :'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>>'
    # 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



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
# File 'lib/oci/data_safe/models/data_safe_private_endpoint.rb', line 253

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    vcn_id == other.vcn_id &&
    subnet_id == other.subnet_id &&
    private_endpoint_id == other.private_endpoint_id &&
    private_endpoint_ip == other.private_endpoint_ip &&
    endpoint_fqdn == other.endpoint_fqdn &&
    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
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



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
# File 'lib/oci/data_safe/models/data_safe_private_endpoint.rb', line 296

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


276
277
278
# File 'lib/oci/data_safe/models/data_safe_private_endpoint.rb', line 276

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



285
286
287
# File 'lib/oci/data_safe/models/data_safe_private_endpoint.rb', line 285

def hash
  [id, display_name, compartment_id, vcn_id, subnet_id, private_endpoint_id, private_endpoint_ip, endpoint_fqdn, description, time_created, lifecycle_state, nsg_ids, freeform_tags, defined_tags].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



329
330
331
332
333
334
335
336
337
338
# File 'lib/oci/data_safe/models/data_safe_private_endpoint.rb', line 329

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



323
324
325
# File 'lib/oci/data_safe/models/data_safe_private_endpoint.rb', line 323

def to_s
  to_hash.to_s
end