Class: OCI::GoldenGate::Models::StepMessage

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

Overview

Contents of a step message.

Constant Summary collapse

SEVERITY_ENUM = 
[
  SEVERITY_INFO = 'INFO'.freeze,
  SEVERITY_ERROR = 'ERROR'.freeze,
  SEVERITY_WARNING = 'WARNING'.freeze,
  SEVERITY_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ StepMessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :message (String) —

    The value to assign to the #message property

  • :code (String) —

    The value to assign to the #code property

  • :timestamp (DateTime) —

    The value to assign to the #timestamp property

  • :severity (String) —

    The value to assign to the #severity property



78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/oci/golden_gate/models/step_message.rb', line 78

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

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

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

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

Instance Attribute Details

#code ⇒ String

[Required] The code returned when GoldenGate reports an error while running a step during pipeline initialization. docs.oracle.com/en/middleware/goldengate/core/23/error-messages/ogg-00001-ogg-40000.html#GUID-97FF7AA7-7A5C-4AA7-B29F-3CC8D26761F2

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/golden_gate/models/step_message.rb', line 30

def code
  @code
end

#message ⇒ String

[Required] The status message of the steps in a recipe during pipeline initialization. docs.oracle.com/en/middleware/goldengate/core/23/oggra/rest-endpoints.html

Returns:

  • (String) 


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

def message
  @message
end

#severity ⇒ String

[Required] The severity returned when calling GoldenGate API messages for a step in a recipe during pipeline initialization. docs.oracle.com/en/middleware/goldengate/core/23/oggra/rest-endpoints.html

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/golden_gate/models/step_message.rb', line 42

def severity
  @severity
end

#timestamp ⇒ DateTime

[Required] Date and time of a message issued by steps in a recipe during pipeline initialization. The format is defined by RFC3339, such as 2024-07-25T21:10:29.600Z.

Returns:

  • (DateTime) 


36
37
38
 
# File 'lib/oci/golden_gate/models/step_message.rb', line 36

def timestamp
  @timestamp
end

Class Method Details

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
 
# File 'lib/oci/golden_gate/models/step_message.rb', line 45

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'message': :'message',
    'code': :'code',
    'timestamp': :'timestamp',
    'severity': :'severity'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'message': :'String',
    'code': :'String',
    'timestamp': :'DateTime',
    'severity': :'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



113
114
115
116
117
118
119
120
121
 
# File 'lib/oci/golden_gate/models/step_message.rb', line 113

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

  self.class == other.class &&
    message == other.message &&
    code == other.code &&
    timestamp == other.timestamp &&
    severity == other.severity
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



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/oci/golden_gate/models/step_message.rb', line 146

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


126
127
128
 
# File 'lib/oci/golden_gate/models/step_message.rb', line 126

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



135
136
137
 
# File 'lib/oci/golden_gate/models/step_message.rb', line 135

def hash
  [message, code, timestamp, severity].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



179
180
181
182
183
184
185
186
187
188
 
# File 'lib/oci/golden_gate/models/step_message.rb', line 179

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



173
174
175
 
# File 'lib/oci/golden_gate/models/step_message.rb', line 173

def to_s
  to_hash.to_s
end