Share via

GatewayRouteConfigProperties 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.GatewayRouteConfigProperties

Implements

JsonSerializable<GatewayRouteConfigProperties>

public final class GatewayRouteConfigProperties
implements JsonSerializable<GatewayRouteConfigProperties>

API route config of the Spring Cloud Gateway.

Constructor Summary

Constructor Description
GatewayRouteConfigProperties()

Creates an instance of GatewayRouteConfigProperties class.

Method Summary

Modifier and Type Method and Description
String appResourceId()

Get the appResourceId property: The resource Id of the Azure Spring Apps app, required unless route defines `uri`.
List<String> filters()

Get the filters property: To modify the request before sending it to the target endpoint, or the received response in app level.
static GatewayRouteConfigProperties fromJson(JsonReader jsonReader)

Reads an instance of GatewayRouteConfigProperties from the JsonReader.
GatewayRouteConfigOpenApiProperties openApi()

Get the openApi property: OpenAPI properties of Spring Cloud Gateway route config.
List<String> predicates()

Get the predicates property: A number of conditions to evaluate a route for each request in app level.
GatewayRouteConfigProtocol protocol()

Get the protocol property: Protocol of routed Azure Spring Apps applications.
GatewayProvisioningState provisioningState()

Get the provisioningState property: State of the Spring Cloud Gateway route config.
List<GatewayApiRoute> routes()

Get the routes property: Array of API routes, each route contains properties such as `title`, `uri`, `ssoEnabled`, `predicates`, `filters`.
Boolean ssoEnabled()

Get the ssoEnabled property: Enable Single Sign-On in app level.
JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.
GatewayRouteConfigProperties withAppResourceId(String appResourceId)

Set the appResourceId property: The resource Id of the Azure Spring Apps app, required unless route defines `uri`.
GatewayRouteConfigProperties withFilters(List<String> filters)

Set the filters property: To modify the request before sending it to the target endpoint, or the received response in app level.
GatewayRouteConfigProperties withOpenApi(GatewayRouteConfigOpenApiProperties openApi)

Set the openApi property: OpenAPI properties of Spring Cloud Gateway route config.
GatewayRouteConfigProperties withPredicates(List<String> predicates)

Set the predicates property: A number of conditions to evaluate a route for each request in app level.
GatewayRouteConfigProperties withProtocol(GatewayRouteConfigProtocol protocol)

Set the protocol property: Protocol of routed Azure Spring Apps applications.
GatewayRouteConfigProperties withRoutes(List<GatewayApiRoute> routes)

Set the routes property: Array of API routes, each route contains properties such as `title`, `uri`, `ssoEnabled`, `predicates`, `filters`.
GatewayRouteConfigProperties withSsoEnabled(Boolean ssoEnabled)

Set the ssoEnabled property: Enable Single Sign-On in app level.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

GatewayRouteConfigProperties

public GatewayRouteConfigProperties()

Creates an instance of GatewayRouteConfigProperties class.

Method Details

appResourceId

public String appResourceId()

Get the appResourceId property: The resource Id of the Azure Spring Apps app, required unless route defines `uri`.

Returns:

the appResourceId value.

filters

public List filters()

Get the filters property: To modify the request before sending it to the target endpoint, or the received response in app level.

Returns:

the filters value.

fromJson

public static GatewayRouteConfigProperties fromJson(JsonReader jsonReader)

Reads an instance of GatewayRouteConfigProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

openApi

public GatewayRouteConfigOpenApiProperties openApi()

Get the openApi property: OpenAPI properties of Spring Cloud Gateway route config.

Returns:

the openApi value.

predicates

public List predicates()

Get the predicates property: A number of conditions to evaluate a route for each request in app level. Each predicate may be evaluated against request headers and parameter values. All of the predicates associated with a route must evaluate to true for the route to be matched to the request.

Returns:

the predicates value.

protocol

public GatewayRouteConfigProtocol protocol()

Get the protocol property: Protocol of routed Azure Spring Apps applications.

Returns:

the protocol value.

provisioningState

public GatewayProvisioningState provisioningState()

Get the provisioningState property: State of the Spring Cloud Gateway route config.

Returns:

the provisioningState value.

routes

public List routes()

Get the routes property: Array of API routes, each route contains properties such as `title`, `uri`, `ssoEnabled`, `predicates`, `filters`.

Returns:

the routes value.

ssoEnabled

public Boolean ssoEnabled()

Get the ssoEnabled property: Enable Single Sign-On in app level.

Returns:

the ssoEnabled value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

withAppResourceId

public GatewayRouteConfigProperties withAppResourceId(String appResourceId)

Set the appResourceId property: The resource Id of the Azure Spring Apps app, required unless route defines `uri`.

Parameters:

appResourceId - the appResourceId value to set.

Returns:

the GatewayRouteConfigProperties object itself.

withFilters

public GatewayRouteConfigProperties withFilters(List filters)

Set the filters property: To modify the request before sending it to the target endpoint, or the received response in app level.

Parameters:

filters - the filters value to set.

Returns:

the GatewayRouteConfigProperties object itself.

withOpenApi

public GatewayRouteConfigProperties withOpenApi(GatewayRouteConfigOpenApiProperties openApi)

Set the openApi property: OpenAPI properties of Spring Cloud Gateway route config.

Parameters:

openApi - the openApi value to set.

Returns:

the GatewayRouteConfigProperties object itself.

withPredicates

public GatewayRouteConfigProperties withPredicates(List predicates)

Set the predicates property: A number of conditions to evaluate a route for each request in app level. Each predicate may be evaluated against request headers and parameter values. All of the predicates associated with a route must evaluate to true for the route to be matched to the request.

Parameters:

predicates - the predicates value to set.

Returns:

the GatewayRouteConfigProperties object itself.

withProtocol

public GatewayRouteConfigProperties withProtocol(GatewayRouteConfigProtocol protocol)

Set the protocol property: Protocol of routed Azure Spring Apps applications.

Parameters:

protocol - the protocol value to set.

Returns:

the GatewayRouteConfigProperties object itself.

withRoutes

public GatewayRouteConfigProperties withRoutes(List routes)

Set the routes property: Array of API routes, each route contains properties such as `title`, `uri`, `ssoEnabled`, `predicates`, `filters`.

Parameters:

routes - the routes value to set.

Returns:

the GatewayRouteConfigProperties object itself.

withSsoEnabled

public GatewayRouteConfigProperties withSsoEnabled(Boolean ssoEnabled)

Set the ssoEnabled property: Enable Single Sign-On in app level.

Parameters:

ssoEnabled - the ssoEnabled value to set.

Returns:

the GatewayRouteConfigProperties object itself.

Applies to