Class IotHubDefinitionDescription


  • public final class IotHubDefinitionDescription
    extends Object
    Description of the IoT hub.
    • Constructor Detail

      • IotHubDefinitionDescription

        public IotHubDefinitionDescription()
    • Method Detail

      • applyAllocationPolicy

        public Boolean applyAllocationPolicy()
        Get the applyAllocationPolicy property: flag for applying allocationPolicy or not for a given iot hub.
        Returns:
        the applyAllocationPolicy value.
      • 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.
      • allocationWeight

        public Integer allocationWeight()
        Get the allocationWeight property: weight to apply for a given iot h.
        Returns:
        the allocationWeight value.
      • 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.
      • name

        public String name()
        Get the name property: Host name of the IoT hub.
        Returns:
        the name value.
      • connectionString

        public String connectionString()
        Get the connectionString property: Connection string of the IoT hub.
        Returns:
        the connectionString value.
      • withConnectionString

        public IotHubDefinitionDescription withConnectionString​(String connectionString)
        Set the connectionString property: Connection string of the IoT hub.
        Parameters:
        connectionString - the connectionString value to set.
        Returns:
        the IotHubDefinitionDescription object itself.
      • location

        public String location()
        Get the location property: ARM region of the IoT hub.
        Returns:
        the location value.
      • 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.
      • validate

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