Class: OCI::DataScience::Models::CreateDataSciencePrivateEndpointDetails

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

Overview

The details required to create a Data Science private endpoint.

Constant Summary collapse

DATA_SCIENCE_RESOURCE_TYPE_ENUM = 
[
  DATA_SCIENCE_RESOURCE_TYPE_NOTEBOOK_SESSION = 'NOTEBOOK_SESSION'.freeze,
  DATA_SCIENCE_RESOURCE_TYPE_MODEL_DEPLOYMENT = 'MODEL_DEPLOYMENT'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateDataSciencePrivateEndpointDetails

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

  • :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

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

    The value to assign to the #defined_tags property

  • :nsg_ids (Array<String>) —

    The value to assign to the #nsg_ids property

  • :subnet_id (String) —

    The value to assign to the #subnet_id property

  • :sub_domain (String) —

    The value to assign to the #sub_domain property

  • :data_science_resource_type (String) —

    The value to assign to the #data_science_resource_type property



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/oci/data_science/models/create_data_science_private_endpoint_details.rb', line 110

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

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

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

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

Instance Attribute Details

#compartment_id ⇒ String

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

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/data_science/models/create_data_science_private_endpoint_details.rb', line 19

def compartment_id
  @compartment_id
end

#data_science_resource_type ⇒ String

[Required] Data Science resource type.

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/data_science/models/create_data_science_private_endpoint_details.rb', line 59

def data_science_resource_type
  @data_science_resource_type
end

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

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


41
42
43
 
# File 'lib/oci/data_science/models/create_data_science_private_endpoint_details.rb', line 41

def defined_tags
  @defined_tags
end

#description ⇒ String

A user friendly description. Avoid entering confidential information.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/data_science/models/create_data_science_private_endpoint_details.rb', line 24

def description
  @description
end

#display_name ⇒ String

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

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/data_science/models/create_data_science_private_endpoint_details.rb', line 29

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

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


35
36
37
 
# File 'lib/oci/data_science/models/create_data_science_private_endpoint_details.rb', line 35

def freeform_tags
  @freeform_tags
end

#nsg_ids ⇒ Array<String>

An array of network security group OCIDs.

Returns:

  • (Array<String>) 


46
47
48
 
# File 'lib/oci/data_science/models/create_data_science_private_endpoint_details.rb', line 46

def nsg_ids
  @nsg_ids
end

#sub_domain ⇒ String

Subdomain for a private endpoint FQDN.

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/data_science/models/create_data_science_private_endpoint_details.rb', line 55

def sub_domain
  @sub_domain
end

#subnet_id ⇒ String

[Required] The OCID of the subnet.

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/data_science/models/create_data_science_private_endpoint_details.rb', line 51

def subnet_id
  @subnet_id
end

Class Method Details

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/oci/data_science/models/create_data_science_private_endpoint_details.rb', line 62

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'description': :'description',
    'display_name': :'displayName',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'nsg_ids': :'nsgIds',
    'subnet_id': :'subnetId',
    'sub_domain': :'subDomain',
    'data_science_resource_type': :'dataScienceResourceType'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/oci/data_science/models/create_data_science_private_endpoint_details.rb', line 79

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'description': :'String',
    'display_name': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'nsg_ids': :'Array<String>',
    'subnet_id': :'String',
    'sub_domain': :'String',
    'data_science_resource_type': :'String'
    # 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



182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/oci/data_science/models/create_data_science_private_endpoint_details.rb', line 182

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    description == other.description &&
    display_name == other.display_name &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    nsg_ids == other.nsg_ids &&
    subnet_id == other.subnet_id &&
    sub_domain == other.sub_domain &&
    data_science_resource_type == other.data_science_resource_type
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



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/oci/data_science/models/create_data_science_private_endpoint_details.rb', line 220

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


200
201
202
 
# File 'lib/oci/data_science/models/create_data_science_private_endpoint_details.rb', line 200

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



209
210
211
 
# File 'lib/oci/data_science/models/create_data_science_private_endpoint_details.rb', line 209

def hash
  [compartment_id, description, display_name, freeform_tags, defined_tags, nsg_ids, subnet_id, sub_domain, data_science_resource_type].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



253
254
255
256
257
258
259
260
261
262
 
# File 'lib/oci/data_science/models/create_data_science_private_endpoint_details.rb', line 253

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



247
248
249
 
# File 'lib/oci/data_science/models/create_data_science_private_endpoint_details.rb', line 247

def to_s
  to_hash.to_s
end