ChannelInner Class

public final class ChannelInner
extends ProxyResource

Channel info.

Constructor Summary

Constructor Description
ChannelInner()

Creates an instance of ChannelInner class.

Method Summary

Modifier and Type Method and Description
ChannelType channelType()

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

OffsetDateTime expirationTimeIfNotActivatedUtc()

Get the expirationTimeIfNotActivatedUtc property: Expiration time of the channel.

static ChannelInner fromJson(JsonReader jsonReader)

Reads an instance of ChannelInner from the JsonReader.

String id()

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

String messageForActivation()

Get the messageForActivation property: Context or helpful message that can be used during the approval process by the subscriber.

String name()

Get the name property: The name of the resource.

PartnerTopicInfo partnerTopicInfo()

Get the partnerTopicInfo property: This property should be populated when channelType is PartnerTopic and represents information about the partner topic resource corresponding to the channel.

ChannelProvisioningState provisioningState()

Get the provisioningState property: Provisioning state of the channel.

ReadinessState readinessState()

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

SystemData systemData()

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

JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: The type of the resource.

void validate()

Validates the instance.

ChannelInner withChannelType(ChannelType channelType)

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

ChannelInner withExpirationTimeIfNotActivatedUtc(OffsetDateTime expirationTimeIfNotActivatedUtc)

Set the expirationTimeIfNotActivatedUtc property: Expiration time of the channel.

ChannelInner withMessageForActivation(String messageForActivation)

Set the messageForActivation property: Context or helpful message that can be used during the approval process by the subscriber.

ChannelInner withPartnerTopicInfo(PartnerTopicInfo partnerTopicInfo)

Set the partnerTopicInfo property: This property should be populated when channelType is PartnerTopic and represents information about the partner topic resource corresponding to the channel.

ChannelInner withProvisioningState(ChannelProvisioningState provisioningState)

Set the provisioningState property: Provisioning state of the channel.

ChannelInner withReadinessState(ReadinessState readinessState)

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

Methods inherited from ProxyResource

Methods inherited from java.lang.Object

Constructor Details

ChannelInner

public ChannelInner()

Creates an instance of ChannelInner class.

Method Details

channelType

public ChannelType channelType()

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

Returns:

the channelType value.

expirationTimeIfNotActivatedUtc

public OffsetDateTime expirationTimeIfNotActivatedUtc()

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

fromJson

public static ChannelInner fromJson(JsonReader jsonReader)

Reads an instance of ChannelInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ChannelInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

id

public String id()

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

Overrides:

ChannelInner.id()

Returns:

the id value.

messageForActivation

public String messageForActivation()

Get the messageForActivation property: Context or helpful message that can be used during the approval process by the subscriber.

Returns:

the messageForActivation value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

ChannelInner.name()

Returns:

the name value.

partnerTopicInfo

public PartnerTopicInfo partnerTopicInfo()

Get 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 ChannelProvisioningState provisioningState()

Get the provisioningState property: Provisioning state of the channel.

Returns:

the provisioningState value.

readinessState

public ReadinessState readinessState()

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

Returns:

the readinessState value.

systemData

public SystemData systemData()

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

Returns:

the systemData value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

ChannelInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: The type of the resource.

Overrides:

ChannelInner.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

withChannelType

public ChannelInner withChannelType(ChannelType channelType)

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

Parameters:

channelType - the channelType value to set.

Returns:

the ChannelInner object itself.

withExpirationTimeIfNotActivatedUtc

public ChannelInner withExpirationTimeIfNotActivatedUtc(OffsetDateTime expirationTimeIfNotActivatedUtc)

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

Parameters:

expirationTimeIfNotActivatedUtc - the expirationTimeIfNotActivatedUtc value to set.

Returns:

the ChannelInner object itself.

withMessageForActivation

public ChannelInner withMessageForActivation(String messageForActivation)

Set the messageForActivation property: Context or helpful message that can be used during the approval process by the subscriber.

Parameters:

messageForActivation - the messageForActivation value to set.

Returns:

the ChannelInner object itself.

withPartnerTopicInfo

public ChannelInner withPartnerTopicInfo(PartnerTopicInfo partnerTopicInfo)

Set the partnerTopicInfo property: This property should be populated when channelType is PartnerTopic and represents information about the partner topic resource corresponding to the channel.

Parameters:

partnerTopicInfo - the partnerTopicInfo value to set.

Returns:

the ChannelInner object itself.

withProvisioningState

public ChannelInner withProvisioningState(ChannelProvisioningState provisioningState)

Set the provisioningState property: Provisioning state of the channel.

Parameters:

provisioningState - the provisioningState value to set.

Returns:

the ChannelInner object itself.

withReadinessState

public ChannelInner withReadinessState(ReadinessState readinessState)

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

Parameters:

readinessState - the readinessState value to set.

Returns:

the ChannelInner object itself.

Applies to