DeleteMessagesResult¶
-
class
oci.queue.models.DeleteMessagesResult(**kwargs)¶ Bases:
objectThe response to a DeleteMessages request. It indicates the number of server and client failures as well as an array of entries for successful and failed actions.
Methods
__init__(**kwargs)Initializes a new DeleteMessagesResult object with values from keyword arguments. Attributes
client_failures[Required] Gets the client_failures of this DeleteMessagesResult. entries[Required] Gets the entries of this DeleteMessagesResult. server_failures[Required] Gets the server_failures of this DeleteMessagesResult. -
__init__(**kwargs)¶ Initializes a new DeleteMessagesResult object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
Parameters: - server_failures (int) – The value to assign to the server_failures property of this DeleteMessagesResult.
- client_failures (int) – The value to assign to the client_failures property of this DeleteMessagesResult.
- entries (list[oci.queue.models.DeleteMessagesResultEntry]) – The value to assign to the entries property of this DeleteMessagesResult.
-
client_failures¶ [Required] Gets the client_failures of this DeleteMessagesResult. The number of messages that failed to be deleted from the queue because of a client failure such as an invalid receipt.
Returns: The client_failures of this DeleteMessagesResult. Return type: int
-
entries¶ [Required] Gets the entries of this DeleteMessagesResult. An array of items representing the result of each action. The order is guaranteed to be the same as in the DeleteMessagesDetails object. If a message was successfully deleted from the queue, the entry does not contain any fields. If a message failed to be deleted from the queue, the entry includes the errorCode and errorMessage fields.
Returns: The entries of this DeleteMessagesResult. Return type: list[oci.queue.models.DeleteMessagesResultEntry]
-
server_failures¶ [Required] Gets the server_failures of this DeleteMessagesResult. The number of messages that failed to be deleted from the queue because of a server failure.
Returns: The server_failures of this DeleteMessagesResult. Return type: int
-