com.oracle.bmc.goldengate.model

Class StepMessage

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.goldengate.model.StepMessage

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200407")
public final class StepMessage
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Contents of a step message.
Note: Objects should always be created or deserialized using the StepMessage.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the StepMessage.Builder, which maintain a set of all explicitly set fields called StepMessage.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StepMessage.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor and Description
StepMessage(String message, String code, Date timestamp, SeverityType severity) Deprecated.

Method Summary

Modifier and Type	Method and Description
static StepMessage.Builder	builder() Create a new builder.
boolean	equals(Object o)
String	getCode() The code returned when GoldenGate reports an error while running a step during pipeline initialization.
String	getMessage() The status message of the steps in a recipe during pipeline initialization.
SeverityType	getSeverity() The severity returned when calling GoldenGate API messages for a step in a recipe during pipeline initialization.
Date	getTimestamp() Date and time of a message issued by steps in a recipe during pipeline initialization.
int	hashCode()
StepMessage.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents) Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StepMessage

@Deprecated
 @ConstructorProperties(value={"message","code","timestamp","severity"})
public StepMessage(String message,
                                                                                                        String code,
                                                                                                        Date timestamp,
                                                                                                        SeverityType severity)

Deprecated.

Method Detail

builder

public static StepMessage.Builder builder()

Create a new builder.

toBuilder

public StepMessage.Builder toBuilder()

getMessage

public String getMessage()

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 value

getCode

public String getCode()

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 value

getTimestamp

public Date getTimestamp()

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:

the value

getSeverity

public SeverityType getSeverity()

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

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel