Class: OCI::DataScience::Models::DataSciencePrivateEndpoint

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_science/models/data_science_private_endpoint.rb

Overview

Data Science private endpoint.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
DATA_SCIENCE_RESOURCE_TYPE_ENUM = 
[
  DATA_SCIENCE_RESOURCE_TYPE_NOTEBOOK_SESSION = 'NOTEBOOK_SESSION'.freeze,
  DATA_SCIENCE_RESOURCE_TYPE_MODEL_DEPLOYMENT = 'MODEL_DEPLOYMENT'.freeze,
  DATA_SCIENCE_RESOURCE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DataSciencePrivateEndpoint

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

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

    The value to assign to the #defined_tags property

  • :description (String) —

    The value to assign to the #description property

  • :display_name (String) —

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

  • :id (String) —

    The value to assign to the #id property

  • :lifecycle_details (String) —

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

  • :created_by (String) —

    The value to assign to the #created_by property

  • :subnet_id (String) —

    The value to assign to the #subnet_id property

  • :fqdn (String) —

    The value to assign to the #fqdn property

  • :data_science_resource_type (String) —

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



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
 
# File 'lib/oci/data_science/models/data_science_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.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.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.description = attributes[:'description'] if attributes[:'description']

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

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

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

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

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

  self.data_science_resource_type = attributes[:'dataScienceResourceType'] if attributes[:'dataScienceResourceType']

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

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment where you want to create private endpoint.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/data_science/models/data_science_private_endpoint.rb', line 32

def compartment_id
  @compartment_id
end

#created_by ⇒ String

[Required] The OCID of the user that created the private endpoint.

Returns:

  • (String) 


82
83
84
 
# File 'lib/oci/data_science/models/data_science_private_endpoint.rb', line 82

def created_by
  @created_by
end

#data_science_resource_type ⇒ String

Data Science resource type.

Returns:

  • (String) 


96
97
98
 
# File 'lib/oci/data_science/models/data_science_private_endpoint.rb', line 96

def data_science_resource_type
  @data_science_resource_type
end

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

[Required] Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

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


38
39
40
 
# File 'lib/oci/data_science/models/data_science_private_endpoint.rb', line 38

def defined_tags
  @defined_tags
end

#description ⇒ String

A user friendly description. Avoid entering confidential information.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/data_science/models/data_science_private_endpoint.rb', line 43

def description
  @description
end

#display_name ⇒ String

[Required] A user friendly name. It doesn't have to be unique. Avoid entering confidential information.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/data_science/models/data_science_private_endpoint.rb', line 48

def display_name
  @display_name
end

#fqdn ⇒ String

Accesing the Data Science resource using FQDN.

Returns:

  • (String) 


92
93
94
 
# File 'lib/oci/data_science/models/data_science_private_endpoint.rb', line 92

def fqdn
  @fqdn
end

#freeform_tags ⇒ Hash<String, String>

[Required] Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


54
55
56
 
# File 'lib/oci/data_science/models/data_science_private_endpoint.rb', line 54

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of a private endpoint.

Returns:

  • (String) 


65
66
67
 
# File 'lib/oci/data_science/models/data_science_private_endpoint.rb', line 65

def id
  @id
end

#lifecycle_details ⇒ String

Details of the state of Data Science private endpoint.

Returns:

  • (String) 


69
70
71
 
# File 'lib/oci/data_science/models/data_science_private_endpoint.rb', line 69

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] State of the Data Science private endpoint.

Returns:

  • (String) 


73
74
75
 
# File 'lib/oci/data_science/models/data_science_private_endpoint.rb', line 73

def lifecycle_state
  @lifecycle_state
end

#nsg_ids ⇒ Array<String>

An array of network security group OCIDs.

Returns:

  • (Array<String>) 


78
79
80
 
# File 'lib/oci/data_science/models/data_science_private_endpoint.rb', line 78

def nsg_ids
  @nsg_ids
end

#subnet_id ⇒ String

[Required] The OCID of a subnet.

Returns:

  • (String) 


87
88
89
 
# File 'lib/oci/data_science/models/data_science_private_endpoint.rb', line 87

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


60
61
62
 
# File 'lib/oci/data_science/models/data_science_private_endpoint.rb', line 60

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The date and time that the Data Science private endpoint was created expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

Returns:

  • (DateTime) 


102
103
104
 
# File 'lib/oci/data_science/models/data_science_private_endpoint.rb', line 102

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] The date and time that the Data Science private endpoint was updated expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

Returns:

  • (DateTime) 


108
109
110
 
# File 'lib/oci/data_science/models/data_science_private_endpoint.rb', line 108

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/oci/data_science/models/data_science_private_endpoint.rb', line 111

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'defined_tags': :'definedTags',
    'description': :'description',
    'display_name': :'displayName',
    'freeform_tags': :'freeformTags',
    'system_tags': :'systemTags',
    'id': :'id',
    'lifecycle_details': :'lifecycleDetails',
    'lifecycle_state': :'lifecycleState',
    'nsg_ids': :'nsgIds',
    'created_by': :'createdBy',
    'subnet_id': :'subnetId',
    'fqdn': :'fqdn',
    'data_science_resource_type': :'dataScienceResourceType',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/oci/data_science/models/data_science_private_endpoint.rb', line 135

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'description': :'String',
    'display_name': :'String',
    'freeform_tags': :'Hash<String, String>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'id': :'String',
    'lifecycle_details': :'String',
    'lifecycle_state': :'String',
    'nsg_ids': :'Array<String>',
    'created_by': :'String',
    'subnet_id': :'String',
    'fqdn': :'String',
    'data_science_resource_type': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime'
    # 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



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/oci/data_science/models/data_science_private_endpoint.rb', line 304

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    defined_tags == other.defined_tags &&
    description == other.description &&
    display_name == other.display_name &&
    freeform_tags == other.freeform_tags &&
    system_tags == other.system_tags &&
    id == other.id &&
    lifecycle_details == other.lifecycle_details &&
    lifecycle_state == other.lifecycle_state &&
    nsg_ids == other.nsg_ids &&
    created_by == other.created_by &&
    subnet_id == other.subnet_id &&
    fqdn == other.fqdn &&
    data_science_resource_type == other.data_science_resource_type &&
    time_created == other.time_created &&
    time_updated == other.time_updated
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



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/oci/data_science/models/data_science_private_endpoint.rb', line 349

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


329
330
331
 
# File 'lib/oci/data_science/models/data_science_private_endpoint.rb', line 329

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



338
339
340
 
# File 'lib/oci/data_science/models/data_science_private_endpoint.rb', line 338

def hash
  [compartment_id, defined_tags, description, display_name, freeform_tags, system_tags, id, lifecycle_details, lifecycle_state, nsg_ids, created_by, subnet_id, fqdn, data_science_resource_type, time_created, time_updated].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



382
383
384
385
386
387
388
389
390
391
 
# File 'lib/oci/data_science/models/data_science_private_endpoint.rb', line 382

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



376
377
378
 
# File 'lib/oci/data_science/models/data_science_private_endpoint.rb', line 376

def to_s
  to_hash.to_s
end