@Generated(value="OracleSDKGenerator", comments="API Version: 20180418") public final class CreateCursorDetails extends Object
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 __explicitlySet__
. The hashCode()
and equals(Object)
methods are implemented to take __explicitlySet__
into account. The constructor, on the other hand, does not set __explicitlySet__
(since the constructor cannot distinguish explicit null
from unset null
).
Modifier and Type | Class and 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:
|
Constructor and Description |
---|
CreateCursorDetails(String partition,
CreateCursorDetails.Type type,
Long offset,
Date time)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static CreateCursorDetails.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Set<String> |
get__explicitlySet__() |
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() |
String |
toString() |
@ConstructorProperties(value={"partition","type","offset","time"}) @Deprecated public CreateCursorDetails(String partition, CreateCursorDetails.Type type, Long offset, Date time)
public static CreateCursorDetails.Builder builder()
Create a new builder.
public String getPartition()
The partition to get messages from.
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.
public Long getOffset()
The offset to consume from if the cursor type is AT_OFFSET
or AFTER_OFFSET
.
public Date getTime()
The time to consume from if the cursor type is AT_TIME
, expressed in RFC 3339 timestamp format.
Copyright © 2016–2019. All rights reserved.