Package com.azure.resourcemanager.eventgrid.models

Interface EventSubscription

public interface EventSubscription
An immutable client-side representation of EventSubscription.

  • Method Details

    • id

      String id()
      Gets the id property: Fully qualified resource Id for the resource.
      Returns:
      the id value.

    • name

      String name()
      Gets the name property: The name of the resource.
      Returns:
      the name value.

    • type

      String type()
      Gets the type property: The type of the resource.
      Returns:
      the type value.

    • systemData

      com.azure.core.management.SystemData systemData()
      Gets the systemData property: The system metadata relating to Event Subscription resource.
      Returns:
      the systemData value.

    • topic

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

    • provisioningState

      EventSubscriptionProvisioningState provisioningState()
      Gets the provisioningState property: Provisioning state of the event subscription.
      Returns:
      the provisioningState value.

    • destination

      EventSubscriptionDestination destination()
      Gets 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.

    • deliveryWithResourceIdentity

      DeliveryWithResourceIdentity deliveryWithResourceIdentity()
      Gets 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.

    • filter

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

    • labels

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

    • expirationTimeUtc

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

    • eventDeliverySchema

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

    • retryPolicy

      RetryPolicy retryPolicy()
      Gets 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.

    • deadLetterDestination

      DeadLetterDestination deadLetterDestination()
      Gets 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

      DeadLetterWithResourceIdentity deadLetterWithResourceIdentity()
      Gets 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.

    • resourceGroupName

      String resourceGroupName()
      Gets the name of the resource group.
      Returns:
      the name of the resource group.

    • innerModel

      EventSubscriptionInner innerModel()
      Gets the inner com.azure.resourcemanager.eventgrid.fluent.models.EventSubscriptionInner object.
      Returns:
      the inner object.

    • update

      EventSubscription.Update update()
      Begins update for the EventSubscription resource.
      Returns:
      the stage of resource update.

    • refresh

      EventSubscription refresh()
      Refreshes the resource to sync with Azure.
      Returns:
      the refreshed resource.

    • refresh

      EventSubscription refresh(com.azure.core.util.Context context)
      Refreshes the resource to sync with Azure.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the refreshed resource.

    • getDeliveryAttributes

      DeliveryAttributeListResult getDeliveryAttributes()
      Get all delivery attributes for an event subscription for topic.
      Returns:
      all delivery attributes for an event subscription for topic.
      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getDeliveryAttributesWithResponse

      com.azure.core.http.rest.Response<DeliveryAttributeListResult> getDeliveryAttributesWithResponse(com.azure.core.util.Context context)
      Get all delivery attributes for an event subscription for topic.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      all delivery attributes for an event subscription for topic along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getFullUrl

      EventSubscriptionFullUrl getFullUrl()
      Get the full endpoint URL for an event subscription for topic.
      Returns:
      the full endpoint URL for an event subscription for topic.
      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getFullUrlWithResponse

      com.azure.core.http.rest.Response<EventSubscriptionFullUrl> getFullUrlWithResponse(com.azure.core.util.Context context)
      Get the full endpoint URL for an event subscription for topic.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the full endpoint URL for an event subscription for topic along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.