Share via

EventSubscriptionUpdateParameters Class

Package:
com.microsoft.azure.management.eventgrid.v2020_04_01_preview
Maven Artifact:
com.microsoft.azure.eventgrid.v2020_04_01_preview:azure-mgmt-eventgrid:1.0.0-beta-3
  • java.lang.Object
    • com.microsoft.azure.management.eventgrid.v2020_04_01_preview.EventSubscriptionUpdateParameters

public class EventSubscriptionUpdateParameters

Properties of the Event Subscription update.

Constructor Summary

Constructor Description
EventSubscriptionUpdateParameters()

Method Summary

Modifier and Type Method and Description
DeadLetterDestination deadLetterDestination()

Get the dead letter destination of the event subscription.
DeadLetterWithResourceIdentity deadLetterWithResourceIdentity()

Get the dead letter destination of the event subscription.
DeliveryWithResourceIdentity deliveryWithResourceIdentity()

Get information about the destination where events have to be delivered for the event subscription.
EventSubscriptionDestination destination()

Get information about the destination where events have to be delivered for the event subscription.
EventDeliverySchema eventDeliverySchema()

Get the event delivery schema for the event subscription.
org.joda.time.DateTime expirationTimeUtc()

Get information about the expiration time for the event subscription.
EventSubscriptionFilter filter()

Get information about the filter for the event subscription.
java.util.List<java.lang.String> labels()

Get list of user defined labels.
RetryPolicy retryPolicy()

Get the retry policy for events.
EventSubscriptionUpdateParameters withDeadLetterDestination(DeadLetterDestination deadLetterDestination)

Set the dead letter destination of the event subscription.
EventSubscriptionUpdateParameters withDeadLetterWithResourceIdentity(DeadLetterWithResourceIdentity deadLetterWithResourceIdentity)

Set the dead letter destination of the event subscription.
EventSubscriptionUpdateParameters withDeliveryWithResourceIdentity(DeliveryWithResourceIdentity deliveryWithResourceIdentity)

Set information about the destination where events have to be delivered for the event subscription.
EventSubscriptionUpdateParameters withDestination(EventSubscriptionDestination destination)

Set information about the destination where events have to be delivered for the event subscription.
EventSubscriptionUpdateParameters withEventDeliverySchema(EventDeliverySchema eventDeliverySchema)

Set the event delivery schema for the event subscription.
EventSubscriptionUpdateParameters withExpirationTimeUtc(DateTime expirationTimeUtc)

Set information about the expiration time for the event subscription.
EventSubscriptionUpdateParameters withFilter(EventSubscriptionFilter filter)

Set information about the filter for the event subscription.
EventSubscriptionUpdateParameters withLabels(List<String> labels)

Set list of user defined labels.
EventSubscriptionUpdateParameters withRetryPolicy(RetryPolicy retryPolicy)

Set the retry policy for events.

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

EventSubscriptionUpdateParameters

public EventSubscriptionUpdateParameters()

Method Details

deadLetterDestination

public DeadLetterDestination deadLetterDestination()

Get 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 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 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 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 event delivery schema for the event subscription. Possible values include: 'EventGridSchema', 'CustomInputSchema', 'CloudEventSchemaV1_0'.

Returns:

the eventDeliverySchema value

expirationTimeUtc

public DateTime expirationTimeUtc()

Get information about the expiration time for the event subscription.

Returns:

the expirationTimeUtc value

filter

public EventSubscriptionFilter filter()

Get information about the filter for the event subscription.

Returns:

the filter value

labels

public List<String> labels()

Get list of user defined labels.

Returns:

the labels value

retryPolicy

public RetryPolicy retryPolicy()

Get 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

withDeadLetterDestination

public EventSubscriptionUpdateParameters withDeadLetterDestination(DeadLetterDestination deadLetterDestination)

Set 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 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 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 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 event delivery schema for the event subscription. Possible values include: 'EventGridSchema', 'CustomInputSchema', 'CloudEventSchemaV1_0'.

Parameters:

eventDeliverySchema - the eventDeliverySchema value to set

Returns:

the EventSubscriptionUpdateParameters object itself.

withExpirationTimeUtc

public EventSubscriptionUpdateParameters withExpirationTimeUtc(DateTime expirationTimeUtc)

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

Applies to