QueueInfo (Microsoft Azure SDK for Service Bus 0.7.0 API)

java.lang.Object
- com.microsoft.windowsazure.services.servicebus.implementation.EntryModel<com.microsoft.windowsazure.services.servicebus.implementation.QueueDescription>
- - com.microsoft.windowsazure.services.servicebus.models.QueueInfo

public class QueueInfo
extends com.microsoft.windowsazure.services.servicebus.implementation.EntryModel<com.microsoft.windowsazure.services.servicebus.implementation.QueueDescription>

Represents a queue.

Constructor Summary

Constructors
Constructor and Description
`QueueInfo()` Creates an instance of the `QueueInfo` class.
`QueueInfo(com.microsoft.windowsazure.services.servicebus.implementation.Entry entry)` Creates an instance of the `QueueInfo` class using the specified entry.
`QueueInfo(String path)` Creates an instance of the `QueueInfo` class using the specified name.

Method Summary

Methods
Modifier and Type	Method and Description
`Calendar`	`getAccessedAt()` Gets the accessed at.
`Duration`	`getAutoDeleteOnIdle()` Gets the time span before auto deletion starts.
`com.microsoft.windowsazure.services.servicebus.implementation.MessageCountDetails`	`getCountDetails()` Gets the message count details.
`Calendar`	`getCreatedAt()` Gets the created at.
`Duration`	`getDefaultMessageTimeToLive()` Returns the default message time-to-live (TTL).
`Duration`	`getDuplicateDetectionHistoryTimeWindow()` Returns the time span during which the service bus will detect message duplication.
`com.microsoft.windowsazure.services.servicebus.implementation.EntityAvailabilityStatus`	`getEntityAvailabilityStatus()` Gets the entity availability status.
`String`	`getForwardTo()` Gets a `String` instance representing entity to forward to.
`Duration`	`getLockDuration()` Returns the duration of the lock.
`Integer`	`getMaxDeliveryCount()` Returns the maximum delivery count for the queue.
`Long`	`getMaxSizeInMegabytes()` Returns the maximum size of the queue.
`Long`	`getMessageCount()` Returns the number of messages in the queue.
`com.microsoft.windowsazure.services.servicebus.implementation.PartitioningPolicy`	`getPartitioningPolicy()` Gets the partitioning policy.
`String`	`getPath()` Returns the name of the queue.
`Long`	`getSizeInBytes()` Returns the size of the queue.
`com.microsoft.windowsazure.services.servicebus.implementation.EntityStatus`	`getStatus()` Gets the status.
`Calendar`	`getUpdatedAt()` Gets the updated at.
`URI`	`getUri()` Gets the URI of the `QueueInfo` instance.
`String`	`getUserMetadata()` Gets the user metadata.
`Boolean`	`isAnonymousAccessible()` Checks if is anonymous accessible.
`Boolean`	`isDeadLetteringOnMessageExpiration()` Indicates whether dead lettering is in effect upon message expiration.
`Boolean`	`isEnableBatchedOperations()` Indicates whether batch operations are enabled.
`Boolean`	`isRequiresDuplicateDetection()` Indicates whether duplicate message detection is required.
`Boolean`	`isRequiresSession()` Indicates whether the queue is session-aware.
`Boolean`	`isSupportOrdering()` Checks if is support ordering.
`QueueInfo`	`setAccessedAt(Calendar accessedAt)` Sets the accessed at.
`QueueInfo`	`setAutoDeleteOnIdle(Duration autoDeleteOnIdle)` Sets the time span before auto deletion starts.
`QueueInfo`	`setCreatedAt(Calendar createdAt)` Sets the created at.
`QueueInfo`	`setDeadLetteringOnMessageExpiration(Boolean value)` Specifies whether dead lettering is in effect upon message expiration.
`QueueInfo`	`setDefaultMessageTimeToLive(Duration value)` Sets the default message time-to-live (TTL).
`QueueInfo`	`setDuplicateDetectionHistoryTimeWindow(Duration value)` Sets the time span during which the service bus will detect message duplication.
`QueueInfo`	`setEnableBatchedOperations(Boolean value)` Specifies whether batch operations are enabled.
`QueueInfo`	`setEntityAvailabilityStatus(com.microsoft.windowsazure.services.servicebus.implementation.EntityAvailabilityStatus entityAvailabilityStatus)` Sets the entity availability status.
`QueueInfo`	`setForwardTo(String forwardTo)` Sets the URI of the entity to forward to.
`QueueInfo`	`setIsAnonymousAccessible(Boolean isAnonymousAccessible)` Sets the is anonymous accessible.
`QueueInfo`	`setLockDuration(Duration value)` Sets the duration of the lock.
`QueueInfo`	`setMaxDeliveryCount(Integer value)` Sets the maximum delivery count for the queue.
`QueueInfo`	`setMaxSizeInMegabytes(Long value)` Sets the maximum size of the queue.
`QueueInfo`	`setMessageCount(Long messageCount)` Sets the message count.
`QueueInfo`	`setPartitioningPolicy(com.microsoft.windowsazure.services.servicebus.implementation.PartitioningPolicy partitioningPolicy)` Sets the partitioning policy.
`QueueInfo`	`setPath(String value)` Sets the name of the queue.
`QueueInfo`	`setRequiresDuplicateDetection(Boolean value)` Specifies whether duplicate message detection is required.
`QueueInfo`	`setRequiresSession(Boolean value)` Specifies whether the queue is session-aware.
`QueueInfo`	`setSizeInBytes(Long sizeInBytes)` Sets the size in bytes.
`QueueInfo`	`setStatus(com.microsoft.windowsazure.services.servicebus.implementation.EntityStatus entityStatus)` Sets the status.
`QueueInfo`	`setSupportOrdering(Boolean supportOrdering)` Sets the support ordering.
`QueueInfo`	`setUpdatedAt(Calendar updatedAt)` Sets the updated at.
`QueueInfo`	`setUri(URI uri)` Sets the URI of the `QueueInfo` instance.
`QueueInfo`	`setUserMetadata(String userMetadata)` Sets the user metadata.

