Package com.azure.resourcemanager.resources.fluent.models

Class PolicySetDefinitionProperties

java.lang.Object
com.azure.resourcemanager.resources.fluent.models.PolicySetDefinitionProperties
All Implemented Interfaces:
com.azure.json.JsonSerializable<PolicySetDefinitionProperties>
public final class PolicySetDefinitionProperties extends Object implements com.azure.json.JsonSerializable<PolicySetDefinitionProperties>
The policy set definition properties.

  • Constructor Details

    • PolicySetDefinitionProperties

      public PolicySetDefinitionProperties()
      Creates an instance of PolicySetDefinitionProperties class.

  • Method Details

    • policyType

      public PolicyType policyType()
      Get the policyType property: The type of policy set definition. Possible values are NotSpecified, BuiltIn, Custom, and Static.
      Returns:
      the policyType value.

    • withPolicyType

      public PolicySetDefinitionProperties withPolicyType(PolicyType policyType)
      Set the policyType property: The type of policy set definition. Possible values are NotSpecified, BuiltIn, Custom, and Static.
      Parameters:
      policyType - the policyType value to set.
      Returns:
      the PolicySetDefinitionProperties object itself.

    • displayName

      public String displayName()
      Get the displayName property: The display name of the policy set definition.
      Returns:
      the displayName value.

    • withDisplayName

      public PolicySetDefinitionProperties withDisplayName(String displayName)
      Set the displayName property: The display name of the policy set definition.
      Parameters:
      displayName - the displayName value to set.
      Returns:
      the PolicySetDefinitionProperties object itself.

    • description

      public String description()
      Get the description property: The policy set definition description.
      Returns:
      the description value.

    • withDescription

      public PolicySetDefinitionProperties withDescription(String description)
      Set the description property: The policy set definition description.
      Parameters:
      description - the description value to set.
      Returns:
      the PolicySetDefinitionProperties object itself.

    • metadata

      public Object metadata()
      Get the metadata property: The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs.
      Returns:
      the metadata value.

    • withMetadata

      public PolicySetDefinitionProperties withMetadata(Object metadata)
      Set the metadata property: The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs.
      Parameters:
      metadata - the metadata value to set.
      Returns:
      the PolicySetDefinitionProperties object itself.

    • parameters

      public Map<String,ParameterDefinitionsValue> parameters()
      Get the parameters property: The policy set definition parameters that can be used in policy definition references.
      Returns:
      the parameters value.

    • withParameters

      public PolicySetDefinitionProperties withParameters(Map<String,ParameterDefinitionsValue> parameters)
      Set the parameters property: The policy set definition parameters that can be used in policy definition references.
      Parameters:
      parameters - the parameters value to set.
      Returns:
      the PolicySetDefinitionProperties object itself.

    • policyDefinitions

      public List<PolicyDefinitionReference> policyDefinitions()
      Get the policyDefinitions property: An array of policy definition references.
      Returns:
      the policyDefinitions value.

    • withPolicyDefinitions

      public PolicySetDefinitionProperties withPolicyDefinitions(List<PolicyDefinitionReference> policyDefinitions)
      Set the policyDefinitions property: An array of policy definition references.
      Parameters:
      policyDefinitions - the policyDefinitions value to set.
      Returns:
      the PolicySetDefinitionProperties object itself.

    • policyDefinitionGroups

      public List<PolicyDefinitionGroup> policyDefinitionGroups()
      Get the policyDefinitionGroups property: The metadata describing groups of policy definition references within the policy set definition.
      Returns:
      the policyDefinitionGroups value.

    • withPolicyDefinitionGroups

      public PolicySetDefinitionProperties withPolicyDefinitionGroups(List<PolicyDefinitionGroup> policyDefinitionGroups)
      Set the policyDefinitionGroups property: The metadata describing groups of policy definition references within the policy set definition.
      Parameters:
      policyDefinitionGroups - the policyDefinitionGroups value to set.
      Returns:
      the PolicySetDefinitionProperties object itself.

    • version

      public String version()
      Get the version property: The policy set definition version in #.#.# format.
      Returns:
      the version value.

    • withVersion

      public PolicySetDefinitionProperties withVersion(String version)
      Set the version property: The policy set definition version in #.#.# format.
      Parameters:
      version - the version value to set.
      Returns:
      the PolicySetDefinitionProperties object itself.

    • versions

      public List<String> versions()
      Get the versions property: A list of available versions for this policy set definition.
      Returns:
      the versions value.

    • withVersions

      public PolicySetDefinitionProperties withVersions(List<String> versions)
      Set the versions property: A list of available versions for this policy set definition.
      Parameters:
      versions - the versions value to set.
      Returns:
      the PolicySetDefinitionProperties 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<PolicySetDefinitionProperties>
      Throws:
      IOException

    • fromJson

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