TopicInner Class

Package:

com.azure.resourcemanager.eventgrid.fluent.models

Maven Artifact:

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

• java.lang.Object
• • com.azure.core.management.ProxyResource
  • • com.azure.core.management.Resource
    • • com.azure.resourcemanager.eventgrid.fluent.models.TopicInner

public final class TopicInner
extends Resource

EventGrid Topic.

Constructor Summary

Constructor	Description
TopicInner()	Creates an instance of TopicInner class.

Method Summary

Modifier and Type	Method and Description
DataResidencyBoundary	dataResidencyBoundary() Get the dataResidencyBoundary property: Data Residency Boundary of the resource.
Boolean	disableLocalAuth() Get the disableLocalAuth property: This boolean is used to enable or disable local auth.
String	endpoint() Get the endpoint property: Endpoint for the topic.
EventTypeInfo	eventTypeInfo() Get the eventTypeInfo property: Event Type Information for the user topic.
ExtendedLocation	extendedLocation() Get the extendedLocation property: Extended location of the resource.
static TopicInner	fromJson(JsonReader jsonReader) Reads an instance of TopicInner from the JsonReader.
String	id() Get the id property: Fully qualified resource Id for the resource.
IdentityInfo	identity() Get the identity property: Identity information for the resource.
List<InboundIpRule>	inboundIpRules() Get the inboundIpRules property: This can be used to restrict traffic from specific IPs instead of all IPs.
InputSchema	inputSchema() Get the inputSchema property: This determines the format that Event Grid should expect for incoming events published to the topic.
InputSchemaMapping	inputSchemaMapping() Get the inputSchemaMapping property: This enables publishing using custom event schemas.
ResourceKind	kind() Get the kind property: Kind of the resource.
String	metricResourceId() Get the metricResourceId property: Metric resource id for the topic.
TlsVersion	minimumTlsVersionAllowed() Get the minimumTlsVersionAllowed property: Minimum TLS version of the publisher allowed to publish to this topic.
String	name() Get the name property: The name of the resource.
List<PrivateEndpointConnectionInner>	privateEndpointConnections() Get the privateEndpointConnections property: List of private endpoint connections.
TopicProvisioningState	provisioningState() Get the provisioningState property: Provisioning state of the topic.
PublicNetworkAccess	publicNetworkAccess() Get the publicNetworkAccess property: This determines if traffic is allowed over public network.
ResourceSku	sku() Get the sku property: The Sku pricing tier for the 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.
TopicInner	withDataResidencyBoundary(DataResidencyBoundary dataResidencyBoundary) Set the dataResidencyBoundary property: Data Residency Boundary of the resource.
TopicInner	withDisableLocalAuth(Boolean disableLocalAuth) Set the disableLocalAuth property: This boolean is used to enable or disable local auth.
TopicInner	withEventTypeInfo(EventTypeInfo eventTypeInfo) Set the eventTypeInfo property: Event Type Information for the user topic.
TopicInner	withExtendedLocation(ExtendedLocation extendedLocation) Set the extendedLocation property: Extended location of the resource.
TopicInner	withIdentity(IdentityInfo identity) Set the identity property: Identity information for the resource.
TopicInner	withInboundIpRules(List<InboundIpRule> inboundIpRules) Set the inboundIpRules property: This can be used to restrict traffic from specific IPs instead of all IPs.
TopicInner	withInputSchema(InputSchema inputSchema) Set the inputSchema property: This determines the format that Event Grid should expect for incoming events published to the topic.
TopicInner	withInputSchemaMapping(InputSchemaMapping inputSchemaMapping) Set the inputSchemaMapping property: This enables publishing using custom event schemas.
TopicInner	withKind(ResourceKind kind) Set the kind property: Kind of the resource.
TopicInner	withLocation(String location)
TopicInner	withMinimumTlsVersionAllowed(TlsVersion minimumTlsVersionAllowed) Set the minimumTlsVersionAllowed property: Minimum TLS version of the publisher allowed to publish to this topic.
TopicInner	withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess) Set the publicNetworkAccess property: This determines if traffic is allowed over public network.
TopicInner	withSku(ResourceSku sku) Set the sku property: The Sku pricing tier for the topic.
TopicInner	withTags(Map<String,String> tags)

Methods inherited from ProxyResource

id name type

Methods inherited from Resource

fromJson location tags toJson withLocation withTags

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

TopicInner

public TopicInner()

Creates an instance of TopicInner class.

Method Details

dataResidencyBoundary

public DataResidencyBoundary dataResidencyBoundary()

Get the dataResidencyBoundary property: Data Residency Boundary of the resource.

Returns:

the dataResidencyBoundary value.

disableLocalAuth

public Boolean disableLocalAuth()

Get the disableLocalAuth property: This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only Microsoft Entra ID token will be used to authenticate if user is allowed to publish to the topic.

Returns:

the disableLocalAuth value.

endpoint

public String endpoint()

Get the endpoint property: Endpoint for the topic.

Returns:

the endpoint value.

eventTypeInfo

public EventTypeInfo eventTypeInfo()

Get the eventTypeInfo property: Event Type Information for the user topic. This information is provided by the publisher and can be used by the subscriber to view different types of events that are published.

Returns:

the eventTypeInfo value.

extendedLocation

public ExtendedLocation extendedLocation()

Get the extendedLocation property: Extended location of the resource.

Returns:

the extendedLocation value.

fromJson

public static TopicInner fromJson(JsonReader jsonReader)

Reads an instance of TopicInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of TopicInner 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:

TopicInner.id()

Returns:

the id value.

identity

public IdentityInfo identity()

Get the identity property: Identity information for the resource.

Returns:

the identity value.

