Class: OCI::DataScience::Models::NotebookSessionConfigDetails

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

Overview

Details for the notebook session configuration.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NotebookSessionConfigDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/oci/data_science/models/notebook_session_config_details.rb', line 71

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

  self.block_storage_size_in_gbs = attributes[:'blockStorageSizeInGBs'] if attributes[:'blockStorageSizeInGBs']

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

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

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

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

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

Instance Attribute Details

#block_storage_size_in_gbs ⇒ Integer

A notebook session instance is provided with a block storage volume. This specifies the size of the volume in GBs.

Returns:

  • (Integer) 


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

def block_storage_size_in_gbs
  @block_storage_size_in_gbs
end

#notebook_session_shape_config_details ⇒ OCI::DataScience::Models::NotebookSessionShapeConfigDetails

Returns:



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

def notebook_session_shape_config_details
  @notebook_session_shape_config_details
end

#private_endpoint_id ⇒ String

The OCID of a Data Science private endpoint.

Returns:

  • (String) 


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

def private_endpoint_id
  @private_endpoint_id
end

#shape ⇒ String

[Required] The shape used to launch the notebook session compute instance. The list of available shapes in a given compartment can be retrieved using the ListNotebookSessionShapes endpoint.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/data_science/models/notebook_session_config_details.rb', line 14

def shape
  @shape
end

#subnet_id ⇒ String

A notebook session instance is provided with a VNIC for network access. This specifies the OCID of the subnet to create a VNIC in. The subnet should be in a VCN with a NAT gateway for egress to the internet.

Returns:

  • (String) 


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

def subnet_id
  @subnet_id
end

Class Method Details

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/oci/data_science/models/notebook_session_config_details.rb', line 35

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'shape': :'shape',
    'block_storage_size_in_gbs': :'blockStorageSizeInGBs',
    'subnet_id': :'subnetId',
    'private_endpoint_id': :'privateEndpointId',
    'notebook_session_shape_config_details': :'notebookSessionShapeConfigDetails'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/oci/data_science/models/notebook_session_config_details.rb', line 48

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'shape': :'String',
    'block_storage_size_in_gbs': :'Integer',
    'subnet_id': :'String',
    'private_endpoint_id': :'String',
    'notebook_session_shape_config_details': :'OCI::DataScience::Models::NotebookSessionShapeConfigDetails'
    # 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



111
112
113
114
115
116
117
118
119
120
 
# File 'lib/oci/data_science/models/notebook_session_config_details.rb', line 111

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

  self.class == other.class &&
    shape == other.shape &&
    block_storage_size_in_gbs == other.block_storage_size_in_gbs &&
    subnet_id == other.subnet_id &&
    private_endpoint_id == other.private_endpoint_id &&
    notebook_session_shape_config_details == other.notebook_session_shape_config_details
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



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/oci/data_science/models/notebook_session_config_details.rb', line 145

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


125
126
127
 
# File 'lib/oci/data_science/models/notebook_session_config_details.rb', line 125

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



134
135
136
 
# File 'lib/oci/data_science/models/notebook_session_config_details.rb', line 134

def hash
  [shape, block_storage_size_in_gbs, subnet_id, private_endpoint_id, notebook_session_shape_config_details].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



178
179
180
181
182
183
184
185
186
187
 
# File 'lib/oci/data_science/models/notebook_session_config_details.rb', line 178

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



172
173
174
 
# File 'lib/oci/data_science/models/notebook_session_config_details.rb', line 172

def to_s
  to_hash.to_s
end