EventSubscriptionUpdateParameters Class

Package:

com.azure.resourcemanager.eventgrid.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-eventgrid:1.3.0-beta.1

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

Implements

JsonSerializable<EventSubscriptionUpdateParameters>

public final class EventSubscriptionUpdateParameters
implements JsonSerializable<EventSubscriptionUpdateParameters>

Properties of the Event Subscription update.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
DeadLetterDestination	deadLetterDestination() Get the deadLetterDestination property: The dead letter destination of the event subscription.
DeadLetterWithResourceIdentity	deadLetterWithResourceIdentity() Get the deadLetterWithResourceIdentity 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.
EventDeliverySchema	eventDeliverySchema() Get the eventDeliverySchema property: The event delivery schema for the event subscription.
OffsetDateTime	expirationTimeUtc() Get the expirationTimeUtc property: Information about the expiration time for the event subscription.
EventSubscriptionFilter	filter() Get the filter property: Information about the filter for the event subscription.
static EventSubscriptionUpdateParameters	fromJson(JsonReader jsonReader) Reads an instance of EventSubscriptionUpdateParameters from the JsonReader.
List<String>	labels() Get the labels property: List of user defined labels.
RetryPolicy	retryPolicy() Get the retryPolicy property: The retry policy for events.
JsonWriter	toJson(JsonWriter jsonWriter)
void	validate() Validates the instance.
EventSubscriptionUpdateParameters	withDeadLetterDestination(DeadLetterDestination deadLetterDestination) Set the deadLetterDestination property: The dead letter destination of the event subscription.
EventSubscriptionUpdateParameters	withDeadLetterWithResourceIdentity(DeadLetterWithResourceIdentity deadLetterWithResourceIdentity) Set the deadLetterWithResourceIdentity property: The dead letter destination of the event subscription.
EventSubscriptionUpdateParameters	withDeliveryWithResourceIdentity(DeliveryWithResourceIdentity deliveryWithResourceIdentity) Set the deliveryWithResourceIdentity property: Information about the destination where events have to be delivered for the event subscription.
EventSubscriptionUpdateParameters	withDestination(EventSubscriptionDestination destination) Set the destination property: Information about the destination where events have to be delivered for the event subscription.
EventSubscriptionUpdateParameters	withEventDeliverySchema(EventDeliverySchema eventDeliverySchema) Set the eventDeliverySchema property: The event delivery schema for the event subscription.
EventSubscriptionUpdateParameters	withExpirationTimeUtc(OffsetDateTime expirationTimeUtc) Set the expirationTimeUtc property: Information about the expiration time for the event subscription.
EventSubscriptionUpdateParameters	withFilter(EventSubscriptionFilter filter) Set the filter property: Information about the filter for the event subscription.
EventSubscriptionUpdateParameters	withLabels(List<String> labels) Set the labels property: List of user defined labels.
EventSubscriptionUpdateParameters	withRetryPolicy(RetryPolicy retryPolicy) Set the retryPolicy property: The retry policy for events.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

EventSubscriptionUpdateParameters

public EventSubscriptionUpdateParameters()

Creates an instance of EventSubscriptionUpdateParameters class.

Method Details

deadLetterDestination

public DeadLetterDestination deadLetterDestination()

Get the deadLetterDestination 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 Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering.

Returns:

the deadLetterDestination value.

deadLetterWithResourceIdentity

public DeadLetterWithResourceIdentity deadLetterWithResourceIdentity()

Get the deadLetterWithResourceIdentity 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 (topic / domain) to acquire the authentication tokens being used during delivery / dead-lettering.

Returns:

the deadLetterWithResourceIdentity 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 (topic / domain) to acquire the authentication tokens being used during delivery / dead-lettering.

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 / dead-lettering.

Returns:

the destination value.

eventDeliverySchema

public EventDeliverySchema eventDeliverySchema()

Get the eventDeliverySchema property: The event delivery schema for the event subscription.

Returns:

the eventDeliverySchema value.

expirationTimeUtc

public OffsetDateTime expirationTimeUtc()

Get the expirationTimeUtc property: Information about the expiration time for the event subscription.

Returns:

the expirationTimeUtc value.

filter

public EventSubscriptionFilter filter()

Get the filter property: Information about the filter for the event subscription.

Returns:

the filter value.

fromJson

public static EventSubscriptionUpdateParameters fromJson(JsonReader jsonReader)

Reads an instance of EventSubscriptionUpdateParameters from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

labels

public List<String> labels()

Get the labels property: List of user defined labels.

Returns:

the labels value.

retryPolicy

public RetryPolicy retryPolicy()

Get the retryPolicy property: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events.

Returns:

the retryPolicy value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

validate

public void validate()

Validates the instance.

withDeadLetterDestination

public EventSubscriptionUpdateParameters withDeadLetterDestination(DeadLetterDestination deadLetterDestination)

Set the deadLetterDestination 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 Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering.

Parameters:

deadLetterDestination - the deadLetterDestination value to set.

Returns:

the EventSubscriptionUpdateParameters object itself.

withDeadLetterWithResourceIdentity

public EventSubscriptionUpdateParameters withDeadLetterWithResourceIdentity(DeadLetterWithResourceIdentity deadLetterWithResourceIdentity)

Set the deadLetterWithResourceIdentity 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 (topic / domain) to acquire the authentication tokens being used during delivery / dead-lettering.

Parameters:

deadLetterWithResourceIdentity - the deadLetterWithResourceIdentity value to set.

Returns:

the EventSubscriptionUpdateParameters object itself.

withDeliveryWithResourceIdentity

public EventSubscriptionUpdateParameters 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 (topic / domain) to acquire the authentication tokens being used during delivery / dead-lettering.

Parameters:

deliveryWithResourceIdentity - the deliveryWithResourceIdentity value to set.

Returns:

the EventSubscriptionUpdateParameters object itself.

withDestination

public EventSubscriptionUpdateParameters 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 / dead-lettering.

Parameters:

destination - the destination value to set.

Returns:

the EventSubscriptionUpdateParameters object itself.

withEventDeliverySchema

public EventSubscriptionUpdateParameters withEventDeliverySchema(EventDeliverySchema eventDeliverySchema)

Set the eventDeliverySchema property: The event delivery schema for the event subscription.

Parameters:

eventDeliverySchema - the eventDeliverySchema value to set.

Returns:

the EventSubscriptionUpdateParameters object itself.

withExpirationTimeUtc

public EventSubscriptionUpdateParameters withExpirationTimeUtc(OffsetDateTime expirationTimeUtc)

Set the expirationTimeUtc property: Information about the expiration time for the event subscription.

Parameters:

expirationTimeUtc - the expirationTimeUtc value to set.

Returns:

the EventSubscriptionUpdateParameters object itself.

withFilter

public EventSubscriptionUpdateParameters withFilter(EventSubscriptionFilter filter)

Set the filter property: Information about the filter for the event subscription.

Parameters:

filter - the filter value to set.

Returns:

the EventSubscriptionUpdateParameters object itself.

withLabels

public EventSubscriptionUpdateParameters withLabels(List<String> labels)

Set the labels property: List of user defined labels.

Parameters:

labels - the labels value to set.

Returns:

the EventSubscriptionUpdateParameters object itself.

withRetryPolicy

public EventSubscriptionUpdateParameters withRetryPolicy(RetryPolicy retryPolicy)

Set the retryPolicy property: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events.

Parameters:

retryPolicy - the retryPolicy value to set.

Returns:

the EventSubscriptionUpdateParameters object itself.