Package com.azure.resourcemanager.apicenter.models

Class ApiProperties

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

  • Constructor Details

    • ApiProperties

      public ApiProperties()
      Creates an instance of ApiProperties class.

  • Method Details

    • title

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

    • withTitle

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

    • kind

      public ApiKind kind()
      Get the kind property: Kind of API. For example, REST or GraphQL.
      Returns:
      the kind value.

    • withKind

      public ApiProperties withKind(ApiKind kind)
      Set the kind property: Kind of API. For example, REST or GraphQL.
      Parameters:
      kind - the kind value to set.
      Returns:
      the ApiProperties object itself.

    • description

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

    • withDescription

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

    • summary

      public String summary()
      Get the summary property: Short description of the API.
      Returns:
      the summary value.

    • withSummary

      public ApiProperties withSummary(String summary)
      Set the summary property: Short description of the API.
      Parameters:
      summary - the summary value to set.
      Returns:
      the ApiProperties object itself.

    • lifecycleStage

      public LifecycleStage lifecycleStage()
      Get the lifecycleStage property: Current lifecycle stage of the API.
      Returns:
      the lifecycleStage value.

    • termsOfService

      public TermsOfService termsOfService()
      Get the termsOfService property: Terms of service for the API.
      Returns:
      the termsOfService value.

    • withTermsOfService

      public ApiProperties withTermsOfService(TermsOfService termsOfService)
      Set the termsOfService property: Terms of service for the API.
      Parameters:
      termsOfService - the termsOfService value to set.
      Returns:
      the ApiProperties object itself.

    • externalDocumentation

      public List<ExternalDocumentation> externalDocumentation()
      Get the externalDocumentation property: The set of external documentation.
      Returns:
      the externalDocumentation value.

    • withExternalDocumentation

      public ApiProperties withExternalDocumentation(List<ExternalDocumentation> externalDocumentation)
      Set the externalDocumentation property: The set of external documentation.
      Parameters:
      externalDocumentation - the externalDocumentation value to set.
      Returns:
      the ApiProperties object itself.

    • contacts

      public List<Contact> contacts()
      Get the contacts property: The set of contacts.
      Returns:
      the contacts value.

    • withContacts

      public ApiProperties withContacts(List<Contact> contacts)
      Set the contacts property: The set of contacts.
      Parameters:
      contacts - the contacts value to set.
      Returns:
      the ApiProperties object itself.

    • license

      public License license()
      Get the license property: The license information for the API.
      Returns:
      the license value.

    • withLicense

      public ApiProperties withLicense(License license)
      Set the license property: The license information for the API.
      Parameters:
      license - the license value to set.
      Returns:
      the ApiProperties object itself.

    • customProperties

      public Object customProperties()
      Get the customProperties property: The custom metadata defined for API catalog entities.
      Returns:
      the customProperties value.

    • withCustomProperties

      public ApiProperties withCustomProperties(Object customProperties)
      Set the customProperties property: The custom metadata defined for API catalog entities.
      Parameters:
      customProperties - the customProperties value to set.
      Returns:
      the ApiProperties 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<ApiProperties>
      Throws:
      IOException

    • fromJson

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