TopicUpdateParameters Class

Package:

com.azure.resourcemanager.eventgrid.models

Maven Artifact:

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

• java.lang.Object
• • com.azure.resourcemanager.eventgrid.models.TopicUpdateParameters

Implements

JsonSerializable<TopicUpdateParameters>

public final class TopicUpdateParameters
implements JsonSerializable<TopicUpdateParameters>

Properties of the Topic update.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
DataResidencyBoundary	dataResidencyBoundary() Get the dataResidencyBoundary property: The data residency boundary for the topic.
Boolean	disableLocalAuth() Get the disableLocalAuth property: This boolean is used to enable or disable local auth.
EventTypeInfo	eventTypeInfo() Get the eventTypeInfo property: The eventTypeInfo for the topic.
static TopicUpdateParameters	fromJson(JsonReader jsonReader) Reads an instance of TopicUpdateParameters from the JsonReader.
IdentityInfo	identity() Get the identity property: Topic resource identity information.
List<InboundIpRule>	inboundIpRules() Get the inboundIpRules property: This can be used to restrict traffic from specific IPs instead of all IPs.
TlsVersion	minimumTlsVersionAllowed() Get the minimumTlsVersionAllowed property: Minimum TLS version of the publisher allowed to publish to this domain.
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.
Map<String,String>	tags() Get the tags property: Tags of the Topic resource.
JsonWriter	toJson(JsonWriter jsonWriter)
void	validate() Validates the instance.
TopicUpdateParameters	withDataResidencyBoundary(DataResidencyBoundary dataResidencyBoundary) Set the dataResidencyBoundary property: The data residency boundary for the topic.
TopicUpdateParameters	withDisableLocalAuth(Boolean disableLocalAuth) Set the disableLocalAuth property: This boolean is used to enable or disable local auth.
TopicUpdateParameters	withEventTypeInfo(EventTypeInfo eventTypeInfo) Set the eventTypeInfo property: The eventTypeInfo for the topic.
TopicUpdateParameters	withIdentity(IdentityInfo identity) Set the identity property: Topic resource identity information.
TopicUpdateParameters	withInboundIpRules(List<InboundIpRule> inboundIpRules) Set the inboundIpRules property: This can be used to restrict traffic from specific IPs instead of all IPs.
TopicUpdateParameters	withMinimumTlsVersionAllowed(TlsVersion minimumTlsVersionAllowed) Set the minimumTlsVersionAllowed property: Minimum TLS version of the publisher allowed to publish to this domain.
TopicUpdateParameters	withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess) Set the publicNetworkAccess property: This determines if traffic is allowed over public network.
TopicUpdateParameters	withSku(ResourceSku sku) Set the sku property: The Sku pricing tier for the topic.
TopicUpdateParameters	withTags(Map<String,String> tags) Set the tags property: Tags of the Topic resource.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

TopicUpdateParameters

public TopicUpdateParameters()

Creates an instance of TopicUpdateParameters class.

Method Details

dataResidencyBoundary

public DataResidencyBoundary dataResidencyBoundary()

Get the dataResidencyBoundary property: The data residency boundary for the topic.

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.

eventTypeInfo

public EventTypeInfo eventTypeInfo()

Get the eventTypeInfo property: The eventTypeInfo for the topic.

Returns:

the eventTypeInfo value.

fromJson

public static TopicUpdateParameters fromJson(JsonReader jsonReader)

Reads an instance of TopicUpdateParameters from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IOException

- If an error occurs while reading the TopicUpdateParameters.

identity

public IdentityInfo identity()

Get the identity property: Topic resource identity information.

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.

minimumTlsVersionAllowed

public TlsVersion minimumTlsVersionAllowed()

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

Returns:

the minimumTlsVersionAllowed 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.TopicUpdateParameterProperties.InboundIpRules" />.

Returns:

the publicNetworkAccess value.

sku

public ResourceSku sku()

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

Returns:

the sku value.

tags

public Map<String,String> tags()

Get the tags property: Tags of the Topic resource.

Returns:

the tags value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

validate

public void validate()

Validates the instance.

withDataResidencyBoundary

public TopicUpdateParameters withDataResidencyBoundary(DataResidencyBoundary dataResidencyBoundary)

Set the dataResidencyBoundary property: The data residency boundary for the topic.

Parameters:

dataResidencyBoundary - the dataResidencyBoundary value to set.

Returns:

the TopicUpdateParameters object itself.

withDisableLocalAuth

public TopicUpdateParameters 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 TopicUpdateParameters object itself.

withEventTypeInfo

public TopicUpdateParameters withEventTypeInfo(EventTypeInfo eventTypeInfo)

Set the eventTypeInfo property: The eventTypeInfo for the topic.

Parameters:

eventTypeInfo - the eventTypeInfo value to set.

Returns:

the TopicUpdateParameters object itself.

withIdentity

public TopicUpdateParameters withIdentity(IdentityInfo identity)

Set the identity property: Topic resource identity information.

Parameters:

identity - the identity value to set.

Returns:

the TopicUpdateParameters object itself.

withInboundIpRules

public TopicUpdateParameters 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 TopicUpdateParameters object itself.

withMinimumTlsVersionAllowed

public TopicUpdateParameters withMinimumTlsVersionAllowed(TlsVersion minimumTlsVersionAllowed)

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

Parameters:

minimumTlsVersionAllowed - the minimumTlsVersionAllowed value to set.

Returns:

the TopicUpdateParameters object itself.

withPublicNetworkAccess

public TopicUpdateParameters 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.TopicUpdateParameterProperties.InboundIpRules" />.

Parameters:

publicNetworkAccess - the publicNetworkAccess value to set.

Returns:

the TopicUpdateParameters object itself.

withSku

public TopicUpdateParameters withSku(ResourceSku sku)

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

Parameters:

sku - the sku value to set.

Returns:

the TopicUpdateParameters object itself.

withTags

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

Set the tags property: Tags of the Topic resource.

Parameters:

tags - the tags value to set.

Returns:

the TopicUpdateParameters object itself.