TopicUpdateParameterProperties Class

  • java.lang.Object
    • com.azure.resourcemanager.eventgrid.fluent.models.TopicUpdateParameterProperties

Implements

public final class TopicUpdateParameterProperties
implements JsonSerializable<TopicUpdateParameterProperties>

Information of topic update parameter properties.

Constructor Summary

Constructor Description
TopicUpdateParameterProperties()

Creates an instance of TopicUpdateParameterProperties 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 TopicUpdateParameterProperties fromJson(JsonReader jsonReader)

Reads an instance of TopicUpdateParameterProperties from the JsonReader.

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.

JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.

TopicUpdateParameterProperties withDataResidencyBoundary(DataResidencyBoundary dataResidencyBoundary)

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

TopicUpdateParameterProperties withDisableLocalAuth(Boolean disableLocalAuth)

Set the disableLocalAuth property: This boolean is used to enable or disable local auth.

TopicUpdateParameterProperties withEventTypeInfo(EventTypeInfo eventTypeInfo)

Set the eventTypeInfo property: The eventTypeInfo for the topic.

TopicUpdateParameterProperties withInboundIpRules(List<InboundIpRule> inboundIpRules)

Set the inboundIpRules property: This can be used to restrict traffic from specific IPs instead of all IPs.

TopicUpdateParameterProperties withMinimumTlsVersionAllowed(TlsVersion minimumTlsVersionAllowed)

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

TopicUpdateParameterProperties withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess)

Set the publicNetworkAccess property: This determines if traffic is allowed over public network.

Methods inherited from java.lang.Object

Constructor Details

TopicUpdateParameterProperties

public TopicUpdateParameterProperties()

Creates an instance of TopicUpdateParameterProperties 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 TopicUpdateParameterProperties fromJson(JsonReader jsonReader)

Reads an instance of TopicUpdateParameterProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of TopicUpdateParameterProperties 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 TopicUpdateParameterProperties.

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.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

withDataResidencyBoundary

public TopicUpdateParameterProperties withDataResidencyBoundary(DataResidencyBoundary dataResidencyBoundary)

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

Parameters:

dataResidencyBoundary - the dataResidencyBoundary value to set.

Returns:

the TopicUpdateParameterProperties object itself.

withDisableLocalAuth

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

withEventTypeInfo

public TopicUpdateParameterProperties withEventTypeInfo(EventTypeInfo eventTypeInfo)

Set the eventTypeInfo property: The eventTypeInfo for the topic.

Parameters:

eventTypeInfo - the eventTypeInfo value to set.

Returns:

the TopicUpdateParameterProperties object itself.

withInboundIpRules

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

withMinimumTlsVersionAllowed

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

withPublicNetworkAccess

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

Applies to