Share via

SBSubscriptionInner Class

  • Reference
Package:
com.azure.resourcemanager.servicebus.fluent.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-servicebus:2.44.0

public final class SBSubscriptionInner
extends Resource

Description of subscription resource.

Constructor Summary

Constructor Description
SBSubscriptionInner()

Creates an instance of SBSubscriptionInner class.

Method Summary

Modifier and Type Method and Description
OffsetDateTime accessedAt()

Get the accessedAt property: Last time there was a receive request to this subscription.
Duration autoDeleteOnIdle()

Get the autoDeleteOnIdle property: ISO 8061 timeSpan idle interval after which the topic is automatically deleted.
SBClientAffineProperties clientAffineProperties()

Get the clientAffineProperties property: Properties specific to client affine subscriptions.
MessageCountDetails countDetails()

Get the countDetails property: Message count details.
OffsetDateTime createdAt()

Get the createdAt property: Exact time the message was created.
Boolean deadLetteringOnFilterEvaluationExceptions()

Get the deadLetteringOnFilterEvaluationExceptions property: Value that indicates whether a subscription has dead letter support on filter evaluation exceptions.
Boolean deadLetteringOnMessageExpiration()

Get the deadLetteringOnMessageExpiration property: Value that indicates whether a subscription has dead letter support when a message expires.
Duration defaultMessageTimeToLive()

Get the defaultMessageTimeToLive property: ISO 8061 Default message timespan to live value.
Duration duplicateDetectionHistoryTimeWindow()

Get the duplicateDetectionHistoryTimeWindow property: ISO 8601 timeSpan structure that defines the duration of the duplicate detection history.
Boolean enableBatchedOperations()

Get the enableBatchedOperations property: Value that indicates whether server-side batched operations are enabled.
String forwardDeadLetteredMessagesTo()

Get the forwardDeadLetteredMessagesTo property: Queue/Topic name to forward the Dead Letter message.
String forwardTo()

Get the forwardTo property: Queue/Topic name to forward the messages.
static SBSubscriptionInner fromJson(JsonReader jsonReader)

Reads an instance of SBSubscriptionInner from the JsonReader.
String id()

Get the id property: Fully qualified resource Id for the resource.
Boolean isClientAffine()

Get the isClientAffine property: Value that indicates whether the subscription has an affinity to the client id.
String location()

Get the location property: The geo-location where the resource lives.
Duration lockDuration()

Get the lockDuration property: ISO 8061 lock duration timespan for the subscription.
Integer maxDeliveryCount()

Get the maxDeliveryCount property: Number of maximum deliveries.
Long messageCount()

Get the messageCount property: Number of messages.
String name()

Get the name property: The name of the resource.
Boolean requiresSession()

Get the requiresSession property: Value indicating if a subscription supports the concept of sessions.
EntityStatus status()

Get the status property: Enumerates the possible values for the status of a messaging entity.
SystemData systemData()

Get the systemData property: The system meta data relating to this resource.
JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: The type of the resource.
OffsetDateTime updatedAt()

Get the updatedAt property: The exact time the message was updated.
void validate()

Validates the instance.
SBSubscriptionInner withAutoDeleteOnIdle(Duration autoDeleteOnIdle)

Set the autoDeleteOnIdle property: ISO 8061 timeSpan idle interval after which the topic is automatically deleted.
SBSubscriptionInner withClientAffineProperties(SBClientAffineProperties clientAffineProperties)

Set the clientAffineProperties property: Properties specific to client affine subscriptions.
SBSubscriptionInner withDeadLetteringOnFilterEvaluationExceptions(Boolean deadLetteringOnFilterEvaluationExceptions)

Set the deadLetteringOnFilterEvaluationExceptions property: Value that indicates whether a subscription has dead letter support on filter evaluation exceptions.
SBSubscriptionInner withDeadLetteringOnMessageExpiration(Boolean deadLetteringOnMessageExpiration)

Set the deadLetteringOnMessageExpiration property: Value that indicates whether a subscription has dead letter support when a message expires.
SBSubscriptionInner withDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)

Set the defaultMessageTimeToLive property: ISO 8061 Default message timespan to live value.
SBSubscriptionInner withDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow)

Set the duplicateDetectionHistoryTimeWindow property: ISO 8601 timeSpan structure that defines the duration of the duplicate detection history.
SBSubscriptionInner withEnableBatchedOperations(Boolean enableBatchedOperations)

Set the enableBatchedOperations property: Value that indicates whether server-side batched operations are enabled.
SBSubscriptionInner withForwardDeadLetteredMessagesTo(String forwardDeadLetteredMessagesTo)

Set the forwardDeadLetteredMessagesTo property: Queue/Topic name to forward the Dead Letter message.
SBSubscriptionInner withForwardTo(String forwardTo)

Set the forwardTo property: Queue/Topic name to forward the messages.
SBSubscriptionInner withIsClientAffine(Boolean isClientAffine)

