Class: OCI::DataScience::Models::PipelineStepDetails

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

Overview

A step in the pipeline. This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Constant Summary collapse

STEP_TYPE_ENUM = 
[
  STEP_TYPE_ML_JOB = 'ML_JOB'.freeze,
  STEP_TYPE_CUSTOM_SCRIPT = 'CUSTOM_SCRIPT'.freeze,
  STEP_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 = {}) ⇒ PipelineStepDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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/pipeline_step_details.rb', line 91

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

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

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

  self.step_name = attributes[:'stepName'] if attributes[:'stepName']

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

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

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

  self.depends_on = attributes[:'dependsOn'] if attributes[:'dependsOn']

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

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

  self.step_configuration_details = attributes[:'stepConfigurationDetails'] if attributes[:'stepConfigurationDetails']

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

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

Instance Attribute Details

#depends_on ⇒ Array<String>

The list of step names this current step depends on for execution.

Returns:

  • (Array<String>) 


33
34
35
 
# File 'lib/oci/data_science/models/pipeline_step_details.rb', line 33

def depends_on
  @depends_on
end

#description ⇒ String

A short description of the step.

Returns:

  • (String) 


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

def description
  @description
end

#step_configuration_details ⇒ OCI::DataScience::Models::PipelineStepConfigurationDetails

Returns:



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

def step_configuration_details
  @step_configuration_details
end

#step_name ⇒ String

[Required] The name of the step. It must be unique within the pipeline. This is used to create the pipeline DAG.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/data_science/models/pipeline_step_details.rb', line 25

def step_name
  @step_name
end

#step_type ⇒ String

[Required] The type of step.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/data_science/models/pipeline_step_details.rb', line 21

def step_type
  @step_type
end

Class Method Details

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/oci/data_science/models/pipeline_step_details.rb', line 39

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

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



69
70
71
72
73
74
75
76
77
 
# File 'lib/oci/data_science/models/pipeline_step_details.rb', line 69

def self.get_subtype(object_hash)
  type = object_hash[:'stepType'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::DataScience::Models::PipelineMLJobStepDetails' if type == 'ML_JOB'
  return 'OCI::DataScience::Models::PipelineCustomScriptStepDetails' if type == 'CUSTOM_SCRIPT'

  # TODO: Log a warning when the subtype is not found.
  'OCI::DataScience::Models::PipelineStepDetails'
end

.swagger_types ⇒ Object

Attribute type mapping.



52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/oci/data_science/models/pipeline_step_details.rb', line 52

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



144
145
146
147
148
149
150
151
152
153
 
# File 'lib/oci/data_science/models/pipeline_step_details.rb', line 144

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



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/oci/data_science/models/pipeline_step_details.rb', line 178

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


158
159
160
 
# File 'lib/oci/data_science/models/pipeline_step_details.rb', line 158

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



167
168
169
 
# File 'lib/oci/data_science/models/pipeline_step_details.rb', line 167

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



211
212
213
214
215
216
217
218
219
220
 
# File 'lib/oci/data_science/models/pipeline_step_details.rb', line 211

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



205
206
207
 
# File 'lib/oci/data_science/models/pipeline_step_details.rb', line 205

def to_s
  to_hash.to_s
end