Share via

QueueProperties Class

Package:
com.azure.storage.queue.models
Maven Artifact:
com.azure:azure-storage-queue:12.27.0
  • java.lang.Object
    • com.azure.storage.queue.models.QueueProperties

public final class QueueProperties

Model class containing properties of a specific queue in the storage Queue service.

Constructor Summary

Constructor Description
QueueProperties(Map<String,String> metadata, int approximateMessagesCount)

Deprecated

Creates an instance that contains properties of a queue.
QueueProperties(Map<String,String> metadata, long approximateMessagesCount)

Creates an instance that contains properties of a queue.

Method Summary

Modifier and Type Method and Description
int getApproximateMessagesCount()

Deprecated

Gets the approximate number of messages contained in the queue at the time of properties retrieval.
long getApproximateMessagesCountLong()

Gets the approximate number of messages contained in the queue at the time of properties retrieval.
Map<String,String> getMetadata()

Gets the user-defined metadata associated with the queue.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

QueueProperties

@Deprecated
public QueueProperties(Map<String,String> metadata, int approximateMessagesCount)

Deprecated

Creates an instance that contains properties of a queue.

Parameters:

metadata - Metadata associated with the queue.
approximateMessagesCount - Approximate number of messages contained in the queue.

QueueProperties

public QueueProperties(Map<String,String> metadata, long approximateMessagesCount)

Creates an instance that contains properties of a queue.

Parameters:

metadata - Metadata associated with the queue.
approximateMessagesCount - Approximate number of messages contained in the queue.

Method Details

getApproximateMessagesCount

@Deprecated
public int getApproximateMessagesCount()

Deprecated

Gets the approximate number of messages contained in the queue at the time of properties retrieval.

Returns:

the approximate number of messages contained in the queue at the time of properties retrieval.

getApproximateMessagesCountLong

public long getApproximateMessagesCountLong()

Gets the approximate number of messages contained in the queue at the time of properties retrieval.

Returns:

the approximate number of messages contained in the queue at the time of properties retrieval.

getMetadata

public Map<String,String> getMetadata()

Gets the user-defined metadata associated with the queue.

Returns:

The user-defined metadata associated with the queue.

Applies to