Class: OCI::DataFlow::Models::Statement

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_flow/models/statement.rb

Overview

A statement object.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACCEPTED = 'ACCEPTED'.freeze,
  LIFECYCLE_STATE_CANCELLING = 'CANCELLING'.freeze,
  LIFECYCLE_STATE_CANCELLED = 'CANCELLED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_IN_PROGRESS = 'IN_PROGRESS'.freeze,
  LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Statement

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (Integer) —

    The value to assign to the #id property

  • :code (String) —

    The value to assign to the #code property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :output (OCI::DataFlow::Models::StatementOutput) —

    The value to assign to the #output property

  • :progress (Float) —

    The value to assign to the #progress property

  • :run_id (String) —

    The value to assign to the #run_id property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_completed (DateTime) —

    The value to assign to the #time_completed property



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/oci/data_flow/models/statement.rb', line 110

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

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

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

  self.run_id = attributes[:'runId'] if attributes[:'runId']

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  self.time_completed = attributes[:'timeCompleted'] if attributes[:'timeCompleted']

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

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

Instance Attribute Details

#code ⇒ String

[Required] The statement code to execute. Example: println(sc.version)

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/data_flow/models/statement.rb', line 32

def code
  @code
end

#id ⇒ Integer

[Required] The statement ID.

Returns:

  • (Integer) 


26
27
28
 
# File 'lib/oci/data_flow/models/statement.rb', line 26

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The current state of this statement.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/data_flow/models/statement.rb', line 37

def lifecycle_state
  @lifecycle_state
end

#output ⇒ OCI::DataFlow::Models::StatementOutput

Returns:



40
41
42
 
# File 'lib/oci/data_flow/models/statement.rb', line 40

def output
  @output
end

#progress ⇒ Float

The execution progress.

Returns:

  • (Float) 


45
46
47
 
# File 'lib/oci/data_flow/models/statement.rb', line 45

def progress
  @progress
end

#run_id ⇒ String

The ID of a run.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/data_flow/models/statement.rb', line 50

def run_id
  @run_id
end

#time_completed ⇒ DateTime

The date and time a statement execution was completed, expressed in RFC 3339 timestamp format. Example: 2022-05-31T21:10:29.600Z

Returns:

  • (DateTime) 


62
63
64
 
# File 'lib/oci/data_flow/models/statement.rb', line 62

def time_completed
  @time_completed
end

#time_created ⇒ DateTime

[Required] The date and time the resource was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

Returns:

  • (DateTime) 


56
57
58
 
# File 'lib/oci/data_flow/models/statement.rb', line 56

def time_created
  @time_created
end

Class Method Details

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/oci/data_flow/models/statement.rb', line 65

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'code': :'code',
    'lifecycle_state': :'lifecycleState',
    'output': :'output',
    'progress': :'progress',
    'run_id': :'runId',
    'time_created': :'timeCreated',
    'time_completed': :'timeCompleted'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/oci/data_flow/models/statement.rb', line 81

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'Integer',
    'code': :'String',
    'lifecycle_state': :'String',
    'output': :'OCI::DataFlow::Models::StatementOutput',
    'progress': :'Float',
    'run_id': :'String',
    'time_created': :'DateTime',
    'time_completed': :'DateTime'
    # 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



169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/oci/data_flow/models/statement.rb', line 169

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

  self.class == other.class &&
    id == other.id &&
    code == other.code &&
    lifecycle_state == other.lifecycle_state &&
    output == other.output &&
    progress == other.progress &&
    run_id == other.run_id &&
    time_created == other.time_created &&
    time_completed == other.time_completed
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



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/oci/data_flow/models/statement.rb', line 206

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


186
187
188
 
# File 'lib/oci/data_flow/models/statement.rb', line 186

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



195
196
197
 
# File 'lib/oci/data_flow/models/statement.rb', line 195

def hash
  [id, code, lifecycle_state, output, progress, run_id, time_created, time_completed].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



239
240
241
242
243
244
245
246
247
248
 
# File 'lib/oci/data_flow/models/statement.rb', line 239

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



233
234
235
 
# File 'lib/oci/data_flow/models/statement.rb', line 233

def to_s
  to_hash.to_s
end