Package com.azure.resourcemanager.apimanagement.fluent.models

Class TagDescriptionContractProperties

java.lang.Object
com.azure.resourcemanager.apimanagement.fluent.models.TagDescriptionBaseProperties
com.azure.resourcemanager.apimanagement.fluent.models.TagDescriptionContractProperties
All Implemented Interfaces:
com.azure.json.JsonSerializable<TagDescriptionBaseProperties>
public final class TagDescriptionContractProperties extends TagDescriptionBaseProperties
TagDescription contract Properties.

  • Constructor Details

    • TagDescriptionContractProperties

      public TagDescriptionContractProperties()
      Creates an instance of TagDescriptionContractProperties class.

  • Method Details

    • tagId

      public String tagId()
      Get the tagId property: Identifier of the tag in the form of /tags/{tagId}.
      Returns:
      the tagId value.

    • withTagId

      public TagDescriptionContractProperties withTagId(String tagId)
      Set the tagId property: Identifier of the tag in the form of /tags/{tagId}.
      Parameters:
      tagId - the tagId value to set.
      Returns:
      the TagDescriptionContractProperties object itself.

    • displayName

      public String displayName()
      Get the displayName property: Tag name.
      Returns:
      the displayName value.

    • withDisplayName

      public TagDescriptionContractProperties withDisplayName(String displayName)
      Set the displayName property: Tag name.
      Parameters:
      displayName - the displayName value to set.
      Returns:
      the TagDescriptionContractProperties object itself.

    • withDescription

      public TagDescriptionContractProperties withDescription(String description)
      Set the description property: Description of the Tag.
      Overrides:
      withDescription in class TagDescriptionBaseProperties
      Parameters:
      description - the description value to set.
      Returns:
      the TagDescriptionBaseProperties object itself.

    • withExternalDocsUrl

      public TagDescriptionContractProperties withExternalDocsUrl(String externalDocsUrl)
      Set the externalDocsUrl property: Absolute URL of external resources describing the tag.
      Overrides:
      withExternalDocsUrl in class TagDescriptionBaseProperties
      Parameters:
      externalDocsUrl - the externalDocsUrl value to set.
      Returns:
      the TagDescriptionBaseProperties object itself.

    • withExternalDocsDescription

      public TagDescriptionContractProperties withExternalDocsDescription(String externalDocsDescription)
      Set the externalDocsDescription property: Description of the external resources describing the tag.
      Overrides:
      withExternalDocsDescription in class TagDescriptionBaseProperties
      Parameters:
      externalDocsDescription - the externalDocsDescription value to set.
      Returns:
      the TagDescriptionBaseProperties object itself.

    • validate

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

    • fromJson

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