Interface PartnerTopic


public interface PartnerTopic
An immutable client-side representation of PartnerTopic.
  • 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.
    • location

      String location()
      Gets the location property: The geo-location where the resource lives.
      Returns:
      the location value.
    • tags

      Map<String,String> tags()
      Gets the tags property: Resource tags.
      Returns:
      the tags value.
    • systemData

      com.azure.core.management.SystemData systemData()
      Gets the systemData property: The system metadata relating to Partner Topic resource.
      Returns:
      the systemData value.
    • identity

      IdentityInfo identity()
      Gets the identity property: Identity information for the Partner Topic resource.
      Returns:
      the identity value.
    • partnerRegistrationImmutableId

      UUID partnerRegistrationImmutableId()
      Gets the partnerRegistrationImmutableId property: The immutableId of the corresponding partner registration.
      Returns:
      the partnerRegistrationImmutableId value.
    • source

      String source()
      Gets the source property: Source associated with this partner topic. This represents a unique partner resource.
      Returns:
      the source value.
    • eventTypeInfo

      EventTypeInfo eventTypeInfo()
      Gets the eventTypeInfo property: Event Type information from the corresponding event channel.
      Returns:
      the eventTypeInfo value.
    • expirationTimeIfNotActivatedUtc

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

      PartnerTopicProvisioningState provisioningState()
      Gets the provisioningState property: Provisioning state of the partner topic.
      Returns:
      the provisioningState value.
    • activationState

      PartnerTopicActivationState activationState()
      Gets the activationState property: Activation state of the partner topic.
      Returns:
      the activationState value.
    • partnerTopicFriendlyDescription

      String partnerTopicFriendlyDescription()
      Gets the partnerTopicFriendlyDescription property: Friendly description about the topic. This can be set by the publisher/partner to show custom description for the customer partner topic. This will be helpful to remove any ambiguity of the origin of creation of the partner topic for the customer.
      Returns:
      the partnerTopicFriendlyDescription 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.
    • region

      com.azure.core.management.Region region()
      Gets the region of the resource.
      Returns:
      the region of the resource.
    • regionName

      String regionName()
      Gets the name of the resource region.
      Returns:
      the name of the resource region.
    • resourceGroupName

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

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

      Begins update for the PartnerTopic resource.
      Returns:
      the stage of resource update.
    • refresh

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

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

      PartnerTopic activate()
      Activate a newly created partner topic.
      Returns:
      event Grid Partner 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.
    • activateWithResponse

      com.azure.core.http.rest.Response<PartnerTopic> activateWithResponse(com.azure.core.util.Context context)
      Activate a newly created partner topic.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      event Grid Partner 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.
    • deactivate

      PartnerTopic deactivate()
      Deactivate specific partner topic.
      Returns:
      event Grid Partner 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.
    • deactivateWithResponse

      com.azure.core.http.rest.Response<PartnerTopic> deactivateWithResponse(com.azure.core.util.Context context)
      Deactivate specific partner topic.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      event Grid Partner 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.