Package com.azure.resourcemanager.apicenter.models

Class ExternalDocumentation

java.lang.Object
com.azure.resourcemanager.apicenter.models.ExternalDocumentation
All Implemented Interfaces:
com.azure.json.JsonSerializable<ExternalDocumentation>
public final class ExternalDocumentation extends Object implements com.azure.json.JsonSerializable<ExternalDocumentation>
Additional, external documentation for the API.

  • Constructor Details

    • ExternalDocumentation

      public ExternalDocumentation()
      Creates an instance of ExternalDocumentation class.

  • Method Details

    • title

      public String title()
      Get the title property: Title of the documentation.
      Returns:
      the title value.

    • withTitle

      public ExternalDocumentation withTitle(String title)
      Set the title property: Title of the documentation.
      Parameters:
      title - the title value to set.
      Returns:
      the ExternalDocumentation object itself.

    • description

      public String description()
      Get the description property: Description of the documentation.
      Returns:
      the description value.

    • withDescription

      public ExternalDocumentation withDescription(String description)
      Set the description property: Description of the documentation.
      Parameters:
      description - the description value to set.
      Returns:
      the ExternalDocumentation object itself.

    • url

      public String url()
      Get the url property: URL pointing to the documentation.
      Returns:
      the url value.

    • withUrl

      public ExternalDocumentation withUrl(String url)
      Set the url property: URL pointing to the documentation.
      Parameters:
      url - the url value to set.
      Returns:
      the ExternalDocumentation 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<ExternalDocumentation>
      Throws:
      IOException

    • fromJson

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