@Generated(value="OracleSDKGenerator",
comments="API Version: 20210201")
public final class Queue
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
A detailed representation of a queue and its configuration.
Note: Objects should always be created or deserialized using the Queue.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 Queue.Builder, which maintain a
set of all explicitly set fields called Queue.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).
| Modifier and Type | Class and Description |
|---|---|
static class |
Queue.Builder |
static class |
Queue.LifecycleState
The current state of the queue.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
Queue(String id,
String displayName,
String compartmentId,
Date timeCreated,
Date timeUpdated,
Queue.LifecycleState lifecycleState,
String lifecycleDetails,
String messagesEndpoint,
Integer retentionInSeconds,
Integer visibilityInSeconds,
Integer timeoutInSeconds,
Integer deadLetterQueueDeliveryCount,
String customEncryptionKeyId,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags,
Map<String,Map<String,Object>> systemTags,
Integer channelConsumptionLimit)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static Queue.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 |
getCompartmentId()
The OCID of
the compartment containing the queue.
|
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()
A user-friendly name for the queue.
|
Map<String,String> |
getFreeformTags()
Simple key-value pair that is applied without any predefined name, type or scope.
|
String |
getId()
A unique identifier for the queue that is immutable on creation.
|
String |
getLifecycleDetails()
Any additional details about the current state of the queue.
|
Queue.LifecycleState |
getLifecycleState()
The current state of the queue.
|
String |
getMessagesEndpoint()
The endpoint to use to consume or publish messages in the queue.
|
Integer |
getRetentionInSeconds()
The retention period of the messages in the queue, in seconds.
|
Map<String,Map<String,Object>> |
getSystemTags()
Usage of system tag keys.
|
Date |
getTimeCreated()
The time that the queue was created, expressed in RFC
3339 timestamp format.
|
Integer |
getTimeoutInSeconds()
The default polling timeout of the messages in the queue, in seconds.
|
Date |
getTimeUpdated()
The time that the queue was updated, expressed in RFC
3339 timestamp format.
|
Integer |
getVisibilityInSeconds()
The default visibility timeout of the messages consumed from the queue, in seconds.
|
int |
hashCode() |
Queue.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"id","displayName","compartmentId","timeCreated","timeUpdated","lifecycleState","lifecycleDetails","messagesEndpoint","retentionInSeconds","visibilityInSeconds","timeoutInSeconds","deadLetterQueueDeliveryCount","customEncryptionKeyId","freeformTags","definedTags","systemTags","channelConsumptionLimit"}) public Queue(String id, String displayName, String compartmentId, Date timeCreated, Date timeUpdated, Queue.LifecycleState lifecycleState, String lifecycleDetails, String messagesEndpoint, Integer retentionInSeconds, Integer visibilityInSeconds, Integer timeoutInSeconds, Integer deadLetterQueueDeliveryCount, String customEncryptionKeyId, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags, Integer channelConsumptionLimit)
public static Queue.Builder builder()
Create a new builder.
public Queue.Builder toBuilder()
public String getId()
A unique identifier for the queue that is immutable on creation.
public String getDisplayName()
A user-friendly name for the queue. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
public String getCompartmentId()
The OCID of the compartment containing the queue.
public Date getTimeCreated()
The time that the queue was created, expressed in RFC 3339 timestamp format.
Example: 2018-04-20T00:00:07.405Z
public Date getTimeUpdated()
The time that the queue was updated, expressed in RFC 3339 timestamp format.
Example: 2018-04-20T00:00:07.405Z
public Queue.LifecycleState getLifecycleState()
The current state of the queue.
public String getLifecycleDetails()
Any additional details about the current state of the queue.
public String getMessagesEndpoint()
The endpoint to use to consume or publish messages in the queue.
public Integer getRetentionInSeconds()
The retention period of the messages in the queue, in seconds.
public Integer getVisibilityInSeconds()
The default visibility timeout of the messages consumed from the queue, in seconds.
public Integer getTimeoutInSeconds()
The default polling timeout of the messages in the queue, in seconds.
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.
public String getCustomEncryptionKeyId()
The OCID of the custom encryption key to be used to encrypt messages content.
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"}
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"}}
public Map<String,Map<String,Object>> getSystemTags()
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}}
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.
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.