Package com.oracle.bmc.streaming.model

Class PutMessagesResultEntry

java.lang.Object

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

com.oracle.bmc.streaming.model.PutMessagesResultEntry

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

Represents the result of a putMessages request, whether it was successful or not.

If a message was successfully appended to the stream, the entry includes the offset, partition, and timestamp. If the message failed to be appended to the stream, the entry includes the error and errorMessage.
Note: Objects should always be created or deserialized using the PutMessagesResultEntry.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 PutMessagesResultEntry.Builder, which maintain a set of all explicitly set fields called PutMessagesResultEntry.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	Description
static class	PutMessagesResultEntry.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	Description
PutMessagesResultEntry(String partition, Long offset, Date timestamp, String error, String errorMessage)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static PutMessagesResultEntry.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getError()	The error code, in case the message was not successfully appended to the stream.
String	getErrorMessage()	A human-readable error message associated with the error code.
Long	getOffset()	The offset of the message in the partition.
String	getPartition()	The ID of the partition where the message was stored.
Date	getTimestamp()	The timestamp indicating when the server appended the message to the stream.
int	hashCode()
PutMessagesResultEntry.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

PutMessagesResultEntry

@Deprecated
@ConstructorProperties({"partition","offset","timestamp","error","errorMessage"})
public PutMessagesResultEntry(String partition,
                              Long offset,
                              Date timestamp,
                              String error,
                              String errorMessage)

Deprecated.

Method Detail

builder

public static PutMessagesResultEntry.Builder builder()

Create a new builder.

toBuilder

public PutMessagesResultEntry.Builder toBuilder()

getPartition

public String getPartition()

The ID of the partition where the message was stored.

Returns:

the value

getOffset

public Long getOffset()

The offset of the message in the partition.

Returns:

the value

getTimestamp

public Date getTimestamp()

The timestamp indicating when the server appended the message to the stream.

Returns:

the value

getError

public String getError()

The error code, in case the message was not successfully appended to the stream.

Returns:

the value

getErrorMessage

public String getErrorMessage()

A human-readable error message associated with the error code.

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