Share via


TopicSpacesConfiguration Class

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

Implements

public final class TopicSpacesConfiguration
implements JsonSerializable<TopicSpacesConfiguration>

Properties of the Topic Spaces Configuration.

Constructor Summary

Constructor Description
TopicSpacesConfiguration()

Creates an instance of TopicSpacesConfiguration class.

Method Summary

Modifier and Type Method and Description
List<CustomDomainConfiguration> customDomains()

Get the customDomains property: List of custom domain configurations for the namespace.

static TopicSpacesConfiguration fromJson(JsonReader jsonReader)

Reads an instance of TopicSpacesConfiguration from the JsonReader.

String hostname()

Get the hostname property: The endpoint for the topic spaces configuration.

Integer maximumClientSessionsPerAuthenticationName()

Get the maximumClientSessionsPerAuthenticationName property: The maximum number of sessions per authentication name.

Integer maximumSessionExpiryInHours()

Get the maximumSessionExpiryInHours property: The maximum session expiry in hours.

String routeTopicResourceId()

Get the routeTopicResourceId property: Fully qualified Azure Resource Id for the Event Grid Topic to which events will be routed to from TopicSpaces under a namespace.

RoutingEnrichments routingEnrichments()

Get the routingEnrichments property: Routing enrichments for topic spaces configuration.

RoutingIdentityInfo routingIdentityInfo()

Get the routingIdentityInfo property: Routing identity info for topic spaces configuration.

TopicSpacesConfigurationState state()

Get the state property: Indicate if Topic Spaces Configuration is enabled for the namespace.

JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.

TopicSpacesConfiguration withCustomDomains(List<CustomDomainConfiguration> customDomains)

Set the customDomains property: List of custom domain configurations for the namespace.

TopicSpacesConfiguration withMaximumClientSessionsPerAuthenticationName(Integer maximumClientSessionsPerAuthenticationName)

Set the maximumClientSessionsPerAuthenticationName property: The maximum number of sessions per authentication name.

TopicSpacesConfiguration withMaximumSessionExpiryInHours(Integer maximumSessionExpiryInHours)

Set the maximumSessionExpiryInHours property: The maximum session expiry in hours.

TopicSpacesConfiguration withRouteTopicResourceId(String routeTopicResourceId)

Set the routeTopicResourceId property: Fully qualified Azure Resource Id for the Event Grid Topic to which events will be routed to from TopicSpaces under a namespace.

TopicSpacesConfiguration withRoutingEnrichments(RoutingEnrichments routingEnrichments)

Set the routingEnrichments property: Routing enrichments for topic spaces configuration.

TopicSpacesConfiguration withRoutingIdentityInfo(RoutingIdentityInfo routingIdentityInfo)

Set the routingIdentityInfo property: Routing identity info for topic spaces configuration.

TopicSpacesConfiguration withState(TopicSpacesConfigurationState state)

Set the state property: Indicate if Topic Spaces Configuration is enabled for the namespace.

Methods inherited from java.lang.Object

Constructor Details

TopicSpacesConfiguration

public TopicSpacesConfiguration()

Creates an instance of TopicSpacesConfiguration class.

Method Details

customDomains

public List<CustomDomainConfiguration> customDomains()

Get the customDomains property: List of custom domain configurations for the namespace.

Returns:

the customDomains value.

fromJson

public static TopicSpacesConfiguration fromJson(JsonReader jsonReader)

Reads an instance of TopicSpacesConfiguration from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

hostname

public String hostname()

Get the hostname property: The endpoint for the topic spaces configuration. This is a read-only property.

Returns:

the hostname value.

maximumClientSessionsPerAuthenticationName

public Integer maximumClientSessionsPerAuthenticationName()

Get the maximumClientSessionsPerAuthenticationName property: The maximum number of sessions per authentication name. The property default value is 1. Min allowed value is 1 and max allowed value is 100.

Returns:

the maximumClientSessionsPerAuthenticationName value.

maximumSessionExpiryInHours

public Integer maximumSessionExpiryInHours()

