Package com.azure.resourcemanager.iothub.models

Class IotHubLocationDescription

java.lang.Object

com.azure.resourcemanager.iothub.models.IotHubLocationDescription

public final class IotHubLocationDescription
extends Object

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

Constructor Summary

Constructors

Constructor	Description
IotHubLocationDescription()

Method Summary

Modifier and Type	Method	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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IotHubLocationDescription

public IotHubLocationDescription()

Method Detail

location

public String location()

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

Returns:

the location value.

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.

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.

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.

validate

public void validate()

Validates the instance.

Throws:

IllegalArgumentException - thrown if the instance is not valid.