Package com.azure.resourcemanager.appplatform.models

Class GatewayRouteConfigProperties

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

  • Constructor Details

    • GatewayRouteConfigProperties

      public GatewayRouteConfigProperties()
      Creates an instance of GatewayRouteConfigProperties class.

  • Method Details

    • provisioningState

      public GatewayProvisioningState provisioningState()
      Get the provisioningState property: State of the Spring Cloud Gateway route config.
      Returns:
      the provisioningState value.

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

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

    • openApi

      public GatewayRouteConfigOpenApiProperties openApi()
      Get the openApi property: OpenAPI properties of Spring Cloud Gateway route config.
      Returns:
      the openApi value.

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

    • protocol

      public GatewayRouteConfigProtocol protocol()
      Get the protocol property: Protocol of routed Azure Spring Apps applications.
      Returns:
      the protocol value.

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

    • routes

      public List<GatewayApiRoute> routes()
      Get the routes property: Array of API routes, each route contains properties such as `title`, `uri`, `ssoEnabled`, `predicates`, `filters`.
      Returns:
      the routes value.

    • withRoutes

      public GatewayRouteConfigProperties withRoutes(List<GatewayApiRoute> 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.

    • ssoEnabled

      public Boolean ssoEnabled()
      Get the ssoEnabled property: Enable Single Sign-On in app level.
      Returns:
      the ssoEnabled value.

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

    • predicates

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

    • withPredicates

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

    • filters

      public 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.
      Returns:
      the filters value.

    • withFilters

      public 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.
      Parameters:
      filters - the filters value to set.
      Returns:
      the GatewayRouteConfigProperties 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<GatewayRouteConfigProperties>
      Throws:
      IOException

    • fromJson

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