Class: OCI::DataScience::Models::PipelineMLJobStepDetails

Inherits:
PipelineStepDetails show all
Defined in:
lib/oci/data_science/models/pipeline_ml_job_step_details.rb

Overview

The type of step where the job is pre-created by the user.

Constant Summary

Constants inherited from PipelineStepDetails

OCI::DataScience::Models::PipelineStepDetails::STEP_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from PipelineStepDetails

#depends_on, #description, #step_configuration_details, #step_name, #step_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from PipelineStepDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ PipelineMLJobStepDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['stepType'] = 'ML_JOB'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.job_id = attributes[:'jobId'] if attributes[:'jobId']

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

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

Instance Attribute Details

#job_id ⇒ String

[Required] The OCID of the job to be used as a step.

Returns:

  • (String) 


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

def job_id
  @job_id
end

Class Method Details

.attribute_map ⇒ Object

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



17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/oci/data_science/models/pipeline_ml_job_step_details.rb', line 17

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'step_type': :'stepType',
    'step_name': :'stepName',
    'description': :'description',
    'depends_on': :'dependsOn',
    'step_configuration_details': :'stepConfigurationDetails',
    'job_id': :'jobId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/oci/data_science/models/pipeline_ml_job_step_details.rb', line 31

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'step_type': :'String',
    'step_name': :'String',
    'description': :'String',
    'depends_on': :'Array<String>',
    'step_configuration_details': :'OCI::DataScience::Models::PipelineStepConfigurationDetails',
    'job_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



79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/oci/data_science/models/pipeline_ml_job_step_details.rb', line 79

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

  self.class == other.class &&
    step_type == other.step_type &&
    step_name == other.step_name &&
    description == other.description &&
    depends_on == other.depends_on &&
    step_configuration_details == other.step_configuration_details &&
    job_id == other.job_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



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

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


94
95
96
 
# File 'lib/oci/data_science/models/pipeline_ml_job_step_details.rb', line 94

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



103
104
105
 
# File 'lib/oci/data_science/models/pipeline_ml_job_step_details.rb', line 103

def hash
  [step_type, step_name, description, depends_on, step_configuration_details, job_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



147
148
149
150
151
152
153
154
155
156
 
# File 'lib/oci/data_science/models/pipeline_ml_job_step_details.rb', line 147

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



141
142
143
 
# File 'lib/oci/data_science/models/pipeline_ml_job_step_details.rb', line 141

def to_s
  to_hash.to_s
end