Package com.oracle.bmc.queue.model

Class DeleteMessagesResult

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.queue.model.DeleteMessagesResult

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20210201")
public final class DeleteMessagesResult
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

The 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.
Note: Objects should always be created or deserialized using the DeleteMessagesResult.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the DeleteMessagesResult.Builder, which maintain a set of all explicitly set fields called DeleteMessagesResult.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DeleteMessagesResult.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
DeleteMessagesResult(Integer serverFailures, Integer clientFailures, List<DeleteMessagesResultEntry> entries)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static DeleteMessagesResult.Builder	builder()	Create a new builder.
boolean	equals(Object o)
Integer	getClientFailures()	The number of messages that failed to be deleted from the queue because of a client failure such as an invalid receipt.
List<DeleteMessagesResultEntry>	getEntries()	An array of items representing the result of each action.
Integer	getServerFailures()	The number of messages that failed to be deleted from the queue because of a server failure.
int	hashCode()
DeleteMessagesResult.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DeleteMessagesResult

@Deprecated
@ConstructorProperties({"serverFailures","clientFailures","entries"})
public DeleteMessagesResult(Integer serverFailures,
                            Integer clientFailures,
                            List<DeleteMessagesResultEntry> entries)

Deprecated.

Method Detail

builder

public static DeleteMessagesResult.Builder builder()

Create a new builder.

toBuilder

public DeleteMessagesResult.Builder toBuilder()

getServerFailures

public Integer getServerFailures()

The number of messages that failed to be deleted from the queue because of a server failure.

Returns:

the value

getClientFailures

public Integer getClientFailures()

The number of messages that failed to be deleted from the queue because of a client failure such as an invalid receipt.

Returns:

the value

getEntries

public List<DeleteMessagesResultEntry> getEntries()

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 value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel