CreateGroupCursorDetails¶

class oci.streaming.models.CreateGroupCursorDetails(**kwargs)¶

Bases: object

Object used to create a group cursor.

Attributes

`TYPE_AT_TIME`	A constant which can be used with the type property of a CreateGroupCursorDetails.
`TYPE_LATEST`	A constant which can be used with the type property of a CreateGroupCursorDetails.
`TYPE_TRIM_HORIZON`	A constant which can be used with the type property of a CreateGroupCursorDetails.
`commit_on_get`	Gets the commit_on_get of this CreateGroupCursorDetails.
`group_name`	[Required] Gets the group_name of this CreateGroupCursorDetails.
`instance_name`	Gets the instance_name of this CreateGroupCursorDetails.
`time`	Gets the time of this CreateGroupCursorDetails.
`timeout_in_ms`	Gets the timeout_in_ms of this CreateGroupCursorDetails.
`type`	[Required] Gets the type of this CreateGroupCursorDetails.

Methods

__init__(**kwargs) Initializes a new CreateGroupCursorDetails object with values from keyword arguments.

TYPE_AT_TIME = 'AT_TIME'¶: A constant which can be used with the type property of a CreateGroupCursorDetails. This constant has a value of “AT_TIME”

TYPE_LATEST = 'LATEST'¶: A constant which can be used with the type property of a CreateGroupCursorDetails. This constant has a value of “LATEST”

TYPE_TRIM_HORIZON = 'TRIM_HORIZON'¶: A constant which can be used with the type property of a CreateGroupCursorDetails. This constant has a value of “TRIM_HORIZON”

__init__(**kwargs)¶

Initializes a new CreateGroupCursorDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

type (str) – The value to assign to the type property of this CreateGroupCursorDetails. Allowed values for this property are: “AT_TIME”, “LATEST”, “TRIM_HORIZON”
time (datetime) – The value to assign to the time property of this CreateGroupCursorDetails.
group_name (str) – The value to assign to the group_name property of this CreateGroupCursorDetails.
instance_name (str) – The value to assign to the instance_name property of this CreateGroupCursorDetails.
timeout_in_ms (int) – The value to assign to the timeout_in_ms property of this CreateGroupCursorDetails.
commit_on_get (bool) – The value to assign to the commit_on_get property of this CreateGroupCursorDetails.

commit_on_get¶

Gets the commit_on_get of this CreateGroupCursorDetails. 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.

Returns:	The commit_on_get of this CreateGroupCursorDetails.
Return type:	bool

group_name¶

[Required] Gets the group_name of this CreateGroupCursorDetails. Name of the consumer group.

Returns:	The group_name of this CreateGroupCursorDetails.
Return type:	str

instance_name¶

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

Returns:	The instance_name of this CreateGroupCursorDetails.
Return type:	str

time¶

Gets the time of this CreateGroupCursorDetails. The time to consume from if type is AT_TIME.

Returns:	The time of this CreateGroupCursorDetails.
Return type:	datetime

timeout_in_ms¶

Gets the timeout_in_ms of this CreateGroupCursorDetails. The amount of a consumer instance inactivity time, before partition reservations are released.

Returns:	The timeout_in_ms of this CreateGroupCursorDetails.
Return type:	int

type¶

[Required] Gets the type of this CreateGroupCursorDetails. The type of the cursor. This value is only used when the group is created.

Allowed values for this property are: “AT_TIME”, “LATEST”, “TRIM_HORIZON”

Returns:	The type of this CreateGroupCursorDetails.
Return type:	str