com.oracle.bmc.queue.model

Class PurgeQueueDetails

java.lang.Object

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

com.oracle.bmc.queue.model.PurgeQueueDetails

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

Purge parameters.
Note: Objects should always be created or deserialized using the PurgeQueueDetails.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 PurgeQueueDetails.Builder, which maintain a set of all explicitly set fields called PurgeQueueDetails.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 and Description
static class	PurgeQueueDetails.Builder
static class	PurgeQueueDetails.PurgeType Type of the purge to perform: - NORMAL - purge only the normal queue - DLQ - purge only the dead letter queue - BOTH - purge both the normal queue and the dead letter queue

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 and Description
PurgeQueueDetails(PurgeQueueDetails.PurgeType purgeType, List<String> channelIds) Deprecated.

Method Summary

Modifier and Type	Method and Description
static PurgeQueueDetails.Builder	builder() Create a new builder.
boolean	equals(Object o)
List<String>	getChannelIds() Optional parameter to specify the destination of purge operation.
PurgeQueueDetails.PurgeType	getPurgeType() Type of the purge to perform: - NORMAL - purge only the normal queue - DLQ - purge only the dead letter queue - BOTH - purge both the normal queue and the dead letter queue
int	hashCode()
PurgeQueueDetails.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

PurgeQueueDetails

@Deprecated
 @ConstructorProperties(value={"purgeType","channelIds"})
public PurgeQueueDetails(PurgeQueueDetails.PurgeType purgeType,
                                                                                               List<String> channelIds)

Deprecated.

Method Detail

builder

public static PurgeQueueDetails.Builder builder()

Create a new builder.

toBuilder

public PurgeQueueDetails.Builder toBuilder()

getPurgeType

public PurgeQueueDetails.PurgeType getPurgeType()

Type of the purge to perform: - NORMAL - purge only the normal queue - DLQ - purge only the dead letter queue - BOTH - purge both the normal queue and the dead letter queue

Returns:

the value

getChannelIds

public List<String> getChannelIds()

Optional parameter to specify the destination of purge operation. If the channel ID is specified, the purge operation will delete all the messages in the specific channels. If the channel ID is not specified, the purge operation will delete all the messages in the queue and in the child channels.

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