QueueInfo Class
- java.
lang. Object - com.
azure. resourcemanager. eventgrid. models. QueueInfo
- com.
Implements
public final class QueueInfo
implements JsonSerializable<QueueInfo>
Properties of the Queue info for event subscription.
Constructor Summary
| Constructor | Description |
|---|---|
| QueueInfo() |
Creates an instance of Queue |
Method Summary
| Modifier and Type | Method and Description |
|---|---|
|
Dead |
deadLetterDestinationWithResourceIdentity()
Get the dead |
| Duration |
eventTimeToLive()
Get the event |
|
static
Queue |
fromJson(JsonReader jsonReader)
Reads an instance of Queue |
| Integer |
maxDeliveryCount()
Get the max |
| Integer |
receiveLockDurationInSeconds()
Get the receive |
|
Json |
toJson(JsonWriter jsonWriter) |
| void |
validate()
Validates the instance. |
|
Queue |
withDeadLetterDestinationWithResourceIdentity(DeadLetterWithResourceIdentity deadLetterDestinationWithResourceIdentity)
Set the dead |
|
Queue |
withEventTimeToLive(Duration eventTimeToLive)
Set the event |
|
Queue |
withMaxDeliveryCount(Integer maxDeliveryCount)
Set the max |
|
Queue |
withReceiveLockDurationInSeconds(Integer receiveLockDurationInSeconds)
Set the receive |
Methods inherited from java.lang.Object
Constructor Details
QueueInfo
public QueueInfo()
Creates an instance of QueueInfo class.
Method Details
deadLetterDestinationWithResourceIdentity
public DeadLetterWithResourceIdentity deadLetterDestinationWithResourceIdentity()
Get the deadLetterDestinationWithResourceIdentity property: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic) to acquire the authentication tokens being used during delivery / dead-lettering.
Returns:
eventTimeToLive
public Duration eventTimeToLive()
Get the eventTimeToLive property: Time span duration in ISO 8601 format that determines how long messages are available to the subscription from the time the message was published. This duration value is expressed using the following format: \'P(n)Y(n)M(n)DT(n)H(n)M(n)S\', where: - (n) is replaced by the value of each time element that follows the (n). - P is the duration (or Period) designator and is always placed at the beginning of the duration. - Y is the year designator, and it follows the value for the number of years. - M is the month designator, and it follows the value for the number of months. - W is the week designator, and it follows the value for the number of weeks. - D is the day designator, and it follows the value for the number of days. - T is the time designator, and it precedes the time components. - H is the hour designator, and it follows the value for the number of hours. - M is the minute designator, and it follows the value for the number of minutes. - S is the second designator, and it follows the value for the number of seconds. This duration value cannot be set greater than the topic’s EventRetentionInDays. It is is an optional field where its minimum value is 1 minute, and its maximum is determined by topic’s EventRetentionInDays value. The followings are examples of valid values: - \'P0DT23H12M\' or \'PT23H12M\': for duration of 23 hours and 12 minutes. - \'P1D\' or \'P1DT0H0M0S\': for duration of 1 day.
Returns:
fromJson
public static QueueInfo fromJson(JsonReader jsonReader)
Reads an instance of QueueInfo from the JsonReader.
Parameters:
Returns:
Throws:
maxDeliveryCount
public Integer maxDeliveryCount()
Get the maxDeliveryCount property: The maximum delivery count of the events.
Returns:
receiveLockDurationInSeconds
public Integer receiveLockDurationInSeconds()
Get the receiveLockDurationInSeconds property: Maximum period in seconds in which once the message is in received (by the client) state and waiting to be accepted, released or rejected. If this time elapsed after a message has been received by the client and not transitioned into accepted (not processed), released or rejected, the message is available for redelivery. This is an optional field, where default is 60 seconds, minimum is 60 seconds and maximum is 300 seconds.
Returns:
toJson
validate
public void validate()
Validates the instance.
withDeadLetterDestinationWithResourceIdentity
public QueueInfo withDeadLetterDestinationWithResourceIdentity(DeadLetterWithResourceIdentity deadLetterDestinationWithResourceIdentity)
Set the deadLetterDestinationWithResourceIdentity property: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic) to acquire the authentication tokens being used during delivery / dead-lettering.
Parameters:
Returns:
withEventTimeToLive
public QueueInfo withEventTimeToLive(Duration eventTimeToLive)
Set the eventTimeToLive property: Time span duration in ISO 8601 format that determines how long messages are available to the subscription from the time the message was published. This duration value is expressed using the following format: \'P(n)Y(n)M(n)DT(n)H(n)M(n)S\', where: - (n) is replaced by the value of each time element that follows the (n). - P is the duration (or Period) designator and is always placed at the beginning of the duration. - Y is the year designator, and it follows the value for the number of years. - M is the month designator, and it follows the value for the number of months. - W is the week designator, and it follows the value for the number of weeks. - D is the day designator, and it follows the value for the number of days. - T is the time designator, and it precedes the time components. - H is the hour designator, and it follows the value for the number of hours. - M is the minute designator, and it follows the value for the number of minutes. - S is the second designator, and it follows the value for the number of seconds. This duration value cannot be set greater than the topic’s EventRetentionInDays. It is is an optional field where its minimum value is 1 minute, and its maximum is determined by topic’s EventRetentionInDays value. The followings are examples of valid values: - \'P0DT23H12M\' or \'PT23H12M\': for duration of 23 hours and 12 minutes. - \'P1D\' or \'P1DT0H0M0S\': for duration of 1 day.
Parameters:
Returns:
withMaxDeliveryCount
public QueueInfo withMaxDeliveryCount(Integer maxDeliveryCount)
Set the maxDeliveryCount property: The maximum delivery count of the events.
Parameters:
Returns:
withReceiveLockDurationInSeconds
public QueueInfo withReceiveLockDurationInSeconds(Integer receiveLockDurationInSeconds)
Set the receiveLockDurationInSeconds property: Maximum period in seconds in which once the message is in received (by the client) state and waiting to be accepted, released or rejected. If this time elapsed after a message has been received by the client and not transitioned into accepted (not processed), released or rejected, the message is available for redelivery. This is an optional field, where default is 60 seconds, minimum is 60 seconds and maximum is 300 seconds.
Parameters:
Returns:
