Package com.azure.resourcemanager.servicebus.fluent.models

Class SBSubscriptionProperties

java.lang.Object
com.azure.resourcemanager.servicebus.fluent.models.SBSubscriptionProperties
All Implemented Interfaces:
com.azure.json.JsonSerializable<SBSubscriptionProperties>
public final class SBSubscriptionProperties extends Object implements com.azure.json.JsonSerializable<SBSubscriptionProperties>
Description of Subscription Resource.

  • Constructor Details

    • SBSubscriptionProperties

      public SBSubscriptionProperties()
      Creates an instance of SBSubscriptionProperties class.

  • Method Details

    • messageCount

      public Long messageCount()
      Get the messageCount property: Number of messages.
      Returns:
      the messageCount value.

    • createdAt

      public OffsetDateTime createdAt()
      Get the createdAt property: Exact time the message was created.
      Returns:
      the createdAt value.

    • accessedAt

      public OffsetDateTime accessedAt()
      Get the accessedAt property: Last time there was a receive request to this subscription.
      Returns:
      the accessedAt value.

    • updatedAt

      public OffsetDateTime updatedAt()
      Get the updatedAt property: The exact time the message was updated.
      Returns:
      the updatedAt value.

    • countDetails

      public MessageCountDetails countDetails()
      Get the countDetails property: Message count details.
      Returns:
      the countDetails 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.

    • withLockDuration

      public SBSubscriptionProperties 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 SBSubscriptionProperties object itself.

    • requiresSession

      public Boolean requiresSession()
      Get the requiresSession property: Value indicating if a subscription supports the concept of sessions.
      Returns:
      the requiresSession value.

    • withRequiresSession

      public SBSubscriptionProperties 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 SBSubscriptionProperties object itself.

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

    • withDefaultMessageTimeToLive

      public SBSubscriptionProperties 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 SBSubscriptionProperties object itself.

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

    • withDeadLetteringOnFilterEvaluationExceptions

      public SBSubscriptionProperties 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 SBSubscriptionProperties object itself.

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

    • withDeadLetteringOnMessageExpiration

      public SBSubscriptionProperties 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 SBSubscriptionProperties object itself.

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

    • withDuplicateDetectionHistoryTimeWindow

      public SBSubscriptionProperties 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 SBSubscriptionProperties object itself.

    • maxDeliveryCount

      public Integer maxDeliveryCount()
      Get the maxDeliveryCount property: Number of maximum deliveries.
      Returns:
      the maxDeliveryCount value.

    • withMaxDeliveryCount

      public SBSubscriptionProperties withMaxDeliveryCount(Integer maxDeliveryCount)
      Set the maxDeliveryCount property: Number of maximum deliveries.
      Parameters:
      maxDeliveryCount - the maxDeliveryCount value to set.
      Returns:
      the SBSubscriptionProperties object itself.

    • status

      public EntityStatus status()
      Get the status property: Enumerates the possible values for the status of a messaging entity.
      Returns:
      the status value.

    • withStatus

      public SBSubscriptionProperties 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 SBSubscriptionProperties object itself.

    • enableBatchedOperations

      public Boolean enableBatchedOperations()
      Get the enableBatchedOperations property: Value that indicates whether server-side batched operations are enabled.
      Returns:
      the enableBatchedOperations value.

    • withEnableBatchedOperations

      public SBSubscriptionProperties 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 SBSubscriptionProperties object itself.

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

    • withAutoDeleteOnIdle

      public SBSubscriptionProperties 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 SBSubscriptionProperties object itself.

    • forwardTo

      public String forwardTo()
      Get the forwardTo property: Queue/Topic name to forward the messages.
      Returns:
      the forwardTo value.

    • withForwardTo

      public SBSubscriptionProperties withForwardTo(String forwardTo)
      Set the forwardTo property: Queue/Topic name to forward the messages.
      Parameters:
      forwardTo - the forwardTo value to set.
      Returns:
      the SBSubscriptionProperties object itself.

    • forwardDeadLetteredMessagesTo

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

    • withForwardDeadLetteredMessagesTo

      public SBSubscriptionProperties 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 SBSubscriptionProperties object itself.

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

    • withIsClientAffine

      public SBSubscriptionProperties 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 SBSubscriptionProperties object itself.

    • clientAffineProperties

      public SBClientAffineProperties clientAffineProperties()
      Get the clientAffineProperties property: Properties specific to client affine subscriptions.
      Returns:
      the clientAffineProperties value.

    • withClientAffineProperties

      public SBSubscriptionProperties withClientAffineProperties(SBClientAffineProperties clientAffineProperties)
      Set the clientAffineProperties property: Properties specific to client affine subscriptions.
      Parameters:
      clientAffineProperties - the clientAffineProperties value to set.
      Returns:
      the SBSubscriptionProperties object itself.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<SBSubscriptionProperties>
      Throws:
      IOException

    • fromJson

      public static SBSubscriptionProperties fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of SBSubscriptionProperties from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of SBSubscriptionProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IOException - If an error occurs while reading the SBSubscriptionProperties.