PushInfo Class

Package:

com.azure.resourcemanager.eventgrid.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-eventgrid:1.2.0

• java.lang.Object
• • com.azure.resourcemanager.eventgrid.models.PushInfo

Implements

JsonSerializable<PushInfo>

public final class PushInfo
implements JsonSerializable<PushInfo>

Properties of the destination info for event subscription supporting push.

Constructor Summary

Constructor	Description
PushInfo()	Creates an instance of PushInfo class.

Method Summary

Modifier and Type	Method and Description
DeadLetterWithResourceIdentity	deadLetterDestinationWithResourceIdentity() Get the deadLetterDestinationWithResourceIdentity property: The dead letter destination of the event subscription.
DeliveryWithResourceIdentity	deliveryWithResourceIdentity() Get the deliveryWithResourceIdentity property: Information about the destination where events have to be delivered for the event subscription.
EventSubscriptionDestination	destination() Get the destination property: Information about the destination where events have to be delivered for the event subscription.
String	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.
static PushInfo	fromJson(JsonReader jsonReader) Reads an instance of PushInfo from the JsonReader.
Integer	maxDeliveryCount() Get the maxDeliveryCount property: The maximum delivery count of the events.
JsonWriter	toJson(JsonWriter jsonWriter)
void	validate() Validates the instance.
PushInfo	withDeadLetterDestinationWithResourceIdentity(DeadLetterWithResourceIdentity deadLetterDestinationWithResourceIdentity) Set the deadLetterDestinationWithResourceIdentity property: The dead letter destination of the event subscription.
PushInfo	withDeliveryWithResourceIdentity(DeliveryWithResourceIdentity deliveryWithResourceIdentity) Set the deliveryWithResourceIdentity property: Information about the destination where events have to be delivered for the event subscription.
PushInfo	withDestination(EventSubscriptionDestination destination) Set the destination property: Information about the destination where events have to be delivered for the event subscription.
PushInfo	withEventTimeToLive(String 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.
PushInfo	withMaxDeliveryCount(Integer maxDeliveryCount) Set the maxDeliveryCount property: The maximum delivery count of the events.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

PushInfo

public PushInfo()

Creates an instance of PushInfo 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, namespace) to acquire the authentication tokens being used during dead-lettering.

Returns:

the deadLetterDestinationWithResourceIdentity value.

deliveryWithResourceIdentity

public DeliveryWithResourceIdentity deliveryWithResourceIdentity()

Get the deliveryWithResourceIdentity property: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery.

Returns:

the deliveryWithResourceIdentity value.

destination

public EventSubscriptionDestination destination()

Get the destination property: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery.

Returns:

the destination value.

eventTimeToLive

public String 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:

the eventTimeToLive value.

fromJson

public static PushInfo fromJson(JsonReader jsonReader)

Reads an instance of PushInfo from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of PushInfo 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 PushInfo.

maxDeliveryCount

public Integer maxDeliveryCount()

Get the maxDeliveryCount property: The maximum delivery count of the events.

Returns:

the maxDeliveryCount value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

validate

public void validate()

Validates the instance.

withDeadLetterDestinationWithResourceIdentity

public PushInfo 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, namespace) to acquire the authentication tokens being used during dead-lettering.

Parameters:

deadLetterDestinationWithResourceIdentity - the deadLetterDestinationWithResourceIdentity value to set.

Returns:

the PushInfo object itself.

withDeliveryWithResourceIdentity

public PushInfo withDeliveryWithResourceIdentity(DeliveryWithResourceIdentity deliveryWithResourceIdentity)

Set the deliveryWithResourceIdentity property: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery.

Parameters:

deliveryWithResourceIdentity - the deliveryWithResourceIdentity value to set.

Returns:

the PushInfo object itself.

withDestination

public PushInfo withDestination(EventSubscriptionDestination destination)

Set the destination property: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery.

Parameters:

destination - the destination value to set.

Returns:

the PushInfo object itself.

withEventTimeToLive

public PushInfo withEventTimeToLive(String 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:

eventTimeToLive - the eventTimeToLive value to set.

Returns:

the PushInfo object itself.

withMaxDeliveryCount

public PushInfo withMaxDeliveryCount(Integer maxDeliveryCount)

Set the maxDeliveryCount property: The maximum delivery count of the events.

Parameters:

maxDeliveryCount - the maxDeliveryCount value to set.

Returns:

the PushInfo object itself.