Message

class oci.streaming.models.Message(**kwargs)

Bases: object

A message in a stream.

Methods:

__init__(**kwargs)

Initializes a new Message object with values from keyword arguments.

Attributes:

key

[Required] Gets the key of this Message.

offset

[Required] Gets the offset of this Message.

partition

[Required] Gets the partition of this Message.

stream

[Required] Gets the stream of this Message.

timestamp

[Required] Gets the timestamp of this Message.

value

[Required] Gets the value of this Message.

__init__(**kwargs)

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

Parameters
  • stream (str) – The value to assign to the stream property of this Message.

  • partition (str) – The value to assign to the partition property of this Message.

  • key (str) – The value to assign to the key property of this Message.

  • value (str) – The value to assign to the value property of this Message.

  • offset (int) – The value to assign to the offset property of this Message.

  • timestamp (datetime) – The value to assign to the timestamp property of this Message.

property key

[Required] Gets the key of this Message. The key associated with the message, expressed as a byte array.

Returns

The key of this Message.

Return type

str

property offset

[Required] Gets the offset of this Message. The offset of the message, which uniquely identifies it within the partition.

Returns

The offset of this Message.

Return type

int

property partition

[Required] Gets the partition of this Message. The ID of the partition where the message is stored.

Returns

The partition of this Message.

Return type

str

property stream

[Required] Gets the stream of this Message. The name of the stream that the message belongs to.

Returns

The stream of this Message.

Return type

str

property timestamp

[Required] Gets the timestamp of this Message. The timestamp indicating when the server appended the message to the stream.

Returns

The timestamp of this Message.

Return type

datetime

property value

[Required] Gets the value of this Message. The value associated with the message, expressed as a byte array.

Returns

The value of this Message.

Return type

str