IotHubDefinitionDescription Class

Package:
com.azure.resourcemanager.deviceprovisioningservices.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-deviceprovisioningservices:1.2.0
  • java.lang.Object
    • com.azure.resourcemanager.deviceprovisioningservices.models.IotHubDefinitionDescription

Implements

JsonSerializable<IotHubDefinitionDescription>

public final class IotHubDefinitionDescription
implements JsonSerializable<IotHubDefinitionDescription>

Description of the IoT hub.

Constructor Summary

Constructor Description
IotHubDefinitionDescription()

Creates an instance of IotHubDefinitionDescription class.

Method Summary

Modifier and Type Method and Description
Integer allocationWeight()

Get the allocationWeight property: weight to apply for a given iot h.
Boolean applyAllocationPolicy()

Get the applyAllocationPolicy property: flag for applying allocationPolicy or not for a given iot hub.
IotHubAuthenticationType authenticationType()

Get the authenticationType property: IotHub MI authentication type: KeyBased, UserAssigned, SystemAssigned.
String connectionString()

Get the connectionString property: Connection string of the IoT hub.
static IotHubDefinitionDescription fromJson(JsonReader jsonReader)

Reads an instance of IotHubDefinitionDescription from the JsonReader.
String hostName()

Get the hostName property: Host name of the IoT hub.
String location()

Get the location property: ARM region of the IoT hub.
String name()

Get the name property: Host name of the IoT hub.
String selectedUserAssignedIdentityResourceId()

Get the selectedUserAssignedIdentityResourceId property: The selected user-assigned identity resource Id associated with IoT hub.
JsonWriter toJson(JsonWriter jsonWriter)
IotHubDefinitionDescription withAllocationWeight(Integer allocationWeight)

Set the allocationWeight property: weight to apply for a given iot h.
IotHubDefinitionDescription withApplyAllocationPolicy(Boolean applyAllocationPolicy)

Set the applyAllocationPolicy property: flag for applying allocationPolicy or not for a given iot hub.
IotHubDefinitionDescription withAuthenticationType(IotHubAuthenticationType authenticationType)

Set the authenticationType property: IotHub MI authentication type: KeyBased, UserAssigned, SystemAssigned.
IotHubDefinitionDescription withConnectionString(String connectionString)

Set the connectionString property: Connection string of the IoT hub.
IotHubDefinitionDescription withHostName(String hostName)

Set the hostName property: Host name of the IoT hub.
IotHubDefinitionDescription withLocation(String location)

Set the location property: ARM region of the IoT hub.
IotHubDefinitionDescription withSelectedUserAssignedIdentityResourceId(String selectedUserAssignedIdentityResourceId)

Set the selectedUserAssignedIdentityResourceId property: The selected user-assigned identity resource Id associated with IoT hub.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

IotHubDefinitionDescription

public IotHubDefinitionDescription()

Creates an instance of IotHubDefinitionDescription class.

Method Details

allocationWeight

public Integer allocationWeight()

Get the allocationWeight property: weight to apply for a given iot h.

Returns:

the allocationWeight value.

applyAllocationPolicy

public Boolean applyAllocationPolicy()

Get the applyAllocationPolicy property: flag for applying allocationPolicy or not for a given iot hub.

Returns:

the applyAllocationPolicy value.

authenticationType

public IotHubAuthenticationType authenticationType()

Get the authenticationType property: IotHub MI authentication type: KeyBased, UserAssigned, SystemAssigned.

Returns:

the authenticationType value.

connectionString

public String connectionString()

Get the connectionString property: Connection string of the IoT hub. This is required when authenticationType is KeyBased.

Returns:

the connectionString value.

fromJson

public static IotHubDefinitionDescription fromJson(JsonReader jsonReader)

Reads an instance of IotHubDefinitionDescription from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of IotHubDefinitionDescription if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

hostName

public String hostName()

Get the hostName property: Host name of the IoT hub. This is required when connectionString is not provided.

Returns:

the hostName value.

location

public String location()

Get the location property: ARM region of the IoT hub.

Returns:

the location value.

name

public String name()

Get the name property: Host name of the IoT hub.

Returns:

the name value.

selectedUserAssignedIdentityResourceId

public String selectedUserAssignedIdentityResourceId()

Get the selectedUserAssignedIdentityResourceId property: The selected user-assigned identity resource Id associated with IoT hub. This is required when authenticationType is UserAssigned.

Returns:

the selectedUserAssignedIdentityResourceId value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

withAllocationWeight

public IotHubDefinitionDescription withAllocationWeight(Integer allocationWeight)

Set the allocationWeight property: weight to apply for a given iot h.

Parameters:

allocationWeight - the allocationWeight value to set.

Returns:

the IotHubDefinitionDescription object itself.

withApplyAllocationPolicy

public IotHubDefinitionDescription withApplyAllocationPolicy(Boolean applyAllocationPolicy)

Set the applyAllocationPolicy property: flag for applying allocationPolicy or not for a given iot hub.

Parameters:

applyAllocationPolicy - the applyAllocationPolicy value to set.

Returns:

the IotHubDefinitionDescription object itself.

withAuthenticationType

public IotHubDefinitionDescription withAuthenticationType(IotHubAuthenticationType authenticationType)

Set the authenticationType property: IotHub MI authentication type: KeyBased, UserAssigned, SystemAssigned.

Parameters:

authenticationType - the authenticationType value to set.

Returns:

the IotHubDefinitionDescription object itself.

withConnectionString

public IotHubDefinitionDescription withConnectionString(String connectionString)

Set the connectionString property: Connection string of the IoT hub. This is required when authenticationType is KeyBased.

Parameters:

connectionString - the connectionString value to set.

Returns:

the IotHubDefinitionDescription object itself.

withHostName

public IotHubDefinitionDescription withHostName(String hostName)

Set the hostName property: Host name of the IoT hub. This is required when connectionString is not provided.

Parameters:

hostName - the hostName value to set.

Returns:

the IotHubDefinitionDescription object itself.

withLocation

public IotHubDefinitionDescription withLocation(String location)

Set the location property: ARM region of the IoT hub.

Parameters:

location - the location value to set.

Returns:

the IotHubDefinitionDescription object itself.

withSelectedUserAssignedIdentityResourceId

public IotHubDefinitionDescription withSelectedUserAssignedIdentityResourceId(String selectedUserAssignedIdentityResourceId)

Set the selectedUserAssignedIdentityResourceId property: The selected user-assigned identity resource Id associated with IoT hub. This is required when authenticationType is UserAssigned.

Parameters:

selectedUserAssignedIdentityResourceId - the selectedUserAssignedIdentityResourceId value to set.

Returns:

the IotHubDefinitionDescription object itself.

Applies to