Class: OCI::GoldenGate::Models::PipelineInitializationStep

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/golden_gate/models/pipeline_initialization_step.rb

Overview

The step and its progress based on the recipe type.

Constant Summary collapse

STATUS_ENUM = 
[
  STATUS_PENDING = 'PENDING'.freeze,
  STATUS_IN_PROGRESS = 'IN_PROGRESS'.freeze,
  STATUS_COMPLETED = 'COMPLETED'.freeze,
  STATUS_FAILED = 'FAILED'.freeze,
  STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PipelineInitializationStep

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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/golden_gate/models/pipeline_initialization_step.rb', line 93

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

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

  self.percent_complete = attributes[:'percentComplete'] if attributes[:'percentComplete']

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

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

  self.time_started = attributes[:'timeStarted'] if attributes[:'timeStarted']

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

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

  self.time_finished = attributes[:'timeFinished'] if attributes[:'timeFinished']

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

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

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

Instance Attribute Details

#messages ⇒ Array<OCI::GoldenGate::Models::StepMessage>

The list of messages for each step while running.

Returns:



51
52
53
 
# File 'lib/oci/golden_gate/models/pipeline_initialization_step.rb', line 51

def messages
  @messages
end

#name ⇒ String

[Required] An object's Display Name.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/golden_gate/models/pipeline_initialization_step.rb', line 24

def name
  @name
end

#percent_complete ⇒ Integer

[Required] Shows the percentage complete of each recipe step during pipeline initialization.

Returns:

  • (Integer) 


34
35
36
 
# File 'lib/oci/golden_gate/models/pipeline_initialization_step.rb', line 34

def percent_complete
  @percent_complete
end

#status ⇒ String

[Required] Status of the steps in a recipe. This option applies during pipeline initialization.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/golden_gate/models/pipeline_initialization_step.rb', line 29

def status
  @status
end

#time_finished ⇒ DateTime

[Required] The date and time the request was finished. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

Returns:

  • (DateTime) 


46
47
48
 
# File 'lib/oci/golden_gate/models/pipeline_initialization_step.rb', line 46

def time_finished
  @time_finished
end

#time_started ⇒ DateTime

[Required] The date and time the request was started. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

Returns:

  • (DateTime) 


40
41
42
 
# File 'lib/oci/golden_gate/models/pipeline_initialization_step.rb', line 40

def time_started
  @time_started
end

Class Method Details

.attribute_map ⇒ Object

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



54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/oci/golden_gate/models/pipeline_initialization_step.rb', line 54

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'status': :'status',
    'percent_complete': :'percentComplete',
    'time_started': :'timeStarted',
    'time_finished': :'timeFinished',
    'messages': :'messages'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/oci/golden_gate/models/pipeline_initialization_step.rb', line 68

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'status': :'String',
    'percent_complete': :'Integer',
    'time_started': :'DateTime',
    'time_finished': :'DateTime',
    'messages': :'Array<OCI::GoldenGate::Models::StepMessage>'
    # 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
154
 
# File 'lib/oci/golden_gate/models/pipeline_initialization_step.rb', line 144

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

  self.class == other.class &&
    name == other.name &&
    status == other.status &&
    percent_complete == other.percent_complete &&
    time_started == other.time_started &&
    time_finished == other.time_finished &&
    messages == other.messages
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



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

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


159
160
161
 
# File 'lib/oci/golden_gate/models/pipeline_initialization_step.rb', line 159

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



168
169
170
 
# File 'lib/oci/golden_gate/models/pipeline_initialization_step.rb', line 168

def hash
  [name, status, percent_complete, time_started, time_finished, messages].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



212
213
214
215
216
217
218
219
220
221
 
# File 'lib/oci/golden_gate/models/pipeline_initialization_step.rb', line 212

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



206
207
208
 
# File 'lib/oci/golden_gate/models/pipeline_initialization_step.rb', line 206

def to_s
  to_hash.to_s
end