Package com.azure.resourcemanager.apicenter.models

Class ApiDefinitionProperties

java.lang.Object
com.azure.resourcemanager.apicenter.models.ApiDefinitionProperties
All Implemented Interfaces:
com.azure.json.JsonSerializable<ApiDefinitionProperties>
public final class ApiDefinitionProperties extends Object implements com.azure.json.JsonSerializable<ApiDefinitionProperties>
API definition properties entity.

  • Constructor Details

    • ApiDefinitionProperties

      public ApiDefinitionProperties()
      Creates an instance of ApiDefinitionProperties class.

  • Method Details

    • title

      public String title()
      Get the title property: API definition title.
      Returns:
      the title value.

    • withTitle

      public ApiDefinitionProperties withTitle(String title)
      Set the title property: API definition title.
      Parameters:
      title - the title value to set.
      Returns:
      the ApiDefinitionProperties object itself.

    • description

      public String description()
      Get the description property: API definition description.
      Returns:
      the description value.

    • withDescription

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

    • specification

      public ApiDefinitionPropertiesSpecification specification()
      Get the specification property: API specification details.
      Returns:
      the specification value.

    • 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<ApiDefinitionProperties>
      Throws:
      IOException

    • fromJson

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