Package com.azure.resourcemanager.appplatform.models

Class GatewayApiMetadataProperties

java.lang.Object
com.azure.resourcemanager.appplatform.models.GatewayApiMetadataProperties
public final class GatewayApiMetadataProperties extends Object
API metadata property for Spring Cloud Gateway.

  • Constructor Details

    • GatewayApiMetadataProperties

      public GatewayApiMetadataProperties()

  • Method Details

    • title

      public String title()
      Get the title property: Title describing the context of the APIs available on the Gateway instance (default: `Spring Cloud Gateway for K8S`).
      Returns:
      the title value.

    • withTitle

      public GatewayApiMetadataProperties withTitle(String title)
      Set the title property: Title describing the context of the APIs available on the Gateway instance (default: `Spring Cloud Gateway for K8S`).
      Parameters:
      title - the title value to set.
      Returns:
      the GatewayApiMetadataProperties object itself.

    • description

      public String description()
      Get the description property: Detailed description of the APIs available on the Gateway instance (default: `Generated OpenAPI 3 document that describes the API routes configured.`).
      Returns:
      the description value.

    • withDescription

      public GatewayApiMetadataProperties withDescription(String description)
      Set the description property: Detailed description of the APIs available on the Gateway instance (default: `Generated OpenAPI 3 document that describes the API routes configured.`).
      Parameters:
      description - the description value to set.
      Returns:
      the GatewayApiMetadataProperties object itself.

    • documentation

      public String documentation()
      Get the documentation property: Location of additional documentation for the APIs available on the Gateway instance.
      Returns:
      the documentation value.

    • withDocumentation

      public GatewayApiMetadataProperties withDocumentation(String documentation)
      Set the documentation property: Location of additional documentation for the APIs available on the Gateway instance.
      Parameters:
      documentation - the documentation value to set.
      Returns:
      the GatewayApiMetadataProperties object itself.

    • version

      public String version()
      Get the version property: Version of APIs available on this Gateway instance (default: `unspecified`).
      Returns:
      the version value.

    • withVersion

      public GatewayApiMetadataProperties withVersion(String version)
      Set the version property: Version of APIs available on this Gateway instance (default: `unspecified`).
      Parameters:
      version - the version value to set.
      Returns:
      the GatewayApiMetadataProperties object itself.

    • serverUrl

      public String serverUrl()
      Get the serverUrl property: Base URL that API consumers will use to access APIs on the Gateway instance.
      Returns:
      the serverUrl value.

    • withServerUrl

      public GatewayApiMetadataProperties withServerUrl(String serverUrl)
      Set the serverUrl property: Base URL that API consumers will use to access APIs on the Gateway instance.
      Parameters:
      serverUrl - the serverUrl value to set.
      Returns:
      the GatewayApiMetadataProperties object itself.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.