Class: OCI::DataScience::Models::InstanceConfiguration

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

Overview

The model deployment instance configuration.

Constant Summary collapse

NETWORK_ACCESS_TYPE_ENUM = 
[
  NETWORK_ACCESS_TYPE_MANAGED_NETWORKING_NO_INTERNET_ACCESS = 'MANAGED_NETWORKING_NO_INTERNET_ACCESS'.freeze,
  NETWORK_ACCESS_TYPE_MANAGED_NETWORKING_INTERNET_ACCESS = 'MANAGED_NETWORKING_INTERNET_ACCESS'.freeze,
  NETWORK_ACCESS_TYPE_CUSTOM_NETWORKING = 'CUSTOM_NETWORKING'.freeze,
  NETWORK_ACCESS_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 = {}) ⇒ InstanceConfiguration

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



79
80
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
 
# File 'lib/oci/data_science/models/instance_configuration.rb', line 79

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

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

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

  self.model_deployment_instance_shape_config_details = attributes[:'modelDeploymentInstanceShapeConfigDetails'] if attributes[:'modelDeploymentInstanceShapeConfigDetails']

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

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

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

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

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

Instance Attribute Details

#instance_shape_name ⇒ String

[Required] The shape used to launch the model deployment instances. When using service managed open source foundation model, the supported shapes can be retrieved using get model api /models/modelId/definedMetadata/deploymentConfiguration/artifact/content.

Returns:

  • (String) 


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

def instance_shape_name
  @instance_shape_name
end

#model_deployment_instance_shape_config_details ⇒ OCI::DataScience::Models::ModelDeploymentInstanceShapeConfigDetails

Returns:



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

def model_deployment_instance_shape_config_details
  @model_deployment_instance_shape_config_details
end

#network_access_type ⇒ String

Network Access type of model deployment.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/data_science/models/instance_configuration.rb', line 40

def network_access_type
  @network_access_type
end

#private_endpoint_id ⇒ String

The OCID of a Data Science private endpoint.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/data_science/models/instance_configuration.rb', line 36

def private_endpoint_id
  @private_endpoint_id
end

#subnet_id ⇒ String

A model deployment 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/SGW gateway for egress.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/data_science/models/instance_configuration.rb', line 31

def subnet_id
  @subnet_id
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'instance_shape_name': :'instanceShapeName',
    'model_deployment_instance_shape_config_details': :'modelDeploymentInstanceShapeConfigDetails',
    'subnet_id': :'subnetId',
    'private_endpoint_id': :'privateEndpointId',
    'network_access_type': :'networkAccessType'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'instance_shape_name': :'String',
    'model_deployment_instance_shape_config_details': :'OCI::DataScience::Models::ModelDeploymentInstanceShapeConfigDetails',
    'subnet_id': :'String',
    'private_endpoint_id': :'String',
    'network_access_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



136
137
138
139
140
141
142
143
144
145
 
# File 'lib/oci/data_science/models/instance_configuration.rb', line 136

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

  self.class == other.class &&
    instance_shape_name == other.instance_shape_name &&
    model_deployment_instance_shape_config_details == other.model_deployment_instance_shape_config_details &&
    subnet_id == other.subnet_id &&
    private_endpoint_id == other.private_endpoint_id &&
    network_access_type == other.network_access_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



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/oci/data_science/models/instance_configuration.rb', line 170

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


150
151
152
 
# File 'lib/oci/data_science/models/instance_configuration.rb', line 150

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



159
160
161
 
# File 'lib/oci/data_science/models/instance_configuration.rb', line 159

def hash
  [instance_shape_name, model_deployment_instance_shape_config_details, subnet_id, private_endpoint_id, network_access_type].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



203
204
205
206
207
208
209
210
211
212
 
# File 'lib/oci/data_science/models/instance_configuration.rb', line 203

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



197
198
199
 
# File 'lib/oci/data_science/models/instance_configuration.rb', line 197

def to_s
  to_hash.to_s
end