GatewayApiRoute Class

Package:

com.azure.resourcemanager.appplatform.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-appplatform:2.46.0

• java.lang.Object
• • com.azure.resourcemanager.appplatform.models.GatewayApiRoute

Implements

JsonSerializable<GatewayApiRoute>

public final class GatewayApiRoute
implements JsonSerializable<GatewayApiRoute>

API route config of the Spring Cloud Gateway.

Constructor Summary

Constructor	Description
GatewayApiRoute()	Creates an instance of GatewayApiRoute class.

Method Summary

Modifier and Type	Method and Description
String	description() Get the description property: A description, will be applied to methods in the generated OpenAPI documentation.
List<String>	filters() Get the filters property: To modify the request before sending it to the target endpoint, or the received response.
static GatewayApiRoute	fromJson(JsonReader jsonReader) Reads an instance of GatewayApiRoute from the JsonReader.
Integer	order() Get the order property: Route processing order.
List<String>	predicates() Get the predicates property: A number of conditions to evaluate a route for each request.
Boolean	ssoEnabled() Get the ssoEnabled property: Enable sso validation.
List<String>	tags() Get the tags property: Classification tags, will be applied to methods in the generated OpenAPI documentation.
String	title() Get the title property: A title, will be applied to methods in the generated OpenAPI documentation.
JsonWriter	toJson(JsonWriter jsonWriter)
Boolean	tokenRelay() Get the tokenRelay property: Pass currently-authenticated user's identity token to application service, default is 'false'.
String	uri() Get the uri property: Full uri, will override `appName`.
void	validate() Validates the instance.
GatewayApiRoute	withDescription(String description) Set the description property: A description, will be applied to methods in the generated OpenAPI documentation.
GatewayApiRoute	withFilters(List<String> filters) Set the filters property: To modify the request before sending it to the target endpoint, or the received response.
GatewayApiRoute	withOrder(Integer order) Set the order property: Route processing order.
GatewayApiRoute	withPredicates(List<String> predicates) Set the predicates property: A number of conditions to evaluate a route for each request.
GatewayApiRoute	withSsoEnabled(Boolean ssoEnabled) Set the ssoEnabled property: Enable sso validation.
GatewayApiRoute	withTags(List<String> tags) Set the tags property: Classification tags, will be applied to methods in the generated OpenAPI documentation.
GatewayApiRoute	withTitle(String title) Set the title property: A title, will be applied to methods in the generated OpenAPI documentation.
GatewayApiRoute	withTokenRelay(Boolean tokenRelay) Set the tokenRelay property: Pass currently-authenticated user's identity token to application service, default is 'false'.
GatewayApiRoute	withUri(String uri) Set the uri property: Full uri, will override `appName`.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

GatewayApiRoute

public GatewayApiRoute()

Creates an instance of GatewayApiRoute class.

Method Details

description

public String description()

Get the description property: A description, will be applied to methods in the generated OpenAPI documentation.

Returns:

the description value.

filters

public List filters()

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

Returns:

the filters value.

fromJson

public static GatewayApiRoute fromJson(JsonReader jsonReader)

Reads an instance of GatewayApiRoute from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

order

public Integer order()

Get the order property: Route processing order.

Returns:

the order value.

predicates

public List predicates()

Get the predicates property: A number of conditions to evaluate a route for each request. 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.

ssoEnabled

public Boolean ssoEnabled()

Get the ssoEnabled property: Enable sso validation.

Returns:

the ssoEnabled value.

tags

public List tags()

Get the tags property: Classification tags, will be applied to methods in the generated OpenAPI documentation.

Returns:

the tags value.

title

public String title()

Get the title property: A title, will be applied to methods in the generated OpenAPI documentation.

Returns:

the title value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

tokenRelay

public Boolean tokenRelay()

Get the tokenRelay property: Pass currently-authenticated user's identity token to application service, default is 'false'.

Returns:

the tokenRelay value.

uri

public String uri()

Get the uri property: Full uri, will override `appName`.

Returns:

the uri value.

validate

public void validate()

Validates the instance.

withDescription

public GatewayApiRoute withDescription(String description)

Set the description property: A description, will be applied to methods in the generated OpenAPI documentation.

Parameters:

description - the description value to set.

Returns:

the GatewayApiRoute object itself.

withFilters

public GatewayApiRoute withFilters(List filters)

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

Parameters:

filters - the filters value to set.

Returns:

the GatewayApiRoute object itself.

withOrder

public GatewayApiRoute withOrder(Integer order)

Set the order property: Route processing order.

Parameters:

order - the order value to set.

Returns:

the GatewayApiRoute object itself.

withPredicates

public GatewayApiRoute withPredicates(List predicates)

Set the predicates property: A number of conditions to evaluate a route for each request. 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 GatewayApiRoute object itself.

withSsoEnabled

public GatewayApiRoute withSsoEnabled(Boolean ssoEnabled)

Set the ssoEnabled property: Enable sso validation.

Parameters:

ssoEnabled - the ssoEnabled value to set.

Returns:

the GatewayApiRoute object itself.

withTags

public GatewayApiRoute withTags(List tags)

Set the tags property: Classification tags, will be applied to methods in the generated OpenAPI documentation.

Parameters:

tags - the tags value to set.

Returns:

the GatewayApiRoute object itself.

withTitle

public GatewayApiRoute withTitle(String title)

Set the title property: A title, will be applied to methods in the generated OpenAPI documentation.

Parameters:

title - the title value to set.

Returns:

the GatewayApiRoute object itself.

withTokenRelay

public GatewayApiRoute withTokenRelay(Boolean tokenRelay)

Set the tokenRelay property: Pass currently-authenticated user's identity token to application service, default is 'false'.

Parameters:

tokenRelay - the tokenRelay value to set.

Returns:

the GatewayApiRoute object itself.

withUri

public GatewayApiRoute withUri(String uri)

Set the uri property: Full uri, will override `appName`.

Parameters:

uri - the uri value to set.

Returns:

the GatewayApiRoute object itself.