Set the isClientAffine property: Value that indicates whether the subscription has an affinity to the client id.
SBSubscriptionInner withLockDuration(Duration lockDuration)

Set the lockDuration property: ISO 8061 lock duration timespan for the subscription.
SBSubscriptionInner withMaxDeliveryCount(Integer maxDeliveryCount)

Set the maxDeliveryCount property: Number of maximum deliveries.
SBSubscriptionInner withRequiresSession(Boolean requiresSession)

Set the requiresSession property: Value indicating if a subscription supports the concept of sessions.
SBSubscriptionInner withStatus(EntityStatus status)

Set the status property: Enumerates the possible values for the status of a messaging entity.

Methods inherited from ProxyResource

id name type

Methods inherited from Resource

fromJson location tags toJson withLocation withTags

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

SBSubscriptionInner

public SBSubscriptionInner()

Creates an instance of SBSubscriptionInner class.

Method Details

accessedAt

public OffsetDateTime accessedAt()

Get the accessedAt property: Last time there was a receive request to this subscription.

Returns:

the accessedAt value.

autoDeleteOnIdle

public Duration autoDeleteOnIdle()

Get the autoDeleteOnIdle property: ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.

Returns:

the autoDeleteOnIdle value.

clientAffineProperties

public SBClientAffineProperties clientAffineProperties()

Get the clientAffineProperties property: Properties specific to client affine subscriptions.

Returns:

the clientAffineProperties value.

countDetails

public MessageCountDetails countDetails()

Get the countDetails property: Message count details.

Returns:

the countDetails value.

createdAt

public OffsetDateTime createdAt()

Get the createdAt property: Exact time the message was created.

Returns:

the createdAt value.

deadLetteringOnFilterEvaluationExceptions

public Boolean deadLetteringOnFilterEvaluationExceptions()

Get the deadLetteringOnFilterEvaluationExceptions property: Value that indicates whether a subscription has dead letter support on filter evaluation exceptions.

Returns:

the deadLetteringOnFilterEvaluationExceptions value.

deadLetteringOnMessageExpiration

public Boolean deadLetteringOnMessageExpiration()

Get the deadLetteringOnMessageExpiration property: Value that indicates whether a subscription has dead letter support when a message expires.

Returns:

the deadLetteringOnMessageExpiration value.

defaultMessageTimeToLive

public Duration defaultMessageTimeToLive()

Get the defaultMessageTimeToLive property: ISO 8061 Default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.

Returns:

the defaultMessageTimeToLive value.

duplicateDetectionHistoryTimeWindow

public Duration duplicateDetectionHistoryTimeWindow()

Get the duplicateDetectionHistoryTimeWindow property: ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.

Returns:

the duplicateDetectionHistoryTimeWindow value.

enableBatchedOperations

public Boolean enableBatchedOperations()

Get the enableBatchedOperations property: Value that indicates whether server-side batched operations are enabled.

Returns:

the enableBatchedOperations value.

forwardDeadLetteredMessagesTo

public String forwardDeadLetteredMessagesTo()

Get the forwardDeadLetteredMessagesTo property: Queue/Topic name to forward the Dead Letter message.

Returns:

the forwardDeadLetteredMessagesTo value.

forwardTo

public String forwardTo()

Get the forwardTo property: Queue/Topic name to forward the messages.

Returns:

the forwardTo value.

fromJson

public static SBSubscriptionInner fromJson(JsonReader jsonReader)

Reads an instance of SBSubscriptionInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of SBSubscriptionInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

id

public String id()

Get the id property: Fully qualified resource Id for the resource.

Overrides:

SBSubscriptionInner.id()

Returns:

the id value.

isClientAffine

public Boolean isClientAffine()

Get the isClientAffine property: Value that indicates whether the subscription has an affinity to the client id.

Returns:

the isClientAffine value.

location

public String location()

Get the location property: The geo-location where the resource lives.

Overrides:

SBSubscriptionInner.location()

Returns:

the location value.

lockDuration

public Duration lockDuration()

Get the lockDuration property: ISO 8061 lock duration timespan for the subscription. The default value is 1 minute.

Returns:

the lockDuration value.

maxDeliveryCount

public Integer maxDeliveryCount()

Get the maxDeliveryCount property: Number of maximum deliveries.

Returns:

the maxDeliveryCount value.

messageCount

public Long messageCount()

Get the messageCount property: Number of messages.

Returns:

the messageCount value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

SBSubscriptionInner.name()

Returns:

the name value.

requiresSession

public Boolean requiresSession()

Get the requiresSession property: Value indicating if a subscription supports the concept of sessions.

Returns:

the requiresSession value.

status

public EntityStatus status()

Get the status property: Enumerates the possible values for the status of a messaging entity.

Returns:

the status value.

systemData

public SystemData systemData()

Get the systemData property: The system meta data relating to this resource.

Returns:

the systemData value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

SBSubscriptionInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: The type of the resource.

Overrides:

SBSubscriptionInner.type()

Returns:

