com.oracle.bmc.queue.model

Class UpdateQueueDetails

java.lang.Object

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

com.oracle.bmc.queue.model.UpdateQueueDetails

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

The information to be updated.
Note: Objects should always be created or deserialized using the UpdateQueueDetails.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 UpdateQueueDetails.Builder, which maintain a set of all explicitly set fields called UpdateQueueDetails.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	UpdateQueueDetails.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 and Description
UpdateQueueDetails(String displayName, Integer visibilityInSeconds, Integer timeoutInSeconds, Integer channelConsumptionLimit, Integer deadLetterQueueDeliveryCount, String customEncryptionKeyId, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags) Deprecated.

Method Summary

Modifier and Type	Method and Description
static UpdateQueueDetails.Builder	builder() Create a new builder.
boolean	equals(Object o)
Integer	getChannelConsumptionLimit() The percentage of allocated queue resources that can be consumed by a single channel.
String	getCustomEncryptionKeyId() The OCID of the custom encryption key to be used to encrypt messages content.
Integer	getDeadLetterQueueDeliveryCount() The number of times a message can be delivered to a consumer before being moved to the dead letter queue.
Map<String,Map<String,Object>>	getDefinedTags() Defined tags for this resource.
String	getDisplayName() The OCID of the queue.
Map<String,String>	getFreeformTags() Simple key-value pair that is applied without any predefined name, type or scope.
Integer	getTimeoutInSeconds() The default polling timeout of the messages in the queue, in seconds.
Integer	getVisibilityInSeconds() The default visibility timeout of the messages consumed from the queue, in seconds.
int	hashCode()
UpdateQueueDetails.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

UpdateQueueDetails

@Deprecated
 @ConstructorProperties(value={"displayName","visibilityInSeconds","timeoutInSeconds","channelConsumptionLimit","deadLetterQueueDeliveryCount","customEncryptionKeyId","freeformTags","definedTags"})
public UpdateQueueDetails(String displayName,
                                                                                                                                                                                                                                            Integer visibilityInSeconds,
                                                                                                                                                                                                                                            Integer timeoutInSeconds,
                                                                                                                                                                                                                                            Integer channelConsumptionLimit,
                                                                                                                                                                                                                                            Integer deadLetterQueueDeliveryCount,
                                                                                                                                                                                                                                            String customEncryptionKeyId,
                                                                                                                                                                                                                                            Map<String,String> freeformTags,
                                                                                                                                                                                                                                            Map<String,Map<String,Object>> definedTags)

Deprecated.

Method Detail

builder

public static UpdateQueueDetails.Builder builder()

Create a new builder.

toBuilder

public UpdateQueueDetails.Builder toBuilder()

getDisplayName

public String getDisplayName()

The OCID of the queue.

Returns:

the value

getVisibilityInSeconds

public Integer getVisibilityInSeconds()

The default visibility timeout of the messages consumed from the queue, in seconds.

Returns:

the value

getTimeoutInSeconds

public Integer getTimeoutInSeconds()

The default polling timeout of the messages in the queue, in seconds.

Returns:

the value

getChannelConsumptionLimit

public Integer getChannelConsumptionLimit()

The percentage of allocated queue resources that can be consumed by a single channel. For example, if a queue has a storage limit of 2Gb, and a single channel consumption limit is 0.1 (10%), that means data size of a single channel can’t exceed 200Mb. Consumption limit of 100% (default) means that a single channel can consume up-to all allocated queue’s resources.

Returns:

the value

getDeadLetterQueueDeliveryCount

public Integer getDeadLetterQueueDeliveryCount()

The number of times a message can be delivered to a consumer before being moved to the dead letter queue. A value of 0 indicates that the DLQ is not used. Changing that value to a lower threshold does not retroactively move in-flight messages in the dead letter queue.

Returns:

the value

getCustomEncryptionKeyId

public String getCustomEncryptionKeyId()

The OCID of the custom encryption key to be used to encrypt messages content. A string with a length of 0 means the custom key should be removed from queue.

Returns:

the value

getFreeformTags

public Map<String,String> getFreeformTags()

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

Returns:

the value

getDefinedTags

public Map<String,Map<String,Object>> getDefinedTags()

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}

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