Package com.azure.resourcemanager.apicenter.models

Class EnvironmentProperties

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

  • Constructor Details

    • EnvironmentProperties

      public EnvironmentProperties()
      Creates an instance of EnvironmentProperties class.

  • Method Details

    • title

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

    • withTitle

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

    • description

      public String description()
      Get the description property: The environment description.
      Returns:
      the description value.

    • withDescription

      public EnvironmentProperties withDescription(String description)
      Set the description property: The environment description.
      Parameters:
      description - the description value to set.
      Returns:
      the EnvironmentProperties object itself.

    • kind

      public EnvironmentKind kind()
      Get the kind property: Environment kind.
      Returns:
      the kind value.

    • withKind

      public EnvironmentProperties withKind(EnvironmentKind kind)
      Set the kind property: Environment kind.
      Parameters:
      kind - the kind value to set.
      Returns:
      the EnvironmentProperties object itself.

    • server

      public EnvironmentServer server()
      Get the server property: Server information of the environment.
      Returns:
      the server value.

    • withServer

      public EnvironmentProperties withServer(EnvironmentServer server)
      Set the server property: Server information of the environment.
      Parameters:
      server - the server value to set.
      Returns:
      the EnvironmentProperties object itself.

    • onboarding

      public Onboarding onboarding()
      Get the onboarding property: Environment onboarding information.
      Returns:
      the onboarding value.

    • withOnboarding

      public EnvironmentProperties withOnboarding(Onboarding onboarding)
      Set the onboarding property: Environment onboarding information.
      Parameters:
      onboarding - the onboarding value to set.
      Returns:
      the EnvironmentProperties object itself.

    • customProperties

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

    • withCustomProperties

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

    • fromJson

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