Package com.azure.resourcemanager.eventgrid.models

Interface Channel

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

  • 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 Channel resource.
      Returns:
      the systemData value.

    • channelType

      ChannelType channelType()
      Gets the channelType property: The type of the event channel which represents the direction flow of events.
      Returns:
      the channelType value.

    • partnerTopicInfo

      PartnerTopicInfo partnerTopicInfo()
      Gets the partnerTopicInfo property: This property should be populated when channelType is PartnerTopic and represents information about the partner topic resource corresponding to the channel.
      Returns:
      the partnerTopicInfo value.

    • messageForActivation

      String messageForActivation()
      Gets the messageForActivation property: Context or helpful message that can be used during the approval process by the subscriber.
      Returns:
      the messageForActivation value.

    • provisioningState

      ChannelProvisioningState provisioningState()
      Gets the provisioningState property: Provisioning state of the channel.
      Returns:
      the provisioningState value.

    • readinessState

      ReadinessState readinessState()
      Gets the readinessState property: The readiness state of the corresponding partner topic.
      Returns:
      the readinessState value.

    • expirationTimeIfNotActivatedUtc

      OffsetDateTime expirationTimeIfNotActivatedUtc()
      Gets the expirationTimeIfNotActivatedUtc property: Expiration time of the channel. If this timer expires while the corresponding partner topic is never activated, the channel and corresponding partner topic are deleted.
      Returns:
      the expirationTimeIfNotActivatedUtc value.

    • resourceGroupName

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

    • innerModel

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

    • update

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

    • refresh

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

    • refresh

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

    • getFullUrl

      EventSubscriptionFullUrl getFullUrl()
      Get the full endpoint URL of a partner destination channel.
      Returns:
      the full endpoint URL of a partner destination channel.
      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 of a partner destination channel.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the full endpoint URL of a partner destination channel 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.