Class ExtensionParameters


  • public final class ExtensionParameters
    extends Object
    Describes the properties of a Machine Extension. This object mirrors the definition in HybridCompute.
    • Constructor Detail

      • ExtensionParameters

        public ExtensionParameters()
    • Method Detail

      • forceUpdateTag

        public String forceUpdateTag()
        Get the forceUpdateTag property: How the extension handler should be forced to update even if the extension configuration has not changed.
        Returns:
        the forceUpdateTag value.
      • withForceUpdateTag

        public ExtensionParameters withForceUpdateTag​(String forceUpdateTag)
        Set the forceUpdateTag property: How the extension handler should be forced to update even if the extension configuration has not changed.
        Parameters:
        forceUpdateTag - the forceUpdateTag value to set.
        Returns:
        the ExtensionParameters object itself.
      • publisher

        public String publisher()
        Get the publisher property: The name of the extension handler publisher.
        Returns:
        the publisher value.
      • withPublisher

        public ExtensionParameters withPublisher​(String publisher)
        Set the publisher property: The name of the extension handler publisher.
        Parameters:
        publisher - the publisher value to set.
        Returns:
        the ExtensionParameters object itself.
      • type

        public String type()
        Get the type property: Specifies the type of the extension; an example is "CustomScriptExtension".
        Returns:
        the type value.
      • withType

        public ExtensionParameters withType​(String type)
        Set the type property: Specifies the type of the extension; an example is "CustomScriptExtension".
        Parameters:
        type - the type value to set.
        Returns:
        the ExtensionParameters object itself.
      • typeHandlerVersion

        public String typeHandlerVersion()
        Get the typeHandlerVersion property: Specifies the version of the script handler.
        Returns:
        the typeHandlerVersion value.
      • withTypeHandlerVersion

        public ExtensionParameters withTypeHandlerVersion​(String typeHandlerVersion)
        Set the typeHandlerVersion property: Specifies the version of the script handler.
        Parameters:
        typeHandlerVersion - the typeHandlerVersion value to set.
        Returns:
        the ExtensionParameters object itself.
      • autoUpgradeMinorVersion

        public Boolean autoUpgradeMinorVersion()
        Get the autoUpgradeMinorVersion property: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.
        Returns:
        the autoUpgradeMinorVersion value.
      • withAutoUpgradeMinorVersion

        public ExtensionParameters withAutoUpgradeMinorVersion​(Boolean autoUpgradeMinorVersion)
        Set the autoUpgradeMinorVersion property: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.
        Parameters:
        autoUpgradeMinorVersion - the autoUpgradeMinorVersion value to set.
        Returns:
        the ExtensionParameters object itself.
      • settings

        public Object settings()
        Get the settings property: Json formatted public settings for the extension.
        Returns:
        the settings value.
      • withSettings

        public ExtensionParameters withSettings​(Object settings)
        Set the settings property: Json formatted public settings for the extension.
        Parameters:
        settings - the settings value to set.
        Returns:
        the ExtensionParameters object itself.
      • protectedSettings

        public Object protectedSettings()
        Get the protectedSettings property: Protected settings (may contain secrets).
        Returns:
        the protectedSettings value.
      • withProtectedSettings

        public ExtensionParameters withProtectedSettings​(Object protectedSettings)
        Set the protectedSettings property: Protected settings (may contain secrets).
        Parameters:
        protectedSettings - the protectedSettings value to set.
        Returns:
        the ExtensionParameters object itself.
      • validate

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