Package com.azure.resourcemanager.eventgrid.fluent.models

Class TopicProperties

  • public final class TopicProperties
extends Object
    Properties of the Topic.

    • Constructor Detail

      • TopicProperties

        public TopicProperties()

    • Method Detail

      • privateEndpointConnections

        public List<PrivateEndpointConnectionInner> privateEndpointConnections()
        Get the privateEndpointConnections property: The privateEndpointConnections property.
        Returns:
        the privateEndpointConnections value.

      • provisioningState

        public TopicProvisioningState provisioningState()
        Get the provisioningState property: Provisioning state of the topic.
        Returns:
        the provisioningState value.

      • endpoint

        public String endpoint()
        Get the endpoint property: Endpoint for the topic.
        Returns:
        the endpoint 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.

      • withInputSchema

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

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

      • withInputSchemaMapping

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

      • metricResourceId

        public String metricResourceId()
        Get the metricResourceId property: Metric resource id for the topic.
        Returns:
        the metricResourceId 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.

      • withPublicNetworkAccess

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

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

      • withInboundIpRules

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

      • 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 AAD token will be used to authenticate if user is allowed to publish to the topic.
        Returns:
        the disableLocalAuth value.

      • withDisableLocalAuth

        public TopicProperties 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 AAD token will be used to authenticate if user is allowed to publish to the topic.
        Parameters:
        disableLocalAuth - the disableLocalAuth value to set.
        Returns:
        the TopicProperties object itself.

      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.