Class CreateCursorDetails

Object used to create a cursor to consume messages in a stream.

Inheritance

object

CreateCursorDetails

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.StreamingService.Models

Assembly: OCI.DotNetSDK.Streaming.dll

Syntax

public class CreateCursorDetails

Properties

Offset

Declaration

[JsonProperty(PropertyName = "offset")]
public long? Offset { get; set; }

Property Value

Type	Description
long?	The offset to consume from if the cursor type is AT_OFFSET or AFTER_OFFSET.

Partition

Declaration

[Required(ErrorMessage = "Partition is required.")]
[JsonProperty(PropertyName = "partition")]
public string Partition { get; set; }

Property Value

Type	Description
string	The partition to get messages from.

Remarks

Required

Time

Declaration

[JsonProperty(PropertyName = "time")]
public DateTime? Time { get; set; }

Property Value

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

Type

Declaration

[Required(ErrorMessage = "Type is required.")]
[JsonProperty(PropertyName = "type")]
[JsonConverter(typeof(StringEnumConverter))]
public CreateCursorDetails.TypeEnum? Type { get; set; }

Property Value

Type

Description

CreateCursorDetails.TypeEnum?

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.

Remarks

Required