Get the maximumSessionExpiryInHours property: The maximum session expiry in hours. The property default value is 1 hour. Min allowed value is 1 hour and max allowed value is 8 hours.

Returns:

the maximumSessionExpiryInHours value.

routeTopicResourceId

public String routeTopicResourceId()

Get the routeTopicResourceId property: Fully qualified Azure Resource Id for the Event Grid Topic to which events will be routed to from TopicSpaces under a namespace. This property should be in the following format '/subscriptions/{subId}/resourcegroups/{resourceGroupName}/providers/microsoft.EventGrid/topics/{topicName}'. This topic should reside in the same region where namespace is located.

Returns:

the routeTopicResourceId value.

routingEnrichments

public RoutingEnrichments routingEnrichments()

Get the routingEnrichments property: Routing enrichments for topic spaces configuration.

Returns:

the routingEnrichments value.

routingIdentityInfo

public RoutingIdentityInfo routingIdentityInfo()

Get the routingIdentityInfo property: Routing identity info for topic spaces configuration.

Returns:

the routingIdentityInfo value.

state

public TopicSpacesConfigurationState state()

Get the state property: Indicate if Topic Spaces Configuration is enabled for the namespace. Default is Disabled.

Returns:

the state value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

withCustomDomains

public TopicSpacesConfiguration withCustomDomains(List<CustomDomainConfiguration> customDomains)

Set the customDomains property: List of custom domain configurations for the namespace.

Parameters:

customDomains - the customDomains value to set.

Returns:

the TopicSpacesConfiguration object itself.

withMaximumClientSessionsPerAuthenticationName

public TopicSpacesConfiguration withMaximumClientSessionsPerAuthenticationName(Integer maximumClientSessionsPerAuthenticationName)

Set the maximumClientSessionsPerAuthenticationName property: The maximum number of sessions per authentication name. The property default value is 1. Min allowed value is 1 and max allowed value is 100.

Parameters:

maximumClientSessionsPerAuthenticationName - the maximumClientSessionsPerAuthenticationName value to set.

Returns:

the TopicSpacesConfiguration object itself.

withMaximumSessionExpiryInHours

public TopicSpacesConfiguration withMaximumSessionExpiryInHours(Integer maximumSessionExpiryInHours)

Set the maximumSessionExpiryInHours property: The maximum session expiry in hours. The property default value is 1 hour. Min allowed value is 1 hour and max allowed value is 8 hours.

Parameters:

maximumSessionExpiryInHours - the maximumSessionExpiryInHours value to set.

Returns:

the TopicSpacesConfiguration object itself.

withRouteTopicResourceId

public TopicSpacesConfiguration withRouteTopicResourceId(String routeTopicResourceId)

Set the routeTopicResourceId property: Fully qualified Azure Resource Id for the Event Grid Topic to which events will be routed to from TopicSpaces under a namespace. This property should be in the following format '/subscriptions/{subId}/resourcegroups/{resourceGroupName}/providers/microsoft.EventGrid/topics/{topicName}'. This topic should reside in the same region where namespace is located.

Parameters:

routeTopicResourceId - the routeTopicResourceId value to set.

Returns:

the TopicSpacesConfiguration object itself.

withRoutingEnrichments

public TopicSpacesConfiguration withRoutingEnrichments(RoutingEnrichments routingEnrichments)

Set the routingEnrichments property: Routing enrichments for topic spaces configuration.

Parameters:

routingEnrichments - the routingEnrichments value to set.

Returns:

the TopicSpacesConfiguration object itself.

withRoutingIdentityInfo

public TopicSpacesConfiguration withRoutingIdentityInfo(RoutingIdentityInfo routingIdentityInfo)

Set the routingIdentityInfo property: Routing identity info for topic spaces configuration.

Parameters:

routingIdentityInfo - the routingIdentityInfo value to set.

Returns:

the TopicSpacesConfiguration object itself.

withState

public TopicSpacesConfiguration withState(TopicSpacesConfigurationState state)

Set the state property: Indicate if Topic Spaces Configuration is enabled for the namespace. Default is Disabled.

Parameters:

state - the state value to set.

Returns:

the TopicSpacesConfiguration object itself.

Applies to