Package com.oracle.bmc.queue.model

Class Queue

  • @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).

    • Method Detail

      • builder

        public static Queue.Builder builder()
        Create a new builder.

      • getId

        public String getId()
        A unique identifier for the queue that is immutable on creation.
        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        A user-friendly name for the queue.

        Does not have to be unique, and it’s changeable. Avoid entering confidential information.

        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment containing the queue.
        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The time that the queue was created, expressed in RFC 3339 timestamp format.

        Example: 2018-04-20T00:00:07.405Z

        Returns:
        the value

      • getTimeUpdated

        public Date getTimeUpdated()
        The time that the queue was updated, expressed in RFC 3339 timestamp format.

        Example: 2018-04-20T00:00:07.405Z

        Returns:
        the value

      • getLifecycleState

        public Queue.LifecycleState getLifecycleState()
        The current state of the queue.
        Returns:
        the value

      • getLifecycleDetails

        public String getLifecycleDetails()
        Any additional details about the current state of the queue.
        Returns:
        the value

      • getMessagesEndpoint

        public String getMessagesEndpoint()
        The endpoint to use to consume or publish messages in the queue.
        Returns:
        the value

      • getRetentionInSeconds

        public Integer getRetentionInSeconds()
        The retention period of the messages in the queue, in seconds.
        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

      • 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.

        Returns:
        the value

      • getCustomEncryptionKeyId

        public String getCustomEncryptionKeyId()
        The OCID of the custom encryption key to be used to encrypt messages content.
        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

      • getSystemTags

        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”}}

        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

      • 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