Methods inherited from class com.microsoft.windowsazure.services.servicebus.implementation.EntryModel
getEntry, getModel, setEntry, setModel

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - QueueInfo
```
public QueueInfo()
```
    Creates an instance of the QueueInfo class.
  - QueueInfo
```
public QueueInfo(com.microsoft.windowsazure.services.servicebus.implementation.Entry entry)
```
    Creates an instance of the QueueInfo class using the specified entry.
    
    Parameters:
    entry - An Entry object.
  - QueueInfo
```
public QueueInfo(String path)
```
    Creates an instance of the QueueInfo class using the specified name.
    
    Parameters:
    path - A String object that represents the name of the queue.
- Method Detail
  - getPath
```
public String getPath()
```
    Returns the name of the queue.
    
    Returns:
    A String object that represents the name of the queue.
  - setPath
```
public QueueInfo setPath(String value)
```
    Sets the name of the queue.
    
    Parameters:
    value - A String that represents the name of the queue.
    
    Returns:
    A QueueInfo object that represents the updated queue.
  - getLockDuration
```
public Duration getLockDuration()
```
    Returns the duration of the lock.
    
    Returns:
    A Duration object that represents the duration of the lock.
  - setLockDuration
```
public QueueInfo setLockDuration(Duration value)
```
    Sets the duration of the lock.
    
    Parameters:
    value - The duration, in seconds, of the lock.
    
    Returns:
    A QueueInfo object that represents the updated queue.
  - getMaxSizeInMegabytes
```
public Long getMaxSizeInMegabytes()
```
    Returns the maximum size of the queue.
    
    Returns:
    The maximum size, in megabytes, of the queue.
  - setMaxSizeInMegabytes
```
public QueueInfo setMaxSizeInMegabytes(Long value)
```
    Sets the maximum size of the queue.
    
    Parameters:
    value - The maximum size, in megabytes, of the queue.
    
    Returns:
    A QueueInfo object that represents the updated queue.
  - isRequiresDuplicateDetection
```
public Boolean isRequiresDuplicateDetection()
```
    Indicates whether duplicate message detection is required.
    
    Returns:
    true if duplicate message detection is required; otherwise, false.
  - setRequiresDuplicateDetection
