IotHubLocationDescription Class

Package:

com.azure.resourcemanager.iothub.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-iothub:1.2.0

• java.lang.Object
• • com.azure.resourcemanager.iothub.models.IotHubLocationDescription

public final class IotHubLocationDescription

Public representation of one of the locations where a resource is provisioned.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
String	location() Get the location property: The name of the Azure region.
IotHubReplicaRoleType	role() Get the role property: The role of the region, can be either primary or secondary.
void	validate() Validates the instance.
IotHubLocationDescription	withLocation(String location) Set the location property: The name of the Azure region.
IotHubLocationDescription	withRole(IotHubReplicaRoleType role) Set the role property: The role of the region, can be either primary or secondary.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

IotHubLocationDescription

public IotHubLocationDescription()

Creates an instance of IotHubLocationDescription class.

Method Details

location

public String location()

Get the location property: The name of the Azure region.

Returns:

the location value.

role

public IotHubReplicaRoleType role()

Get the role property: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to.

Returns:

the role value.

validate

public void validate()

Validates the instance.

withLocation

public IotHubLocationDescription withLocation(String location)

Set the location property: The name of the Azure region.

Parameters:

location - the location value to set.

Returns:

the IotHubLocationDescription object itself.

withRole

public IotHubLocationDescription withRole(IotHubReplicaRoleType role)

Set the role property: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to.

Parameters:

role - the role value to set.

Returns:

the IotHubLocationDescription object itself.