Share via

GatewayApiMetadataProperties Class

  • Reference
Package:
com.azure.resourcemanager.appplatform.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-appplatform:2.44.0
  • java.lang.Object
    • com.azure.resourcemanager.appplatform.models.GatewayApiMetadataProperties

Implements

JsonSerializable<GatewayApiMetadataProperties>

public final class GatewayApiMetadataProperties
implements JsonSerializable<GatewayApiMetadataProperties>

API metadata property for Spring Cloud Gateway.

Constructor Summary

Constructor Description
GatewayApiMetadataProperties()

Creates an instance of GatewayApiMetadataProperties class.

Method Summary

Modifier and Type Method and Description
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.`).
String documentation()

Get the documentation property: Location of additional documentation for the APIs available on the Gateway instance.
static GatewayApiMetadataProperties fromJson(JsonReader jsonReader)

Reads an instance of GatewayApiMetadataProperties from the JsonReader.
String serverUrl()

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

Get the title property: Title describing the context of the APIs available on the Gateway instance (default: `Spring Cloud Gateway for K8S`).
JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.
String version()

Get the version property: Version of APIs available on this Gateway instance (default: `unspecified`).
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.`).
GatewayApiMetadataProperties withDocumentation(String documentation)

Set the documentation property: Location of additional documentation for the APIs available on the Gateway instance.
GatewayApiMetadataProperties withServerUrl(String serverUrl)

Set the serverUrl property: Base URL that API consumers will use to access APIs on the Gateway instance.
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`).
GatewayApiMetadataProperties withVersion(String version)

Set the version property: Version of APIs available on this Gateway instance (default: `unspecified`).

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

GatewayApiMetadataProperties

public GatewayApiMetadataProperties()

Creates an instance of GatewayApiMetadataProperties class.

Method Details

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.

documentation

public String documentation()

Get the documentation property: Location of additional documentation for the APIs available on the Gateway instance.

Returns:

the documentation value.

fromJson

public static GatewayApiMetadataProperties fromJson(JsonReader jsonReader)

Reads an instance of GatewayApiMetadataProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of GatewayApiMetadataProperties 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 GatewayApiMetadataProperties.

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.

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.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

version

public String version()

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

Returns:

the version 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.

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.

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.

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.

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.

Applies to