Package com.oracle.bmc.streaming.model

Class CreateCursorDetails

java.lang.Object

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

com.oracle.bmc.streaming.model.CreateCursorDetails

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

Object used to create a cursor to consume messages in a stream.
Note: Objects should always be created or deserialized using the CreateCursorDetails.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 CreateCursorDetails.Builder, which maintain a set of all explicitly set fields called CreateCursorDetails.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	CreateCursorDetails.Builder
static class	CreateCursorDetails.Type	The type of cursor, which determines the starting point from which the stream will be consumed:

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
CreateCursorDetails(String partition, CreateCursorDetails.Type type, Long offset, Date time)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static CreateCursorDetails.Builder	builder()	Create a new builder.
boolean	equals(Object o)
Long	getOffset()	The offset to consume from if the cursor type is AT_OFFSET or AFTER_OFFSET.
String	getPartition()	The partition to get messages from.
Date	getTime()	The time to consume from if the cursor type is AT_TIME, expressed in RFC 3339 timestamp format.
CreateCursorDetails.Type	getType()	The type of cursor, which determines the starting point from which the stream will be consumed:
int	hashCode()
CreateCursorDetails.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

CreateCursorDetails

@Deprecated
@ConstructorProperties({"partition","type","offset","time"})
public CreateCursorDetails(String partition,
                           CreateCursorDetails.Type type,
                           Long offset,
                           Date time)

Deprecated.

Method Detail

builder

public static CreateCursorDetails.Builder builder()

Create a new builder.

toBuilder

public CreateCursorDetails.Builder toBuilder()

getPartition

public String getPartition()

The partition to get messages from.

Returns:

the value

getType

public CreateCursorDetails.Type getType()

The type of cursor, which determines the starting point from which the stream will be consumed:

- AFTER_OFFSET: The partition position immediately following the offset you specify. (Offsets are assigned when you successfully append a message to a partition in a stream.) - AT_OFFSET: The exact partition position indicated by the offset you specify. - AT_TIME: A specific point in time. - LATEST: The most recent message in the partition that was added after the cursor was created. - TRIM_HORIZON: The oldest message in the partition that is within the retention period window.

Returns:

the value

getOffset

public Long getOffset()

The offset to consume from if the cursor type is AT_OFFSET or AFTER_OFFSET.

Returns:

the value

getTime

public Date getTime()

The time to consume from if the cursor type is AT_TIME, expressed in RFC 3339 timestamp format.

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