Class ParameterDefinitionsValueMetadata

java.lang.Object
com.azure.resourcemanager.resources.models.ParameterDefinitionsValueMetadata
All Implemented Interfaces:
com.azure.json.JsonSerializable<ParameterDefinitionsValueMetadata>

public final class ParameterDefinitionsValueMetadata extends Object implements com.azure.json.JsonSerializable<ParameterDefinitionsValueMetadata>
General metadata for the parameter.
  • Constructor Details

    • ParameterDefinitionsValueMetadata

      public ParameterDefinitionsValueMetadata()
      Creates an instance of ParameterDefinitionsValueMetadata class.
  • Method Details

    • displayName

      public String displayName()
      Get the displayName property: The display name for the parameter.
      Returns:
      the displayName value.
    • withDisplayName

      public ParameterDefinitionsValueMetadata withDisplayName(String displayName)
      Set the displayName property: The display name for the parameter.
      Parameters:
      displayName - the displayName value to set.
      Returns:
      the ParameterDefinitionsValueMetadata object itself.
    • description

      public String description()
      Get the description property: The description of the parameter.
      Returns:
      the description value.
    • withDescription

      public ParameterDefinitionsValueMetadata withDescription(String description)
      Set the description property: The description of the parameter.
      Parameters:
      description - the description value to set.
      Returns:
      the ParameterDefinitionsValueMetadata object itself.
    • strongType

      public String strongType()
      Get the strongType property: Used when assigning the policy definition through the portal. Provides a context aware list of values for the user to choose from.
      Returns:
      the strongType value.
    • withStrongType

      public ParameterDefinitionsValueMetadata withStrongType(String strongType)
      Set the strongType property: Used when assigning the policy definition through the portal. Provides a context aware list of values for the user to choose from.
      Parameters:
      strongType - the strongType value to set.
      Returns:
      the ParameterDefinitionsValueMetadata object itself.
    • assignPermissions

      public Boolean assignPermissions()
      Get the assignPermissions property: Set to true to have Azure portal create role assignments on the resource ID or resource scope value of this parameter during policy assignment. This property is useful in case you wish to assign permissions outside the assignment scope.
      Returns:
      the assignPermissions value.
    • withAssignPermissions

      public ParameterDefinitionsValueMetadata withAssignPermissions(Boolean assignPermissions)
      Set the assignPermissions property: Set to true to have Azure portal create role assignments on the resource ID or resource scope value of this parameter during policy assignment. This property is useful in case you wish to assign permissions outside the assignment scope.
      Parameters:
      assignPermissions - the assignPermissions value to set.
      Returns:
      the ParameterDefinitionsValueMetadata object itself.
    • additionalProperties

      public Map<String,Object> additionalProperties()
      Get the additionalProperties property: General metadata for the parameter.
      Returns:
      the additionalProperties value.
    • withAdditionalProperties

      public ParameterDefinitionsValueMetadata withAdditionalProperties(Map<String,Object> additionalProperties)
      Set the additionalProperties property: General metadata for the parameter.
      Parameters:
      additionalProperties - the additionalProperties value to set.
      Returns:
      the ParameterDefinitionsValueMetadata object itself.
    • validate

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

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<ParameterDefinitionsValueMetadata>
      Throws:
      IOException
    • fromJson

      public static ParameterDefinitionsValueMetadata fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of ParameterDefinitionsValueMetadata from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of ParameterDefinitionsValueMetadata if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IOException - If an error occurs while reading the ParameterDefinitionsValueMetadata.