Package com.azure.resourcemanager.apicenter.models

Class DeploymentProperties

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

  • Constructor Details

    • DeploymentProperties

      public DeploymentProperties()
      Creates an instance of DeploymentProperties class.

  • Method Details

    • title

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

    • withTitle

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

    • description

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

    • withDescription

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

    • environmentId

      public String environmentId()
      Get the environmentId property: API center-scoped environment resource ID.
      Returns:
      the environmentId value.

    • withEnvironmentId

      public DeploymentProperties withEnvironmentId(String environmentId)
      Set the environmentId property: API center-scoped environment resource ID.
      Parameters:
      environmentId - the environmentId value to set.
      Returns:
      the DeploymentProperties object itself.

    • definitionId

      public String definitionId()
      Get the definitionId property: API center-scoped definition resource ID.
      Returns:
      the definitionId value.

    • withDefinitionId

      public DeploymentProperties withDefinitionId(String definitionId)
      Set the definitionId property: API center-scoped definition resource ID.
      Parameters:
      definitionId - the definitionId value to set.
      Returns:
      the DeploymentProperties object itself.

    • state

      public DeploymentState state()
      Get the state property: State of API deployment.
      Returns:
      the state value.

    • withState

      public DeploymentProperties withState(DeploymentState state)
      Set the state property: State of API deployment.
      Parameters:
      state - the state value to set.
      Returns:
      the DeploymentProperties object itself.

    • server

      public DeploymentServer server()
      Get the server property: The deployment server.
      Returns:
      the server value.

    • withServer

      public DeploymentProperties withServer(DeploymentServer server)
      Set the server property: The deployment server.
      Parameters:
      server - the server value to set.
      Returns:
      the DeploymentProperties object itself.

    • customProperties

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

    • withCustomProperties

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

    • fromJson

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