SubscriptionInfo (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.SubscriptionDescription>
- - com.microsoft.windowsazure.services.servicebus.models.SubscriptionInfo

public class SubscriptionInfo
extends com.microsoft.windowsazure.services.servicebus.implementation.EntryModel<com.microsoft.windowsazure.services.servicebus.implementation.SubscriptionDescription>

Represents a subscription.

Constructor Summary

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

Method Summary

Methods
Modifier and Type	Method and Description
`Calendar`	`getAccessedAt()` Gets the accessed at.
`Duration`	`getAutoDeleteOnIdle()` Gets the auto delete on idle.
`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).
`com.microsoft.windowsazure.services.servicebus.implementation.RuleDescription`	`getDefaultRuleDescription()` Returns the description of the default rule.
`com.microsoft.windowsazure.services.servicebus.implementation.EntityAvailabilityStatus`	`getEntityAvailabilityStatus()` Gets the entity availability status.
`String`	`getForwardTo()` Gets a `String` representing the URI of the entity to forward to.
`Duration`	`getLockDuration()` Returns the duration of the lock.
`Integer`	`getMaxDeliveryCount()` Returns the maximum delivery count for the subscription.
`Long`	`getMessageCount()` Returns the number of messages in the subscription.
`String`	`getName()` Returns the name of the subscription.
`com.microsoft.windowsazure.services.servicebus.implementation.EntityStatus`	`getStatus()` Gets the status.
`Calendar`	`getUpdatedAt()` Gets the updated at.
`String`	`getUserMetadata()` Gets the user metadata.
`Boolean`	`isDeadLetteringOnFilterEvaluationExceptions()` Indicates whether dead lettering is in effect when filter evaluation exceptions are encountered.
`Boolean`	`isDeadLetteringOnMessageExpiration()` Indicates whether dead lettering is in effect upon message expiration.
`Boolean`	`isEnableBatchedOperations()` Indicates whether batch operations are enabled.
`Boolean`	`isRequiresSession()` Indicates whether the subscription is session-aware.
`SubscriptionInfo`	`setAccessedAt(Calendar accessedAt)` Sets the accessed at.
`SubscriptionInfo`	`setAutoDeleteOnIdle(Duration autoDeleteOnIdle)` Sets the auto delete on idle.
`SubscriptionInfo`	`setCreatedAt(Calendar createdAt)` Sets the created at.
`SubscriptionInfo`	`setDeadLetteringOnFilterEvaluationExceptions(Boolean value)` Specifies whether dead lettering is in effect when filter evaluation exceptions are encountered.
`SubscriptionInfo`	`setDeadLetteringOnMessageExpiration(Boolean value)` Specifies whether dead lettering is in effect upon message expiration.
`SubscriptionInfo`	`setDefaultMessageTimeToLive(Duration value)` Sets the default message time-to-live (TTL).
`SubscriptionInfo`	`setDefaultRuleDescription(com.microsoft.windowsazure.services.servicebus.implementation.RuleDescription value)` Specifies the description for the default rule.
`SubscriptionInfo`	`setEnableBatchedOperations(Boolean value)` Specifies whether batch operations are enabled.
`SubscriptionInfo`	`setEntityAvailabilityStatus(com.microsoft.windowsazure.services.servicebus.implementation.EntityAvailabilityStatus entityAvailabilityStatus)` Sets the entity availability status.
`SubscriptionInfo`	`setForwardTo(String forwardTo)` Sets the forward to.
`SubscriptionInfo`	`setLockDuration(Duration value)` Sets the duration of the lock.
`SubscriptionInfo`	`setMaxDeliveryCount(Integer value)` Sets the maximum delivery count for the subscription.
`SubscriptionInfo`	`setMessageCount(Long messageCount)` Sets the message count.
`SubscriptionInfo`	`setName(String value)` Sets the name of the subscription.
`SubscriptionInfo`	`setRequiresSession(Boolean value)` Specifies whether the subscription is session-aware.
`SubscriptionInfo`	`setStatus(com.microsoft.windowsazure.services.servicebus.implementation.EntityStatus entityStatus)` Sets the status.
`SubscriptionInfo`	`setUpdatedAt(Calendar updatedAt)` Sets the updated at.
`SubscriptionInfo`	`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
  - SubscriptionInfo
```
public SubscriptionInfo()
```
    Creates an instance of the SubscriptionInfo class.
  - SubscriptionInfo
```
public SubscriptionInfo(com.microsoft.windowsazure.services.servicebus.implementation.Entry entry)
```
    Creates an instance of the SubscriptionInfo class using the specified entry.
    
    Parameters:
    entry - An Entry object.
  - SubscriptionInfo
```
public SubscriptionInfo(String name)
```
    Creates an instance of the SubscriptionInfo class using the specified name.
    
    Parameters:
    name - A String object that represents the name of the subscription.
- Method Detail
  - getName
```
public String getName()
```
    Returns the name of the subscription.
    
    Returns:
    A String object that represents the name of the subscription.
  - setName
```
public SubscriptionInfo setName(String value)
```
    Sets the name of the subscription.
    
    Parameters:
    value - A String that represents the name of the subscription.
    
    Returns:
    A SubscriptionInfo object that represents the updated subscription.
  - getLockDuration
```
public Duration getLockDuration()
```
    Returns the duration of the lock.
    
    Returns:
    A Duration object that represents the duration of the lock.
  - setLockDuration
```
public SubscriptionInfo setLockDuration(Duration value)
```
    Sets the duration of the lock.
    
    Parameters:
    value - The duration, in seconds, of the lock.
    
    Returns:
    A SubscriptionInfo object that represents the updated subscription.
  - isRequiresSession
```
public Boolean isRequiresSession()
```
    Indicates whether the subscription is session-aware.
    
    Returns:
    true if the subscription is session aware; otherwise, false.
  - setRequiresSession
```
public SubscriptionInfo setRequiresSession(Boolean value)
```
    Specifies whether the subscription is session-aware.
    
    Parameters:
    value - true if the subscription is session aware; otherwise, false.
    
    Returns:
    A SubscriptionInfo object that represents the updated subscription.
  - 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 SubscriptionInfo 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 SubscriptionInfo object that represents the updated subscription.
  - 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 SubscriptionInfo 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 SubscriptionInfo object that represents the updated subscription.
  - isDeadLetteringOnFilterEvaluationExceptions
```
public Boolean isDeadLetteringOnFilterEvaluationExceptions()
```
    Indicates whether dead lettering is in effect when filter evaluation exceptions are encountered.
    
    Returns:
    true if dead lettering is in effect; otherwise, false.
  - setDeadLetteringOnFilterEvaluationExceptions
```
public SubscriptionInfo setDeadLetteringOnFilterEvaluationExceptions(Boolean value)
```
    Specifies whether dead lettering is in effect when filter evaluation exceptions are encountered.
    
    Parameters:
    value - true if dead lettering is in effect; otherwise, false.
    
    Returns:
    A SubscriptionInfo object that represents the updated subscription.
  - getDefaultRuleDescription
```
public com.microsoft.windowsazure.services.servicebus.implementation.RuleDescription getDefaultRuleDescription()
```
    Returns the description of the default rule.
    
    Returns:
    A RuleDescription object that represents the default rule description.
  - setDefaultRuleDescription
```
public SubscriptionInfo setDefaultRuleDescription(com.microsoft.windowsazure.services.servicebus.implementation.RuleDescription value)
```
    Specifies the description for the default rule.
    
    Parameters:
    value - A RuleDescription object that represents the default rule description.
    
    Returns:
    A SubscriptionInfo object that represents the updated subscription.
  - getMessageCount
```
public Long getMessageCount()
```
    Returns the number of messages in the subscription.
    
    Returns:
    A Long object represents the count of the message.
  - getMaxDeliveryCount
```
public Integer getMaxDeliveryCount()
```
    Returns the maximum delivery count for the subscription.
    
    Returns:
    A Integer represents the maximum delivery count.
  - setMaxDeliveryCount
```
public SubscriptionInfo setMaxDeliveryCount(Integer value)
```
    Sets the maximum delivery count for the subscription.
    
    Parameters:
    value - A value represents the maximum delivery count for the subscription.
    
    Returns:
    A SubscriptionInfo object that represents the updated subscription.
  - isEnableBatchedOperations
```
public Boolean isEnableBatchedOperations()
```
    Indicates whether batch operations are enabled.
    
    Returns:
    true if batch operations are enabled; otherwise, false.
  - setEnableBatchedOperations
```
public SubscriptionInfo setEnableBatchedOperations(Boolean value)
```
    Specifies whether batch operations are enabled.
    
    Parameters:
    value - true if batch operations are enabled; otherwise, false.
    
    Returns:
    A SubscriptionInfo object that represents the updated subscription.
  - setMessageCount
```
public SubscriptionInfo setMessageCount(Long messageCount)
```
    Sets the message count.
    
    Parameters:
    messageCount - A Long object represents the message count.
    
    Returns:
    A SubscriptionInfo object that represents the updated subscription.
  - setStatus
```
public SubscriptionInfo setStatus(com.microsoft.windowsazure.services.servicebus.implementation.EntityStatus entityStatus)
```
    Sets the status.
    
    Parameters:
    entityStatus - A EntityStatus object represents the status of the entity.
    
    Returns:
    A SubscriptionInfo object that represents the updated subscription.
  - getStatus
```
public com.microsoft.windowsazure.services.servicebus.implementation.EntityStatus getStatus()
```
    Gets the status.
    
    Returns:
    A EntityStatus object represents the status of the entity.
  - setCreatedAt
```
public SubscriptionInfo setCreatedAt(Calendar createdAt)
```
    Sets the created at.
    
    Parameters:
    createdAt - the created at
    
    Returns:
    A SubscriptionInfo object that represents the updated subscription.
  - getCreatedAt
```
public Calendar getCreatedAt()
```
    Gets the created at.
    
    Returns:
    the created at
  - setUpdatedAt
```
public SubscriptionInfo setUpdatedAt(Calendar updatedAt)
```
    Sets the updated at.
    
    Parameters:
    updatedAt - the updated at
    
    Returns:
    A SubscriptionInfo object that represents the updated subscription.
  - getUpdatedAt
```
public Calendar getUpdatedAt()
```
    Gets the updated at.
    
    Returns:
    the updated at
  - setAccessedAt
```
public SubscriptionInfo setAccessedAt(Calendar accessedAt)
```
    Sets the accessed at.
    
    Parameters:
    accessedAt - the accessed at
    
    Returns:
    A SubscriptionInfo object that represents the updated subscription.
  - getAccessedAt
```
public Calendar getAccessedAt()
```
    Gets the accessed at.
    
    Returns:
    the accessed at
  - setUserMetadata
```
public SubscriptionInfo setUserMetadata(String userMetadata)
```
    Sets the user metadata.
    
    Parameters:
    userMetadata - the user metadata
    
    Returns:
    A SubscriptionInfo object that represents the updated subscription.
  - getUserMetadata
```
public String getUserMetadata()
```
    Gets the user metadata.
    
    Returns:
    the user metadata
  - setAutoDeleteOnIdle
```
public SubscriptionInfo setAutoDeleteOnIdle(Duration autoDeleteOnIdle)
```
    Sets the auto delete on idle.
    
    Parameters:
    autoDeleteOnIdle - A Duration object represents the auto delete on idle.
    
    Returns:
    A SubscriptionInfo object that represents the updated subscription.
  - getAutoDeleteOnIdle
```
public Duration getAutoDeleteOnIdle()
```
    Gets the auto delete on idle.
    
    Returns:
    A Duration object represents the auto delete on idle.
  - setEntityAvailabilityStatus
```
public SubscriptionInfo setEntityAvailabilityStatus(com.microsoft.windowsazure.services.servicebus.implementation.EntityAvailabilityStatus entityAvailabilityStatus)
```
    Sets the entity availability status.
    
    Parameters:
    entityAvailabilityStatus - An EntityAvailabilityStatus instance representing the entity availiability status.
    
    Returns:
    A SubscriptionInfo object that represents the updated subscription.
  - getEntityAvailabilityStatus
```
public com.microsoft.windowsazure.services.servicebus.implementation.EntityAvailabilityStatus getEntityAvailabilityStatus()
```
    Gets the entity availability status.
    
    Returns:
    An EntityAvailabilityStatus instance representing the entity availiability status.
  - getCountDetails
```
public com.microsoft.windowsazure.services.servicebus.implementation.MessageCountDetails getCountDetails()
```
    Gets the message count details.
    
    Returns:
    A MessageCountDetails instance representing the details of the message count.
  - setForwardTo
```
public SubscriptionInfo setForwardTo(String forwardTo)
```
    Sets the forward to.
    
    Parameters:
    forwardTo - A String representing the string to forward to.
    
    Returns:
    the subscription info
  - getForwardTo
```
public String getForwardTo()
```
    Gets a String representing the URI of the entity to forward to.
    
    Returns:
    A String representing the URI of the entity 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 SubscriptionInfo

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

SubscriptionInfo

SubscriptionInfo

SubscriptionInfo

Method Detail

getName

setName

getLockDuration

setLockDuration

isRequiresSession

setRequiresSession

getDefaultMessageTimeToLive

setDefaultMessageTimeToLive

isDeadLetteringOnMessageExpiration

setDeadLetteringOnMessageExpiration

isDeadLetteringOnFilterEvaluationExceptions

setDeadLetteringOnFilterEvaluationExceptions

getDefaultRuleDescription

setDefaultRuleDescription

getMessageCount

getMaxDeliveryCount

setMaxDeliveryCount

isEnableBatchedOperations

setEnableBatchedOperations

setMessageCount

setStatus

getStatus

setCreatedAt

getCreatedAt

setUpdatedAt

getUpdatedAt

setAccessedAt

getAccessedAt

setUserMetadata

getUserMetadata

setAutoDeleteOnIdle

getAutoDeleteOnIdle

setEntityAvailabilityStatus

getEntityAvailabilityStatus

getCountDetails

setForwardTo

getForwardTo