Show / Hide Table of Contents

Class CreateGroupCursorDetails

Object used to create a group cursor.

Inheritance
object
CreateGroupCursorDetails
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 CreateGroupCursorDetails

Properties

CommitOnGet

Declaration
[JsonProperty(PropertyName = "commitOnGet")]
public bool? CommitOnGet { get; set; }
Property Value
Type Description
bool?

When using consumer-groups, the default commit-on-get behaviour can be overriden by setting this value to false. If disabled, a consumer must manually commit their cursors.

GroupName

Declaration
[Required(ErrorMessage = "GroupName is required.")]
[JsonProperty(PropertyName = "groupName")]
public string GroupName { get; set; }
Property Value
Type Description
string

Name of the consumer group.

Remarks

Required

InstanceName

Declaration
[JsonProperty(PropertyName = "instanceName")]
public string InstanceName { get; set; }
Property Value
Type Description
string

A unique identifier for the instance joining the consumer group. If an instanceName is not provided, a UUID will be generated and used.

Time

Declaration
[JsonProperty(PropertyName = "time")]
public DateTime? Time { get; set; }
Property Value
Type Description
DateTime?

The time to consume from if type is AT_TIME.

TimeoutInMs

Declaration
[JsonProperty(PropertyName = "timeoutInMs")]
public int? TimeoutInMs { get; set; }
Property Value
Type Description
int?

The amount of a consumer instance inactivity time, before partition reservations are released.

Type

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

The type of the cursor. This value is only used when the group is created.

Remarks

Required

In this article
Back to top