Class: OCI::DataScience::Models::UpdateNotebookSessionDetails

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

Overview

Details for updating a notebook session. notebookSessionConfigurationDetails can only be updated while the notebook session is in the INACTIVE state. Changes to the notebookSessionConfigurationDetails take effect the next time the ActivateNotebookSession action is invoked on the notebook session resource.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateNotebookSessionDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/oci/data_science/models/update_notebook_session_details.rb', line 81

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

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

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

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

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

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

  self.notebook_session_storage_mount_configuration_details_list = attributes[:'notebookSessionStorageMountConfigurationDetailsList'] if attributes[:'notebookSessionStorageMountConfigurationDetailsList']

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

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

Instance Attribute Details

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


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

def defined_tags
  @defined_tags
end

#display_name ⇒ String

A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information. Example: My NotebookSession

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/data_science/models/update_notebook_session_details.rb', line 17

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


26
27
28
 
# File 'lib/oci/data_science/models/update_notebook_session_details.rb', line 26

def freeform_tags
  @freeform_tags
end

#notebook_session_configuration_details ⇒ OCI::DataScience::Models::NotebookSessionConfigurationDetails

Returns:



20
21
22
 
# File 'lib/oci/data_science/models/update_notebook_session_details.rb', line 20

def notebook_session_configuration_details
  @notebook_session_configuration_details
end

#notebook_session_runtime_config_details ⇒ OCI::DataScience::Models::NotebookSessionRuntimeConfigDetails

Returns:



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

def notebook_session_runtime_config_details
  @notebook_session_runtime_config_details
end

#notebook_session_storage_mount_configuration_details_list ⇒ Array<OCI::DataScience::Models::StorageMountConfigurationDetails>

Collection of NotebookSessionStorageMountConfigurationDetails.

Returns:



39
40
41
 
# File 'lib/oci/data_science/models/update_notebook_session_details.rb', line 39

def notebook_session_storage_mount_configuration_details_list
  @notebook_session_storage_mount_configuration_details_list
end

Class Method Details

.attribute_map ⇒ Object

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



42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/oci/data_science/models/update_notebook_session_details.rb', line 42

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'notebook_session_configuration_details': :'notebookSessionConfigurationDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'notebook_session_runtime_config_details': :'notebookSessionRuntimeConfigDetails',
    'notebook_session_storage_mount_configuration_details_list': :'notebookSessionStorageMountConfigurationDetailsList'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/oci/data_science/models/update_notebook_session_details.rb', line 56

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'notebook_session_configuration_details': :'OCI::DataScience::Models::NotebookSessionConfigurationDetails',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'notebook_session_runtime_config_details': :'OCI::DataScience::Models::NotebookSessionRuntimeConfigDetails',
    'notebook_session_storage_mount_configuration_details_list': :'Array<OCI::DataScience::Models::StorageMountConfigurationDetails>'
    # 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



131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/oci/data_science/models/update_notebook_session_details.rb', line 131

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

  self.class == other.class &&
    display_name == other.display_name &&
    notebook_session_configuration_details == other.notebook_session_configuration_details &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    notebook_session_runtime_config_details == other.notebook_session_runtime_config_details &&
    notebook_session_storage_mount_configuration_details_list == other.notebook_session_storage_mount_configuration_details_list
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



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/oci/data_science/models/update_notebook_session_details.rb', line 166

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


146
147
148
 
# File 'lib/oci/data_science/models/update_notebook_session_details.rb', line 146

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



155
156
157
 
# File 'lib/oci/data_science/models/update_notebook_session_details.rb', line 155

def hash
  [display_name, notebook_session_configuration_details, freeform_tags, defined_tags, notebook_session_runtime_config_details, notebook_session_storage_mount_configuration_details_list].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



199
200
201
202
203
204
205
206
207
208
 
# File 'lib/oci/data_science/models/update_notebook_session_details.rb', line 199

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



193
194
195
 
# File 'lib/oci/data_science/models/update_notebook_session_details.rb', line 193

def to_s
  to_hash.to_s
end