```
public QueueInfo setRequiresDuplicateDetection(Boolean value)
```
    Specifies whether duplicate message detection is required.
    
    Parameters:
    value - true if duplicate message detection is required; otherwise, false.
    
    Returns:
    A QueueInfo object that represents the updated queue.
  - isRequiresSession
```
public Boolean isRequiresSession()
```
    Indicates whether the queue is session-aware.
    
    Returns:
    true if the queue is session aware; otherwise, false.
  - setRequiresSession
```
public QueueInfo setRequiresSession(Boolean value)
```
    Specifies whether the queue is session-aware.
    
    Parameters:
    value - true if the queue is session aware; otherwise, false.
    
    Returns:
    A QueueInfo object that represents the updated queue.
  - getDefaultMessageTimeToLive
```
public Duration getDefaultMessageTimeToLive()
```
    Returns the default message time-to-live (TTL). This applies when dead lettering is in effect.
    
    Returns:
    A Duration object that represents the default message TTL.
  - setDefaultMessageTimeToLive
```
public QueueInfo setDefaultMessageTimeToLive(Duration value)
```
    Sets the default message time-to-live (TTL). This applies when dead lettering is in effect.
    
    Parameters:
    value - A Duration object that represents the default message TTL.
    
    Returns:
    A QueueInfo object that represents the updated queue.
  - getAutoDeleteOnIdle
```
public Duration getAutoDeleteOnIdle()
```
    Gets the time span before auto deletion starts.
    
    Returns:
    A Duration object that represents the time span before auto deletion.
  - setAutoDeleteOnIdle
```
public QueueInfo setAutoDeleteOnIdle(Duration autoDeleteOnIdle)
```
    Sets the time span before auto deletion starts.
    
    Parameters:
    autoDeleteOnIdle - A Duration object that represents the time span before auto deletion starts.
    
    Returns:
    A QueueInfo object that represents the updated queue.
  - isDeadLetteringOnMessageExpiration
```
public Boolean isDeadLetteringOnMessageExpiration()
```
    Indicates whether dead lettering is in effect upon message expiration.
    
    Returns:
    true if dead lettering is in effect; otherwise, false.
  - setDeadLetteringOnMessageExpiration
```
public QueueInfo setDeadLetteringOnMessageExpiration(Boolean value)
```
    Specifies whether dead lettering is in effect upon message expiration.
    
    Parameters:
    value - true if dead lettering is in effect; otherwise, false.
    
    Returns:
    A QueueInfo object that represents the updated queue.
  - getDuplicateDetectionHistoryTimeWindow
```
public Duration getDuplicateDetectionHistoryTimeWindow()
```
    Returns the time span during which the service bus will detect message duplication. This applies when duplicate message detection is in effect.
    
    Returns:
    A Duration object that represents the time span for detecting message duplication.
  - setDuplicateDetectionHistoryTimeWindow
```
public QueueInfo setDuplicateDetectionHistoryTimeWindow(Duration value)
```
    Sets the time span during which the service bus will detect message duplication. This applies when duplicate message detection is in effect.
    
    Parameters:
    value - A Duration object that represents the time span for detecting message duplication.
    
    Returns:
    A QueueInfo object that represents the updated queue.
  - getMaxDeliveryCount
```
public Integer getMaxDeliveryCount()
```
    Returns the maximum delivery count for the queue.
    
    Returns:
    An Integer object that represents the maximum delivery count.
  - setMaxDeliveryCount
```
public QueueInfo setMaxDeliveryCount(Integer value)
```
    Sets the maximum delivery count for the queue.
    
    Parameters:
    value - The maximum delivery count for the queue.
    
    Returns:
    A QueueInfo object that represents the updated queue.
  - isEnableBatchedOperations
```
public Boolean isEnableBatchedOperations()
```
    Indicates whether batch operations are enabled.
    
    Returns:
    true if batch operations are enabled; otherwise, false.
  - setEnableBatchedOperations
```
public QueueInfo setEnableBatchedOperations(Boolean value)
```
    Specifies whether batch operations are enabled.
    
    Parameters:
    value - true if batch operations are enabled; otherwise, false.
    
    Returns:
    A QueueInfo object that represents the updated queue.
  - getSizeInBytes
```
public Long getSizeInBytes()
```
    Returns the size of the queue.
    
    Returns:
    A Long object that represents the size of the queue in bytes.
  - setSizeInBytes