the type value.

updatedAt

public OffsetDateTime updatedAt()

Get the updatedAt property: The exact time the message was updated.

Returns:

the updatedAt value.

validate

public void validate()

Validates the instance.

withAutoDeleteOnIdle

public SBSubscriptionInner withAutoDeleteOnIdle(Duration autoDeleteOnIdle)

Set the autoDeleteOnIdle property: ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.

Parameters:

autoDeleteOnIdle - the autoDeleteOnIdle value to set.

Returns:

the SBSubscriptionInner object itself.

withClientAffineProperties

public SBSubscriptionInner withClientAffineProperties(SBClientAffineProperties clientAffineProperties)

Set the clientAffineProperties property: Properties specific to client affine subscriptions.

Parameters:

clientAffineProperties - the clientAffineProperties value to set.

Returns:

the SBSubscriptionInner object itself.

withDeadLetteringOnFilterEvaluationExceptions

public SBSubscriptionInner withDeadLetteringOnFilterEvaluationExceptions(Boolean deadLetteringOnFilterEvaluationExceptions)

Set the deadLetteringOnFilterEvaluationExceptions property: Value that indicates whether a subscription has dead letter support on filter evaluation exceptions.

Parameters:

deadLetteringOnFilterEvaluationExceptions - the deadLetteringOnFilterEvaluationExceptions value to set.

Returns:

the SBSubscriptionInner object itself.

withDeadLetteringOnMessageExpiration

public SBSubscriptionInner withDeadLetteringOnMessageExpiration(Boolean deadLetteringOnMessageExpiration)

Set the deadLetteringOnMessageExpiration property: Value that indicates whether a subscription has dead letter support when a message expires.

Parameters:

deadLetteringOnMessageExpiration - the deadLetteringOnMessageExpiration value to set.

Returns:

the SBSubscriptionInner object itself.

withDefaultMessageTimeToLive

public SBSubscriptionInner withDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)

Set the defaultMessageTimeToLive property: ISO 8061 Default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.

Parameters:

defaultMessageTimeToLive - the defaultMessageTimeToLive value to set.

Returns:

the SBSubscriptionInner object itself.

withDuplicateDetectionHistoryTimeWindow

public SBSubscriptionInner withDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow)

Set the duplicateDetectionHistoryTimeWindow property: ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.

Parameters:

duplicateDetectionHistoryTimeWindow - the duplicateDetectionHistoryTimeWindow value to set.

Returns:

the SBSubscriptionInner object itself.

withEnableBatchedOperations

public SBSubscriptionInner withEnableBatchedOperations(Boolean enableBatchedOperations)

Set the enableBatchedOperations property: Value that indicates whether server-side batched operations are enabled.

Parameters:

enableBatchedOperations - the enableBatchedOperations value to set.

Returns:

the SBSubscriptionInner object itself.

withForwardDeadLetteredMessagesTo

public SBSubscriptionInner withForwardDeadLetteredMessagesTo(String forwardDeadLetteredMessagesTo)

Set the forwardDeadLetteredMessagesTo property: Queue/Topic name to forward the Dead Letter message.

Parameters:

forwardDeadLetteredMessagesTo - the forwardDeadLetteredMessagesTo value to set.

Returns:

the SBSubscriptionInner object itself.

withForwardTo

public SBSubscriptionInner withForwardTo(String forwardTo)

Set the forwardTo property: Queue/Topic name to forward the messages.

Parameters:

forwardTo - the forwardTo value to set.

Returns:

the SBSubscriptionInner object itself.

withIsClientAffine

public SBSubscriptionInner withIsClientAffine(Boolean isClientAffine)

Set the isClientAffine property: Value that indicates whether the subscription has an affinity to the client id.

Parameters:

isClientAffine - the isClientAffine value to set.

Returns:

the SBSubscriptionInner object itself.

withLockDuration

public SBSubscriptionInner withLockDuration(Duration lockDuration)

Set the lockDuration property: ISO 8061 lock duration timespan for the subscription. The default value is 1 minute.

Parameters:

lockDuration - the lockDuration value to set.

Returns:

the SBSubscriptionInner object itself.

withMaxDeliveryCount

public SBSubscriptionInner withMaxDeliveryCount(Integer maxDeliveryCount)

Set the maxDeliveryCount property: Number of maximum deliveries.

Parameters:

maxDeliveryCount - the maxDeliveryCount value to set.

Returns:

the SBSubscriptionInner object itself.

withRequiresSession

public SBSubscriptionInner withRequiresSession(Boolean requiresSession)

Set the requiresSession property: Value indicating if a subscription supports the concept of sessions.

Parameters:

requiresSession - the requiresSession value to set.

Returns:

the SBSubscriptionInner object itself.

withStatus

public SBSubscriptionInner withStatus(EntityStatus status)

Set the status property: Enumerates the possible values for the status of a messaging entity.

Parameters:

status - the status value to set.

Returns:

the SBSubscriptionInner object itself.

Applies to