Channel Interface

Package:

com.azure.resourcemanager.eventgrid.models

Maven Artifact:

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

public interface Channel

An immutable client-side representation of Channel.

Method Summary

Modifier and Type	Method and Description
abstract ChannelType	channelType() Gets the channelType property: The type of the event channel which represents the direction flow of events.
abstract OffsetDateTime	expirationTimeIfNotActivatedUtc() Gets the expirationTimeIfNotActivatedUtc property: Expiration time of the channel.
abstract EventSubscriptionFullUrl	getFullUrl() Get full URL of partner destination channel.
abstract Response<EventSubscriptionFullUrl>	getFullUrlWithResponse(Context context) Get full URL of partner destination channel.
abstract String	id() Gets the id property: Fully qualified resource Id for the resource.
abstract ChannelInner	innerModel() Gets the inner com.azure.resourcemanager.eventgrid.fluent.models.ChannelInner object.
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 PartnerDestinationInfo	partnerDestinationInfo() Gets the partnerDestinationInfo property: This property should be populated when channelType is PartnerDestination and represents information about the partner destination resource corresponding to the channel.
abstract 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.
abstract ChannelProvisioningState	provisioningState() Gets the provisioningState property: Provisioning state of the channel.
abstract ReadinessState	readinessState() Gets the readinessState property: The readiness state of the corresponding partner topic.
abstract Channel	refresh() Refreshes the resource to sync with Azure.
abstract Channel	refresh(Context context) Refreshes the resource to sync with Azure.
abstract String	resourceGroupName() Gets the name of the resource group.
abstract SystemData	systemData() Gets the systemData property: The system metadata relating to the Event Grid resource.
abstract String	type() Gets the type property: The type of the resource.
abstract Update	update() Begins update for the Channel resource.

Method Details

channelType

public abstract ChannelType channelType()

Gets the channelType property: The type of the event channel which represents the direction flow of events.

Returns:

the channelType value.

expirationTimeIfNotActivatedUtc

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

getFullUrl

public abstract EventSubscriptionFullUrl getFullUrl()

Get full URL of partner destination channel. Get the full endpoint URL of a partner destination channel.

Returns:

the full endpoint URL of a partner destination channel.

getFullUrlWithResponse

public abstract Response<EventSubscriptionFullUrl> getFullUrlWithResponse(Context context)

Get full URL of partner destination channel. 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<T>.

id

public abstract String id()

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

Returns:

the id value.

innerModel

public abstract ChannelInner innerModel()

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

Returns:

the inner object.

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.

partnerDestinationInfo

public abstract PartnerDestinationInfo partnerDestinationInfo()

Gets the partnerDestinationInfo property: This property should be populated when channelType is PartnerDestination and represents information about the partner destination resource corresponding to the channel.

Returns:

the partnerDestinationInfo value.

partnerTopicInfo

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

provisioningState

public abstract ChannelProvisioningState provisioningState()

Gets the provisioningState property: Provisioning state of the channel.

Returns:

the provisioningState value.

readinessState

public abstract ReadinessState readinessState()

Gets the readinessState property: The readiness state of the corresponding partner topic.

Returns:

the readinessState value.

refresh

public abstract Channel refresh()

Refreshes the resource to sync with Azure.

Returns:

the refreshed resource.

refresh

public abstract Channel refresh(Context context)

Refreshes the resource to sync with Azure.

Parameters:

context - The context to associate with this operation.

Returns:

the refreshed resource.

resourceGroupName

public abstract String resourceGroupName()

Gets the name of the resource group.

Returns:

the name of the resource group.

systemData

public abstract SystemData systemData()

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

Returns:

the systemData value.

type

public abstract String type()

Gets the type property: The type of the resource.

Returns:

the type value.

update

public abstract Channel.Update update()

Begins update for the Channel resource.

Returns:

the stage of resource update.