```
public QueueInfo setSizeInBytes(Long sizeInBytes)
```
    Sets the size in bytes.
    
    Parameters:
    sizeInBytes - the size in bytes
    
    Returns:
    A QueueInfo object that represents the updated queue.
  - getMessageCount
```
public Long getMessageCount()
```
    Returns the number of messages in the queue.
    
    Returns:
    A Long object that represents the number of messages in the queue.
  - setMessageCount
```
public QueueInfo setMessageCount(Long messageCount)
```
    Sets the message count.
    
    Parameters:
    messageCount - the message count
    
    Returns:
    A QueueInfo object that represents the updated queue.
  - isAnonymousAccessible
```
public Boolean isAnonymousAccessible()
```
    Checks if is anonymous accessible.
    
    Returns:
    true if the queue can be accessed anonymously. Otherwise, false.
  - setIsAnonymousAccessible
```
public QueueInfo setIsAnonymousAccessible(Boolean isAnonymousAccessible)
```
    Sets the is anonymous accessible.
    
    Parameters:
    isAnonymousAccessible - the is anonymous accessible
    
    Returns:
    A QueueInfo object that represents the updated queue.
  - isSupportOrdering
```
public Boolean isSupportOrdering()
```
    Checks if is support ordering.
    
    Returns:
    true if ordering is supported, otherwise, false.
  - setSupportOrdering
```
public QueueInfo setSupportOrdering(Boolean supportOrdering)
```
    Sets the support ordering.
    
    Parameters:
    supportOrdering - A Boolean object represents whether the queue supports ordering.
    
    Returns:
    A QueueInfo object that represents the updated queue.
  - getStatus
```
public com.microsoft.windowsazure.services.servicebus.implementation.EntityStatus getStatus()
```
    Gets the status.
    
    Returns:
    A EntityStatus object.
  - setStatus
```
public QueueInfo setStatus(com.microsoft.windowsazure.services.servicebus.implementation.EntityStatus entityStatus)
```
    Sets the status.
    
    Parameters:
    entityStatus - the entity status
    
    Returns:
    A QueueInfo object that represents the updated queue.
  - getEntityAvailabilityStatus
```
public com.microsoft.windowsazure.services.servicebus.implementation.EntityAvailabilityStatus getEntityAvailabilityStatus()
```
    Gets the entity availability status.
    
    Returns:
    A EntityAvailabilityStatus object which represents the availability status of the entity.
  - setEntityAvailabilityStatus
```
public QueueInfo setEntityAvailabilityStatus(com.microsoft.windowsazure.services.servicebus.implementation.EntityAvailabilityStatus entityAvailabilityStatus)
```
    Sets the entity availability status.
    
    Parameters:
    entityAvailabilityStatus - A EntityAvailabilityStatus object.
    
    Returns:
    A QueueInfo object that represents the updated queue.
  - getCreatedAt
```
public Calendar getCreatedAt()
```
    Gets the created at.
    
    Returns:
    A Calendar object which represents the time of the queue created at.
  - setCreatedAt
```
public QueueInfo setCreatedAt(Calendar createdAt)
```
    Sets the created at.
    
    Parameters:
    createdAt - A Calendar ojbect which represnets the time of the queue created at.
    
    Returns:
    A QueueInfo object that represents the updated queue.
  - getUpdatedAt
```
public Calendar getUpdatedAt()
```
    Gets the updated at.
    
    Returns:
    A Calendar object which represents the time that the queue was updated at.
  - setUpdatedAt
```
public QueueInfo setUpdatedAt(Calendar updatedAt)
```
    Sets the updated at.
    
    Parameters:
    updatedAt - A Calendar object which represents the time that the queue was updated at.
    
    Returns:
    A QueueInfo object that represents the updated queue.
  - getAccessedAt
```
public Calendar getAccessedAt()
```
    Gets the accessed at.
    
    Returns:
    A Calendar object which represents the time that the queue was accessed at.
  - setAccessedAt
```
public QueueInfo setAccessedAt(Calendar accessedAt)
```
    Sets the accessed at.
    
    Parameters:
    accessedAt - A Calendar object which represents the time that the queue was accessed at.
    
    Returns:
    A QueueInfo object that represents the updated queue.
  - getPartitioningPolicy
