PartnerTopic Interface

Package:

com.azure.resourcemanager.eventgrid.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-eventgrid:1.3.0-beta.1

public interface PartnerTopic

An immutable client-side representation of PartnerTopic.

Method Summary

Modifier and Type	Method and Description
abstract PartnerTopic	activate() Activate a partner topic.
abstract Response<PartnerTopic>	activateWithResponse(Context context) Activate a partner topic.
abstract PartnerTopicActivationState	activationState() Gets the activationState property: Activation state of the partner topic.
abstract PartnerTopic	deactivate() Deactivate a partner topic.
abstract Response<PartnerTopic>	deactivateWithResponse(Context context) Deactivate a partner topic.
abstract EventTypeInfo	eventTypeInfo() Gets the eventTypeInfo property: Event Type information from the corresponding event channel.
abstract OffsetDateTime	expirationTimeIfNotActivatedUtc() Gets the expirationTimeIfNotActivatedUtc property: Expiration time of the partner topic.
abstract String	id() Gets the id property: Fully qualified resource Id for the resource.
abstract IdentityInfo	identity() Gets the identity property: Identity information for the Partner Topic resource.
abstract PartnerTopicInner	innerModel() Gets the inner com.azure.resourcemanager.eventgrid.fluent.models.PartnerTopicInner object.
abstract String	location() Gets the location property: The geo-location where the resource lives.
abstract String	messageForActivation() Gets the messageForActivation property: Context or helpful message that can be used during the approval process by the subscriber.
abstract String	name() Gets the name property: The name of the resource.
abstract UUID	partnerRegistrationImmutableId() Gets the partnerRegistrationImmutableId property: The immutableId of the corresponding partner registration.
abstract String	partnerTopicFriendlyDescription() Gets the partnerTopicFriendlyDescription property: Friendly description about the topic.
abstract PartnerTopicProvisioningState	provisioningState() Gets the provisioningState property: Provisioning state of the partner topic.
abstract PartnerTopic	refresh() Refreshes the resource to sync with Azure.
abstract PartnerTopic	refresh(Context context) Refreshes the resource to sync with Azure.
abstract Region	region() Gets the region of the resource.
abstract String	regionName() Gets the name of the resource region.
abstract String	resourceGroupName() Gets the name of the resource group.
abstract String	source() Gets the source property: Source associated with this partner topic.
abstract SystemData	systemData() Gets the systemData property: The system metadata relating to the Event Grid resource.
abstract Map<String,String>	tags() Gets the tags property: Resource tags.
abstract String	type() Gets the type property: The type of the resource.
abstract Update	update() Begins update for the PartnerTopic resource.

Method Details

activate

public abstract PartnerTopic activate()

Activate a partner topic. Activate a newly created partner topic.

Returns:

event Grid Partner Topic.

activateWithResponse

public abstract Response<PartnerTopic> activateWithResponse(Context context)

Activate a partner topic. Activate a newly created partner topic.

Parameters:

context - The context to associate with this operation.

Returns:

event Grid Partner Topic along with Response<T>.

activationState

public abstract PartnerTopicActivationState activationState()

Gets the activationState property: Activation state of the partner topic.

Returns:

the activationState value.

deactivate

public abstract PartnerTopic deactivate()

Deactivate a partner topic. Deactivate specific partner topic.

Returns:

event Grid Partner Topic.

deactivateWithResponse

public abstract Response<PartnerTopic> deactivateWithResponse(Context context)

Deactivate a partner topic. Deactivate specific partner topic.

Parameters:

context - The context to associate with this operation.

Returns:

event Grid Partner Topic along with Response<T>.

eventTypeInfo

public abstract EventTypeInfo eventTypeInfo()

Gets the eventTypeInfo property: Event Type information from the corresponding event channel.

Returns:

the eventTypeInfo value.

expirationTimeIfNotActivatedUtc

public abstract 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.

id

public abstract String id()

Gets the id property: Fully qualified resource Id for the resource.

Returns:

the id value.

identity

public abstract IdentityInfo identity()

Gets the identity property: Identity information for the Partner Topic resource.

Returns:

the identity value.

innerModel

public abstract PartnerTopicInner innerModel()

Gets the inner com.azure.resourcemanager.eventgrid.fluent.models.PartnerTopicInner object.

Returns:

the inner object.

location

public abstract String location()

Gets the location property: The geo-location where the resource lives.

Returns:

the location value.

messageForActivation

public abstract 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.

name

public abstract String name()

Gets the name property: The name of the resource.

Returns:

the name value.

partnerRegistrationImmutableId

public abstract UUID partnerRegistrationImmutableId()

Gets the partnerRegistrationImmutableId property: The immutableId of the corresponding partner registration.

Returns:

the partnerRegistrationImmutableId value.

partnerTopicFriendlyDescription

public abstract 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.

provisioningState

public abstract PartnerTopicProvisioningState provisioningState()

Gets the provisioningState property: Provisioning state of the partner topic.

Returns:

the provisioningState value.

refresh

public abstract PartnerTopic refresh()

Refreshes the resource to sync with Azure.

Returns:

the refreshed resource.

refresh

public abstract PartnerTopic refresh(Context context)

Refreshes the resource to sync with Azure.

Parameters:

context - The context to associate with this operation.

Returns:

the refreshed resource.

region

public abstract Region region()

Gets the region of the resource.

Returns:

the region of the resource.

regionName

public abstract String regionName()

Gets the name of the resource region.

Returns:

the name of the resource region.

resourceGroupName

public abstract String resourceGroupName()

Gets the name of the resource group.

Returns:

the name of the resource group.

source

public abstract String source()

Gets the source property: Source associated with this partner topic. This represents a unique partner resource.

Returns:

the source value.

systemData

public abstract SystemData systemData()

Gets the systemData property: The system metadata relating to the Event Grid resource.

Returns:

the systemData value.

tags

public abstract Map<String,String> tags()

Gets the tags property: Resource tags.

Returns:

the tags value.

type

public abstract String type()

Gets the type property: The type of the resource.

Returns:

the type value.

update

public abstract PartnerTopic.Update update()

Begins update for the PartnerTopic resource.

Returns:

the stage of resource update.