Package com.azure.resourcemanager.eventgrid.fluent.models

Class EventSubscriptionProperties

java.lang.Object
com.azure.resourcemanager.eventgrid.fluent.models.EventSubscriptionProperties
public final class EventSubscriptionProperties extends Object
Properties of the Event Subscription.

  • Constructor Details

    • EventSubscriptionProperties

      public EventSubscriptionProperties()

  • Method Details

    • topic

      public String topic()
      Get the topic property: Name of the topic of the event subscription.
      Returns:
      the topic value.

    • provisioningState

      public EventSubscriptionProvisioningState provisioningState()
      Get the provisioningState property: Provisioning state of the event subscription.
      Returns:
      the provisioningState 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.

    • withDestination

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

    • 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 / dead-lettering.
      Returns:
      the deliveryWithResourceIdentity value.

    • withDeliveryWithResourceIdentity

      public EventSubscriptionProperties 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 / dead-lettering.
      Parameters:
      deliveryWithResourceIdentity - the deliveryWithResourceIdentity value to set.
      Returns:
      the EventSubscriptionProperties object itself.

    • filter

      public EventSubscriptionFilter filter()
      Get the filter property: Information about the filter for the event subscription.
      Returns:
      the filter value.

    • withFilter

      public EventSubscriptionProperties withFilter(EventSubscriptionFilter filter)
      Set the filter property: Information about the filter for the event subscription.
      Parameters:
      filter - the filter value to set.
      Returns:
      the EventSubscriptionProperties object itself.

    • labels

      public List<String> labels()
      Get the labels property: List of user defined labels.
      Returns:
      the labels value.

    • withLabels

      public EventSubscriptionProperties withLabels(List<String> labels)
      Set the labels property: List of user defined labels.
      Parameters:
      labels - the labels value to set.
      Returns:
      the EventSubscriptionProperties object itself.

    • expirationTimeUtc

      public OffsetDateTime expirationTimeUtc()
      Get the expirationTimeUtc property: Expiration time of the event subscription.
      Returns:
      the expirationTimeUtc value.

    • withExpirationTimeUtc

      public EventSubscriptionProperties withExpirationTimeUtc(OffsetDateTime expirationTimeUtc)
      Set the expirationTimeUtc property: Expiration time of the event subscription.
      Parameters:
      expirationTimeUtc - the expirationTimeUtc value to set.
      Returns:
      the EventSubscriptionProperties object itself.

    • eventDeliverySchema

      public EventDeliverySchema eventDeliverySchema()
      Get the eventDeliverySchema property: The event delivery schema for the event subscription.
      Returns:
      the eventDeliverySchema value.

    • withEventDeliverySchema

      public EventSubscriptionProperties withEventDeliverySchema(EventDeliverySchema eventDeliverySchema)
      Set the eventDeliverySchema property: The event delivery schema for the event subscription.
      Parameters:
      eventDeliverySchema - the eventDeliverySchema value to set.
      Returns:
      the EventSubscriptionProperties object itself.

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

    • withRetryPolicy

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

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

    • withDeadLetterDestination

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

    • 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 (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering.
      Returns:
      the deadLetterWithResourceIdentity value.

    • withDeadLetterWithResourceIdentity

      public EventSubscriptionProperties 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 (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering.
      Parameters:
      deadLetterWithResourceIdentity - the deadLetterWithResourceIdentity value to set.
      Returns:
      the EventSubscriptionProperties object itself.

    • validate

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