StepMessage¶
- class oci.golden_gate.models.StepMessage(**kwargs)¶
Bases:
objectContents of a step message.
Attributes:
A constant which can be used with the severity property of a StepMessage.
A constant which can be used with the severity property of a StepMessage.
A constant which can be used with the severity property of a StepMessage.
[Required] Gets the code of this StepMessage.
[Required] Gets the message of this StepMessage.
[Required] Gets the severity of this StepMessage.
[Required] Gets the timestamp of this StepMessage.
Methods:
__init__(**kwargs)Initializes a new StepMessage object with values from keyword arguments.
- SEVERITY_ERROR = 'ERROR'¶
A constant which can be used with the severity property of a StepMessage. This constant has a value of “ERROR”
- SEVERITY_INFO = 'INFO'¶
A constant which can be used with the severity property of a StepMessage. This constant has a value of “INFO”
- SEVERITY_WARNING = 'WARNING'¶
A constant which can be used with the severity property of a StepMessage. This constant has a value of “WARNING”
- __init__(**kwargs)¶
Initializes a new StepMessage object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
message (str) – The value to assign to the message property of this StepMessage.
code (str) – The value to assign to the code property of this StepMessage.
timestamp (datetime) – The value to assign to the timestamp property of this StepMessage.
severity (str) – The value to assign to the severity property of this StepMessage. Allowed values for this property are: “INFO”, “ERROR”, “WARNING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- property code¶
[Required] Gets the code of this StepMessage. The code returned when GoldenGate reports an error while running a step during pipeline initialization. https://docs.oracle.com/en/middleware/goldengate/core/23/error-messages/ogg-00001-ogg-40000.html#GUID-97FF7AA7-7A5C-4AA7-B29F-3CC8D26761F2
- Returns
The code of this StepMessage.
- Return type
str
- property message¶
[Required] Gets the message of this StepMessage. The status message of the steps in a recipe during pipeline initialization. https://docs.oracle.com/en/middleware/goldengate/core/23/oggra/rest-endpoints.html
- Returns
The message of this StepMessage.
- Return type
str
- property severity¶
[Required] Gets the severity of this StepMessage. The severity returned when calling GoldenGate API messages for a step in a recipe during pipeline initialization. https://docs.oracle.com/en/middleware/goldengate/core/23/oggra/rest-endpoints.html
Allowed values for this property are: “INFO”, “ERROR”, “WARNING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The severity of this StepMessage.
- Return type
str