inboundIpRules

public List<InboundIpRule> inboundIpRules()

Get the inboundIpRules property: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.

Returns:

the inboundIpRules value.

inputSchema

public InputSchema inputSchema()

Get the inputSchema property: This determines the format that Event Grid should expect for incoming events published to the topic.

Returns:

the inputSchema value.

inputSchemaMapping

public InputSchemaMapping inputSchemaMapping()

Get the inputSchemaMapping property: This enables publishing using custom event schemas. An InputSchemaMapping can be specified to map various properties of a source schema to various required properties of the EventGridEvent schema.

Returns:

the inputSchemaMapping value.

kind

public ResourceKind kind()

Get the kind property: Kind of the resource.

Returns:

the kind value.

metricResourceId

public String metricResourceId()

Get the metricResourceId property: Metric resource id for the topic.

Returns:

the metricResourceId value.

minimumTlsVersionAllowed

public TlsVersion minimumTlsVersionAllowed()

Get the minimumTlsVersionAllowed property: Minimum TLS version of the publisher allowed to publish to this topic.

Returns:

the minimumTlsVersionAllowed value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

TopicInner.name()

Returns:

the name value.

privateEndpointConnections

public List<PrivateEndpointConnectionInner> privateEndpointConnections()

Get the privateEndpointConnections property: List of private endpoint connections.

Returns:

the privateEndpointConnections value.

provisioningState

public TopicProvisioningState provisioningState()

Get the provisioningState property: Provisioning state of the topic.

Returns:

the provisioningState value.

publicNetworkAccess

public PublicNetworkAccess publicNetworkAccess()

Get the publicNetworkAccess property: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.TopicProperties.InboundIpRules" />.

Returns:

the publicNetworkAccess value.

sku

public ResourceSku sku()

Get the sku property: The Sku pricing tier for the topic.

Returns:

the sku 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:

TopicInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

type

public String type()

Get the type property: The type of the resource.

Overrides:

TopicInner.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

withDataResidencyBoundary

public TopicInner withDataResidencyBoundary(DataResidencyBoundary dataResidencyBoundary)

Set the dataResidencyBoundary property: Data Residency Boundary of the resource.

Parameters:

dataResidencyBoundary - the dataResidencyBoundary value to set.

Returns:

the TopicInner object itself.

withDisableLocalAuth

public TopicInner withDisableLocalAuth(Boolean disableLocalAuth)

Set the disableLocalAuth property: This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only Microsoft Entra ID token will be used to authenticate if user is allowed to publish to the topic.

Parameters:

disableLocalAuth - the disableLocalAuth value to set.

Returns:

the TopicInner object itself.

withEventTypeInfo

public TopicInner withEventTypeInfo(EventTypeInfo eventTypeInfo)

Set the eventTypeInfo property: Event Type Information for the user topic. This information is provided by the publisher and can be used by the subscriber to view different types of events that are published.

Parameters:

eventTypeInfo - the eventTypeInfo value to set.

Returns:

the TopicInner object itself.

withExtendedLocation

public TopicInner withExtendedLocation(ExtendedLocation extendedLocation)

Set the extendedLocation property: Extended location of the resource.

Parameters:

extendedLocation - the extendedLocation value to set.

Returns:

the TopicInner object itself.

withIdentity

public TopicInner withIdentity(IdentityInfo identity)

Set the identity property: Identity information for the resource.

Parameters:

identity - the identity value to set.

Returns:

the TopicInner object itself.

withInboundIpRules

public TopicInner withInboundIpRules(List<InboundIpRule> inboundIpRules)

Set the inboundIpRules property: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.

Parameters:

inboundIpRules - the inboundIpRules value to set.

Returns:

the TopicInner object itself.

withInputSchema

public TopicInner withInputSchema(InputSchema inputSchema)

Set the inputSchema property: This determines the format that Event Grid should expect for incoming events published to the topic.

Parameters:

inputSchema - the inputSchema value to set.

Returns:

the TopicInner object itself.

withInputSchemaMapping

public TopicInner withInputSchemaMapping(InputSchemaMapping inputSchemaMapping)

Set the inputSchemaMapping property: This enables publishing using custom event schemas. An InputSchemaMapping can be specified to map various properties of a source schema to various required properties of the EventGridEvent schema.

Parameters:

inputSchemaMapping - the inputSchemaMapping value to set.

Returns:

the TopicInner object itself.

withKind

public TopicInner withKind(ResourceKind kind)

Set the kind property: Kind of the resource.

Parameters:

kind - the kind value to set.

Returns:

the TopicInner object itself.

withLocation

public TopicInner withLocation(String location)

Overrides:

TopicInner.withLocation(String location)

Parameters:

location

withMinimumTlsVersionAllowed

public TopicInner withMinimumTlsVersionAllowed(TlsVersion minimumTlsVersionAllowed)

Set the minimumTlsVersionAllowed property: Minimum TLS version of the publisher allowed to publish to this topic.

Parameters:

minimumTlsVersionAllowed - the minimumTlsVersionAllowed value to set.

Returns:

the TopicInner object itself.

withPublicNetworkAccess

public TopicInner withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess)

Set the publicNetworkAccess property: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.TopicProperties.InboundIpRules" />.

Parameters:

publicNetworkAccess - the publicNetworkAccess value to set.

Returns:

the TopicInner object itself.

withSku

public TopicInner withSku(ResourceSku sku)

Set the sku property: The Sku pricing tier for the topic.

Parameters:

sku - the sku value to set.

Returns:

the TopicInner object itself.

withTags

public TopicInner withTags(Map<String,String> tags)

Overrides:

TopicInner.withTags(Map<String,String> tags)

Parameters:

tags