GatewayApiRouteResponse

data class GatewayApiRouteResponse(val description: String? = null, val filters: List<String>? = null, val order: Int? = null, val predicates: List<String>? = null, val ssoEnabled: Boolean? = null, val tags: List<String>? = null, val title: String? = null, val tokenRelay: Boolean? = null, val uri: String? = null)

API route config of the Spring Cloud Gateway

Constructors

Link copied to clipboard
constructor(description: String? = null, filters: List<String>? = null, order: Int? = null, predicates: List<String>? = null, ssoEnabled: Boolean? = null, tags: List<String>? = null, title: String? = null, tokenRelay: Boolean? = null, uri: String? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val description: String? = null

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

Link copied to clipboard
val filters: List<String>? = null

To modify the request before sending it to the target endpoint, or the received response.

Link copied to clipboard
val order: Int? = null

Route processing order.

Link copied to clipboard
val predicates: List<String>? = null

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.

Link copied to clipboard
val ssoEnabled: Boolean? = null

Enable sso validation.

Link copied to clipboard
val tags: List<String>? = null

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

Link copied to clipboard
val title: String? = null

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

Link copied to clipboard
val tokenRelay: Boolean? = null

Pass currently-authenticated user's identity token to application service, default is 'false'

Link copied to clipboard
val uri: String? = null

Full uri, will override appName.