Class: OCI::DataScience::Models::NotebookSessionConfigurationDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_science/models/notebook_session_configuration_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 = {}) ⇒ NotebookSessionConfigurationDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :shape (String)

    The value to assign to the #shape property

  • :block_storage_size_in_gbs (Integer)

    The value to assign to the #block_storage_size_in_gbs property

  • :subnet_id (String)

    The value to assign to the #subnet_id property



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
# File 'lib/oci/data_science/models/notebook_session_configuration_details.rb', line 56

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

Instance Attribute Details

#block_storage_size_in_gbsInteger

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

Returns:

  • (Integer)


18
19
20
# File 'lib/oci/data_science/models/notebook_session_configuration_details.rb', line 18

def block_storage_size_in_gbs
  @block_storage_size_in_gbs
end

#shapeString

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


13
14
15
# File 'lib/oci/data_science/models/notebook_session_configuration_details.rb', line 13

def shape
  @shape
end

#subnet_idString

[Required] 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)


23
24
25
# File 'lib/oci/data_science/models/notebook_session_configuration_details.rb', line 23

def subnet_id
  @subnet_id
end

Class Method Details

.attribute_mapObject

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



26
27
28
29
30
31
32
33
34
# File 'lib/oci/data_science/models/notebook_session_configuration_details.rb', line 26

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

.swagger_typesObject

Attribute type mapping.



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

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



84
85
86
87
88
89
90
91
# File 'lib/oci/data_science/models/notebook_session_configuration_details.rb', line 84

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



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# File 'lib/oci/data_science/models/notebook_session_configuration_details.rb', line 116

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


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

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



105
106
107
# File 'lib/oci/data_science/models/notebook_session_configuration_details.rb', line 105

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

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



149
150
151
152
153
154
155
156
157
158
# File 'lib/oci/data_science/models/notebook_session_configuration_details.rb', line 149

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



143
144
145
# File 'lib/oci/data_science/models/notebook_session_configuration_details.rb', line 143

def to_s
  to_hash.to_s
end