Class NamedValueContractProperties

java.lang.Object
com.azure.resourcemanager.apimanagement.models.NamedValueEntityBaseParameters
com.azure.resourcemanager.apimanagement.fluent.models.NamedValueContractProperties
All Implemented Interfaces:
com.azure.json.JsonSerializable<NamedValueEntityBaseParameters>

public final class NamedValueContractProperties extends NamedValueEntityBaseParameters
NamedValue Contract properties.
  • Constructor Details

    • NamedValueContractProperties

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

    • displayName

      public String displayName()
      Get the displayName property: Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.
      Returns:
      the displayName value.
    • withDisplayName

      public NamedValueContractProperties withDisplayName(String displayName)
      Set the displayName property: Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.
      Parameters:
      displayName - the displayName value to set.
      Returns:
      the NamedValueContractProperties object itself.
    • value

      public String value()
      Get the value property: Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
      Returns:
      the value value.
    • withValue

      public NamedValueContractProperties withValue(String value)
      Set the value property: Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
      Parameters:
      value - the value value to set.
      Returns:
      the NamedValueContractProperties object itself.
    • keyVault

      public KeyVaultContractProperties keyVault()
      Get the keyVault property: KeyVault location details of the namedValue.
      Returns:
      the keyVault value.
    • withKeyVault

      Set the keyVault property: KeyVault location details of the namedValue.
      Parameters:
      keyVault - the keyVault value to set.
      Returns:
      the NamedValueContractProperties object itself.
    • provisioningState

      public String provisioningState()
      Get the provisioningState property: The provisioning state.
      Returns:
      the provisioningState value.
    • withTags

      public NamedValueContractProperties withTags(List<String> tags)
      Set the tags property: Optional tags that when provided can be used to filter the NamedValue list.
      Overrides:
      withTags in class NamedValueEntityBaseParameters
      Parameters:
      tags - the tags value to set.
      Returns:
      the NamedValueEntityBaseParameters object itself.
    • withSecret

      public NamedValueContractProperties withSecret(Boolean secret)
      Set the secret property: Determines whether the value is a secret and should be encrypted or not. Default value is false.
      Overrides:
      withSecret in class NamedValueEntityBaseParameters
      Parameters:
      secret - the secret value to set.
      Returns:
      the NamedValueEntityBaseParameters object itself.
    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class NamedValueEntityBaseParameters
      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<NamedValueEntityBaseParameters>
      Overrides:
      toJson in class NamedValueEntityBaseParameters
      Throws:
      IOException
    • fromJson

      public static NamedValueContractProperties fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of NamedValueContractProperties from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of NamedValueContractProperties 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 NamedValueContractProperties.