Package com.azure.resourcemanager.appplatform.models

Class GatewayApiRoute

java.lang.Object
com.azure.resourcemanager.appplatform.models.GatewayApiRoute
All Implemented Interfaces:
com.azure.json.JsonSerializable<GatewayApiRoute>
public final class GatewayApiRoute extends Object implements com.azure.json.JsonSerializable<GatewayApiRoute>
API route config of the Spring Cloud Gateway.

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    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(com.azure.json.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.
    com.azure.json.JsonWriter
    toJson(com.azure.json.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 class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString

  • Constructor Details

    • GatewayApiRoute

      public GatewayApiRoute()
      Creates an instance of GatewayApiRoute class.

  • Method Details

    • title

      public String title()
      Get the title property: A title, will be applied to methods in the generated OpenAPI documentation.
      Returns:
      the title value.

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

    • description

      public String description()
      Get the description property: A description, will be applied to methods in the generated OpenAPI documentation.
      Returns:
      the description value.

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

    • uri

      public String uri()
      Get the uri property: Full uri, will override `appName`.
      Returns:
      the uri value.

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

    • ssoEnabled

      public Boolean ssoEnabled()
      Get the ssoEnabled property: Enable sso validation.
      Returns:
      the ssoEnabled value.

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

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

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

    • predicates

      public List<String> 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.

    • withPredicates

      public GatewayApiRoute withPredicates(List<String> 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.

    • filters

      public List<String> filters()
      Get the filters property: To modify the request before sending it to the target endpoint, or the received response.
      Returns:
      the filters value.

    • withFilters

      public GatewayApiRoute withFilters(List<String> 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.

    • order

      public Integer order()
      Get the order property: Route processing order.
      Returns:
      the order value.

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

    • tags

      public List<String> tags()
      Get the tags property: Classification tags, will be applied to methods in the generated OpenAPI documentation.
      Returns:
      the tags value.

    • withTags

      public GatewayApiRoute withTags(List<String> 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.

    • validate

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

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<GatewayApiRoute>
      Throws:
      IOException

    • fromJson

      public static GatewayApiRoute fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      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.