PutMessagesResultEntry¶
-
class
oci.streaming.models.
PutMessagesResultEntry
(**kwargs)¶ Bases:
object
Represents the result of a
put_messages()
request, whether it was successful or not. If a message was successfully appended to the stream, the entry includes the offset, partition, and timestamp. If the message failed to be appended to the stream, the entry includes the error and errorMessage.Methods
__init__
(**kwargs)Initializes a new PutMessagesResultEntry object with values from keyword arguments. Attributes
error
Gets the error of this PutMessagesResultEntry. error_message
Gets the error_message of this PutMessagesResultEntry. offset
Gets the offset of this PutMessagesResultEntry. partition
Gets the partition of this PutMessagesResultEntry. timestamp
Gets the timestamp of this PutMessagesResultEntry. -
__init__
(**kwargs)¶ Initializes a new PutMessagesResultEntry object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
Parameters: - partition (str) – The value to assign to the partition property of this PutMessagesResultEntry.
- offset (int) – The value to assign to the offset property of this PutMessagesResultEntry.
- timestamp (datetime) – The value to assign to the timestamp property of this PutMessagesResultEntry.
- error (str) – The value to assign to the error property of this PutMessagesResultEntry.
- error_message (str) – The value to assign to the error_message property of this PutMessagesResultEntry.
-
error
¶ Gets the error of this PutMessagesResultEntry. The error code, in case the message was not successfully appended to the stream.
Returns: The error of this PutMessagesResultEntry. Return type: str
-
error_message
¶ Gets the error_message of this PutMessagesResultEntry. A human-readable error message associated with the error code.
Returns: The error_message of this PutMessagesResultEntry. Return type: str
-
offset
¶ Gets the offset of this PutMessagesResultEntry. The offset of the message in the partition.
Returns: The offset of this PutMessagesResultEntry. Return type: int
-
partition
¶ Gets the partition of this PutMessagesResultEntry. The ID of the partition where the message was stored.
Returns: The partition of this PutMessagesResultEntry. Return type: str
-
timestamp
¶ Gets the timestamp of this PutMessagesResultEntry. The timestamp indicating when the server appended the message to the stream.
Returns: The timestamp of this PutMessagesResultEntry. Return type: datetime
-