```
public com.microsoft.windowsazure.services.servicebus.implementation.PartitioningPolicy getPartitioningPolicy()
```
    Gets the partitioning policy.
    
    Returns:
    A PartitioningPolicy represents the partitioning policy.
  - setPartitioningPolicy
```
public QueueInfo setPartitioningPolicy(com.microsoft.windowsazure.services.servicebus.implementation.PartitioningPolicy partitioningPolicy)
```
    Sets the partitioning policy.
    
    Parameters:
    partitioningPolicy - A PartitioningPolicy represents the partitioning policy.
    
    Returns:
    A QueueInfo object that represents the updated queue.
  - getUserMetadata
```
public String getUserMetadata()
```
    Gets the user metadata.
    
    Returns:
    A String objects which contains the user metadata.
  - setUserMetadata
```
public QueueInfo setUserMetadata(String userMetadata)
```
    Sets the user metadata.
    
    Parameters:
    userMetadata - A String objects which contains the user metadata.
    
    Returns:
    A QueueInfo object that represents the updated queue.
  - getCountDetails
```
public com.microsoft.windowsazure.services.servicebus.implementation.MessageCountDetails getCountDetails()
```
    Gets the message count details.
    
    Returns:
    A MessageCountDetails instance that represents the details of the message count.
  - setUri
```
public QueueInfo setUri(URI uri)
```
    Sets the URI of the QueueInfo instance.
    
    Parameters:
    uri - the URI of the QueueInfo
    
    Returns:
    A QueueInfo object that represents the updated queue.
  - getUri
```
public URI getUri()
```
    Gets the URI of the QueueInfo instance.
    
    Returns:
    A URI representing the QueueInfo.
  - setForwardTo
```
public QueueInfo setForwardTo(String forwardTo)
```
    Sets the URI of the entity to forward to.
    
    Parameters:
    forwardTo - A String instance representing the URI of the entity to forward message to.
    
    Returns:
    A QueueInfo instance representing the updated queue information.
  - getForwardTo
```
public String getForwardTo()
```
    Gets a String instance representing entity to forward to.
    
    Returns:
    A String instance representing the URI of the instance to forward to.

/** 
* Copyright Microsoft Corporation 
* 
* Licensed under the Apache License, Version 2.0 (the "License"); 
* you may not use this file except in compliance with the License. 
* You may obtain a copy of the License at 
* http://www.apache.org/licenses/LICENSE-2.0 
* 
* Unless required by applicable law or agreed to in writing, software 
* distributed under the License is distributed on an "AS IS" BASIS, 
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
* See the License for the specific language governing permissions and 
* limitations under the License. 
*/

Class QueueInfo

Constructor Summary

Method Summary

Methods inherited from class com.microsoft.windowsazure.services.servicebus.implementation.EntryModel

Methods inherited from class java.lang.Object

Constructor Detail

QueueInfo

QueueInfo

QueueInfo

Method Detail

getPath

setPath

getLockDuration

setLockDuration

getMaxSizeInMegabytes

setMaxSizeInMegabytes

isRequiresDuplicateDetection

setRequiresDuplicateDetection

isRequiresSession

setRequiresSession

getDefaultMessageTimeToLive

setDefaultMessageTimeToLive

getAutoDeleteOnIdle

setAutoDeleteOnIdle

isDeadLetteringOnMessageExpiration

setDeadLetteringOnMessageExpiration

getDuplicateDetectionHistoryTimeWindow

setDuplicateDetectionHistoryTimeWindow

getMaxDeliveryCount

setMaxDeliveryCount

isEnableBatchedOperations

setEnableBatchedOperations

getSizeInBytes

setSizeInBytes

getMessageCount

setMessageCount

isAnonymousAccessible

setIsAnonymousAccessible

isSupportOrdering

setSupportOrdering

getStatus

setStatus

getEntityAvailabilityStatus

setEntityAvailabilityStatus

getCreatedAt

setCreatedAt

getUpdatedAt

setUpdatedAt

getAccessedAt

setAccessedAt

getPartitioningPolicy

setPartitioningPolicy

getUserMetadata

setUserMetadata

getCountDetails

setUri

getUri

setForwardTo

getForwardTo