Class RoutingEventHubProperties
java.lang.Object
com.azure.resourcemanager.iothub.models.RoutingEventHubProperties
The properties related to an event hub endpoint.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGet the authenticationType property: Method used to authenticate against the event hub endpoint.Get the connectionString property: The connection string of the event hub endpoint.Get the endpointUri property: The url of the event hub endpoint.Get the entityPath property: Event hub name on the event hub namespace.id()
Get the id property: Id of the event hub endpoint.identity()
Get the identity property: Managed identity properties of routing event hub endpoint.name()
Get the name property: The name that identifies this endpoint.Get the resourceGroup property: The name of the resource group of the event hub endpoint.Get the subscriptionId property: The subscription identifier of the event hub endpoint.void
validate()
Validates the instance.withAuthenticationType
(AuthenticationType authenticationType) Set the authenticationType property: Method used to authenticate against the event hub endpoint.withConnectionString
(String connectionString) Set the connectionString property: The connection string of the event hub endpoint.withEndpointUri
(String endpointUri) Set the endpointUri property: The url of the event hub endpoint.withEntityPath
(String entityPath) Set the entityPath property: Event hub name on the event hub namespace.Set the id property: Id of the event hub endpoint.withIdentity
(ManagedIdentity identity) Set the identity property: Managed identity properties of routing event hub endpoint.Set the name property: The name that identifies this endpoint.withResourceGroup
(String resourceGroup) Set the resourceGroup property: The name of the resource group of the event hub endpoint.withSubscriptionId
(String subscriptionId) Set the subscriptionId property: The subscription identifier of the event hub endpoint.
-
Constructor Details
-
RoutingEventHubProperties
public RoutingEventHubProperties()
-
-
Method Details
-
id
Get the id property: Id of the event hub endpoint.- Returns:
- the id value.
-
withId
Set the id property: Id of the event hub endpoint.- Parameters:
id
- the id value to set.- Returns:
- the RoutingEventHubProperties object itself.
-
connectionString
Get the connectionString property: The connection string of the event hub endpoint.- Returns:
- the connectionString value.
-
withConnectionString
Set the connectionString property: The connection string of the event hub endpoint.- Parameters:
connectionString
- the connectionString value to set.- Returns:
- the RoutingEventHubProperties object itself.
-
endpointUri
Get the endpointUri property: The url of the event hub endpoint. It must include the protocol sb://.- Returns:
- the endpointUri value.
-
withEndpointUri
Set the endpointUri property: The url of the event hub endpoint. It must include the protocol sb://.- Parameters:
endpointUri
- the endpointUri value to set.- Returns:
- the RoutingEventHubProperties object itself.
-
entityPath
Get the entityPath property: Event hub name on the event hub namespace.- Returns:
- the entityPath value.
-
withEntityPath
Set the entityPath property: Event hub name on the event hub namespace.- Parameters:
entityPath
- the entityPath value to set.- Returns:
- the RoutingEventHubProperties object itself.
-
authenticationType
Get the authenticationType property: Method used to authenticate against the event hub endpoint.- Returns:
- the authenticationType value.
-
withAuthenticationType
Set the authenticationType property: Method used to authenticate against the event hub endpoint.- Parameters:
authenticationType
- the authenticationType value to set.- Returns:
- the RoutingEventHubProperties object itself.
-
identity
Get the identity property: Managed identity properties of routing event hub endpoint.- Returns:
- the identity value.
-
withIdentity
Set the identity property: Managed identity properties of routing event hub endpoint.- Parameters:
identity
- the identity value to set.- Returns:
- the RoutingEventHubProperties object itself.
-
name
Get the name property: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types.- Returns:
- the name value.
-
withName
Set the name property: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types.- Parameters:
name
- the name value to set.- Returns:
- the RoutingEventHubProperties object itself.
-
subscriptionId
Get the subscriptionId property: The subscription identifier of the event hub endpoint.- Returns:
- the subscriptionId value.
-
withSubscriptionId
Set the subscriptionId property: The subscription identifier of the event hub endpoint.- Parameters:
subscriptionId
- the subscriptionId value to set.- Returns:
- the RoutingEventHubProperties object itself.
-
resourceGroup
Get the resourceGroup property: The name of the resource group of the event hub endpoint.- Returns:
- the resourceGroup value.
-
withResourceGroup
Set the resourceGroup property: The name of the resource group of the event hub endpoint.- Parameters:
resourceGroup
- the resourceGroup value to set.- Returns:
- the RoutingEventHubProperties object itself.
-
validate
public void validate()Validates the instance.- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-