Package com.google.cloud.compute.v1

Interface HttpRouteActionOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
HttpRouteAction, HttpRouteAction.Builder
@Generated public interface HttpRouteActionOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasCachePolicy

      boolean hasCachePolicy()
       Specifies the cache policy configuration for matched traffic. Available
 only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one
 property must be specified. This policy cannot be specified if any target
 backend has Identity-Aware Proxy enabled.
      optional .google.cloud.compute.v1.CachePolicy cache_policy = 457366671;
      Returns:
      Whether the cachePolicy field is set.

    • getCachePolicy

      CachePolicy getCachePolicy()
       Specifies the cache policy configuration for matched traffic. Available
 only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one
 property must be specified. This policy cannot be specified if any target
 backend has Identity-Aware Proxy enabled.
      optional .google.cloud.compute.v1.CachePolicy cache_policy = 457366671;
      Returns:
      The cachePolicy.

    • getCachePolicyOrBuilder

      CachePolicyOrBuilder getCachePolicyOrBuilder()
       Specifies the cache policy configuration for matched traffic. Available
 only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one
 property must be specified. This policy cannot be specified if any target
 backend has Identity-Aware Proxy enabled.
      optional .google.cloud.compute.v1.CachePolicy cache_policy = 457366671;

    • hasCorsPolicy

      boolean hasCorsPolicy()
       The specification for allowing client-side cross-origin requests. For more
 information about the W3C recommendation for cross-origin resource sharing
 (CORS), see Fetch API Living
 Standard.

 Not supported when the URL map is bound to a target gRPC proxy.
      optional .google.cloud.compute.v1.CorsPolicy cors_policy = 398943748;
      Returns:
      Whether the corsPolicy field is set.

    • getCorsPolicy

      CorsPolicy getCorsPolicy()
       The specification for allowing client-side cross-origin requests. For more
 information about the W3C recommendation for cross-origin resource sharing
 (CORS), see Fetch API Living
 Standard.

 Not supported when the URL map is bound to a target gRPC proxy.
      optional .google.cloud.compute.v1.CorsPolicy cors_policy = 398943748;
      Returns:
      The corsPolicy.

    • getCorsPolicyOrBuilder

      CorsPolicyOrBuilder getCorsPolicyOrBuilder()
       The specification for allowing client-side cross-origin requests. For more
 information about the W3C recommendation for cross-origin resource sharing
 (CORS), see Fetch API Living
 Standard.

 Not supported when the URL map is bound to a target gRPC proxy.
      optional .google.cloud.compute.v1.CorsPolicy cors_policy = 398943748;

    • hasFaultInjectionPolicy

      boolean hasFaultInjectionPolicy()
       The specification for fault injection introduced into traffic to test
 the resiliency of clients to backend service failure. As part of fault
 injection, when clients send requests to a backend service, delays can be
 introduced by a load balancer on a percentage of requests before sending
 those requests to the backend service. Similarly requests from clients can
 be aborted by the load balancer for a percentage of requests.timeout and retry_policy is ignored by clients
 that are configured with a fault_injection_policy if:
 1. The traffic is generated by fault injection AND
 2. The fault injection is not a delay fault injection.
 Fault injection is not supported with the classic Application Load Balancer
 . To see which load balancers support fault injection,
 see Load
 balancing: Routing and traffic management features.
      optional .google.cloud.compute.v1.HttpFaultInjection fault_injection_policy = 412781079;
      Returns:
      Whether the faultInjectionPolicy field is set.

    • getFaultInjectionPolicy

      HttpFaultInjection getFaultInjectionPolicy()
       The specification for fault injection introduced into traffic to test
 the resiliency of clients to backend service failure. As part of fault
 injection, when clients send requests to a backend service, delays can be
 introduced by a load balancer on a percentage of requests before sending
 those requests to the backend service. Similarly requests from clients can
 be aborted by the load balancer for a percentage of requests.timeout and retry_policy is ignored by clients
 that are configured with a fault_injection_policy if:
 1. The traffic is generated by fault injection AND
 2. The fault injection is not a delay fault injection.
 Fault injection is not supported with the classic Application Load Balancer
 . To see which load balancers support fault injection,
 see Load
 balancing: Routing and traffic management features.
      optional .google.cloud.compute.v1.HttpFaultInjection fault_injection_policy = 412781079;
      Returns:
      The faultInjectionPolicy.

    • getFaultInjectionPolicyOrBuilder

      HttpFaultInjectionOrBuilder getFaultInjectionPolicyOrBuilder()
       The specification for fault injection introduced into traffic to test
 the resiliency of clients to backend service failure. As part of fault
 injection, when clients send requests to a backend service, delays can be
 introduced by a load balancer on a percentage of requests before sending
 those requests to the backend service. Similarly requests from clients can
 be aborted by the load balancer for a percentage of requests.timeout and retry_policy is ignored by clients
 that are configured with a fault_injection_policy if:
 1. The traffic is generated by fault injection AND
 2. The fault injection is not a delay fault injection.
 Fault injection is not supported with the classic Application Load Balancer
 . To see which load balancers support fault injection,
 see Load
 balancing: Routing and traffic management features.
      optional .google.cloud.compute.v1.HttpFaultInjection fault_injection_policy = 412781079;

    • hasMaxStreamDuration

      boolean hasMaxStreamDuration()
       Specifies the maximum duration (timeout) for streams on the selected route.
 Unlike the timeout field where the timeout duration starts
 from the time the request has been fully processed (known as*end-of-stream*),
 the duration in this field is computed from the beginning of the stream
 until the response has been processed, including all retries. A
 stream that does not complete in this duration is closed.

 If not specified, this field uses the maximummaxStreamDuration value among all backend services associated
 with the route.

 This field is only allowed if the Url map is used with backend services
 with loadBalancingScheme set toINTERNAL_SELF_MANAGED.
      optional .google.cloud.compute.v1.Duration max_stream_duration = 61428376;
      Returns:
      Whether the maxStreamDuration field is set.

    • getMaxStreamDuration

      Duration getMaxStreamDuration()
       Specifies the maximum duration (timeout) for streams on the selected route.
 Unlike the timeout field where the timeout duration starts
 from the time the request has been fully processed (known as*end-of-stream*),
 the duration in this field is computed from the beginning of the stream
 until the response has been processed, including all retries. A
 stream that does not complete in this duration is closed.

 If not specified, this field uses the maximummaxStreamDuration value among all backend services associated
 with the route.

 This field is only allowed if the Url map is used with backend services
 with loadBalancingScheme set toINTERNAL_SELF_MANAGED.
      optional .google.cloud.compute.v1.Duration max_stream_duration = 61428376;
      Returns:
      The maxStreamDuration.

    • getMaxStreamDurationOrBuilder

      DurationOrBuilder getMaxStreamDurationOrBuilder()
       Specifies the maximum duration (timeout) for streams on the selected route.
 Unlike the timeout field where the timeout duration starts
 from the time the request has been fully processed (known as*end-of-stream*),
 the duration in this field is computed from the beginning of the stream
 until the response has been processed, including all retries. A
 stream that does not complete in this duration is closed.

 If not specified, this field uses the maximummaxStreamDuration value among all backend services associated
 with the route.

 This field is only allowed if the Url map is used with backend services
 with loadBalancingScheme set toINTERNAL_SELF_MANAGED.
      optional .google.cloud.compute.v1.Duration max_stream_duration = 61428376;

    • hasRequestMirrorPolicy

      boolean hasRequestMirrorPolicy()
       Specifies the policy on how requests intended for the route's backends
 are shadowed to a separate mirrored backend service. The load balancer does
 not wait for responses from the shadow service. Before sending traffic
 to the shadow service, the host / authority header is suffixed with-shadow.

 Not supported when the URL map is bound to a target gRPC proxy that
 has the validateForProxyless field set to true.
      optional .google.cloud.compute.v1.RequestMirrorPolicy request_mirror_policy = 220196866;
      Returns:
      Whether the requestMirrorPolicy field is set.

    • getRequestMirrorPolicy

      RequestMirrorPolicy getRequestMirrorPolicy()
       Specifies the policy on how requests intended for the route's backends
 are shadowed to a separate mirrored backend service. The load balancer does
 not wait for responses from the shadow service. Before sending traffic
 to the shadow service, the host / authority header is suffixed with-shadow.

 Not supported when the URL map is bound to a target gRPC proxy that
 has the validateForProxyless field set to true.
      optional .google.cloud.compute.v1.RequestMirrorPolicy request_mirror_policy = 220196866;
      Returns:
      The requestMirrorPolicy.

    • getRequestMirrorPolicyOrBuilder

      RequestMirrorPolicyOrBuilder getRequestMirrorPolicyOrBuilder()
       Specifies the policy on how requests intended for the route's backends
 are shadowed to a separate mirrored backend service. The load balancer does
 not wait for responses from the shadow service. Before sending traffic
 to the shadow service, the host / authority header is suffixed with-shadow.

 Not supported when the URL map is bound to a target gRPC proxy that
 has the validateForProxyless field set to true.
      optional .google.cloud.compute.v1.RequestMirrorPolicy request_mirror_policy = 220196866;

    • hasRetryPolicy

      boolean hasRetryPolicy()
       Specifies the retry policy associated with this route.
      optional .google.cloud.compute.v1.HttpRetryPolicy retry_policy = 56799913;
      Returns:
      Whether the retryPolicy field is set.

    • getRetryPolicy

      HttpRetryPolicy getRetryPolicy()
       Specifies the retry policy associated with this route.
      optional .google.cloud.compute.v1.HttpRetryPolicy retry_policy = 56799913;
      Returns:
      The retryPolicy.

    • getRetryPolicyOrBuilder

      HttpRetryPolicyOrBuilder getRetryPolicyOrBuilder()
       Specifies the retry policy associated with this route.
      optional .google.cloud.compute.v1.HttpRetryPolicy retry_policy = 56799913;

    • hasTimeout

      boolean hasTimeout()
       Specifies the timeout for the selected route. Timeout is computed from the
 time the request has been fully processed (known as *end-of-stream*)
 up until the response has been processed. Timeout includes
 all retries.

 If not specified, this field uses the largest timeout among all backend
 services associated with the route.

 Not supported when the URL map is bound to a target gRPC proxy that
 has validateForProxyless field set to true.
      optional .google.cloud.compute.v1.Duration timeout = 296701281;
      Returns:
      Whether the timeout field is set.

    • getTimeout

      Duration getTimeout()
       Specifies the timeout for the selected route. Timeout is computed from the
 time the request has been fully processed (known as *end-of-stream*)
 up until the response has been processed. Timeout includes
 all retries.

 If not specified, this field uses the largest timeout among all backend
 services associated with the route.

 Not supported when the URL map is bound to a target gRPC proxy that
 has validateForProxyless field set to true.
      optional .google.cloud.compute.v1.Duration timeout = 296701281;
      Returns:
      The timeout.

    • getTimeoutOrBuilder

      DurationOrBuilder getTimeoutOrBuilder()
       Specifies the timeout for the selected route. Timeout is computed from the
 time the request has been fully processed (known as *end-of-stream*)
 up until the response has been processed. Timeout includes
 all retries.

 If not specified, this field uses the largest timeout among all backend
 services associated with the route.

 Not supported when the URL map is bound to a target gRPC proxy that
 has validateForProxyless field set to true.
      optional .google.cloud.compute.v1.Duration timeout = 296701281;

    • hasUrlRewrite

      boolean hasUrlRewrite()
       The spec to modify the URL of the request, before forwarding the request
 to the matched service.

 urlRewrite is the only action supported in UrlMaps
 for classic Application Load Balancers.

 Not supported when the URL map is bound to a target gRPC proxy that
 has the validateForProxyless field set to true.
      optional .google.cloud.compute.v1.UrlRewrite url_rewrite = 273333948;
      Returns:
      Whether the urlRewrite field is set.

    • getUrlRewrite

      UrlRewrite getUrlRewrite()
       The spec to modify the URL of the request, before forwarding the request
 to the matched service.

 urlRewrite is the only action supported in UrlMaps
 for classic Application Load Balancers.

 Not supported when the URL map is bound to a target gRPC proxy that
 has the validateForProxyless field set to true.
      optional .google.cloud.compute.v1.UrlRewrite url_rewrite = 273333948;
      Returns:
      The urlRewrite.

    • getUrlRewriteOrBuilder

      UrlRewriteOrBuilder getUrlRewriteOrBuilder()
       The spec to modify the URL of the request, before forwarding the request
 to the matched service.

 urlRewrite is the only action supported in UrlMaps
 for classic Application Load Balancers.

 Not supported when the URL map is bound to a target gRPC proxy that
 has the validateForProxyless field set to true.
      optional .google.cloud.compute.v1.UrlRewrite url_rewrite = 273333948;

    • getWeightedBackendServicesList

      List<WeightedBackendService> getWeightedBackendServicesList()
       A list of weighted backend services to send traffic to when a route match
 occurs. The weights determine the fraction of traffic that flows to
 their corresponding backend service. If all traffic needs to
 go to a single backend service, there must be oneweightedBackendService with weight set to a non-zero number.

 After a backend service is identified and before forwarding
 the request to
 the backend service, advanced routing actions such as URL rewrites and
 header transformations are applied depending on additional settings
 specified in this HttpRouteAction.
      repeated .google.cloud.compute.v1.WeightedBackendService weighted_backend_services = 337028049;

    • getWeightedBackendServices

      WeightedBackendService getWeightedBackendServices(int index)
       A list of weighted backend services to send traffic to when a route match
 occurs. The weights determine the fraction of traffic that flows to
 their corresponding backend service. If all traffic needs to
 go to a single backend service, there must be oneweightedBackendService with weight set to a non-zero number.

 After a backend service is identified and before forwarding
 the request to
 the backend service, advanced routing actions such as URL rewrites and
 header transformations are applied depending on additional settings
 specified in this HttpRouteAction.
      repeated .google.cloud.compute.v1.WeightedBackendService weighted_backend_services = 337028049;

    • getWeightedBackendServicesCount

      int getWeightedBackendServicesCount()
       A list of weighted backend services to send traffic to when a route match
 occurs. The weights determine the fraction of traffic that flows to
 their corresponding backend service. If all traffic needs to
 go to a single backend service, there must be oneweightedBackendService with weight set to a non-zero number.

 After a backend service is identified and before forwarding
 the request to
 the backend service, advanced routing actions such as URL rewrites and
 header transformations are applied depending on additional settings
 specified in this HttpRouteAction.
      repeated .google.cloud.compute.v1.WeightedBackendService weighted_backend_services = 337028049;

    • getWeightedBackendServicesOrBuilderList

      List<? extends WeightedBackendServiceOrBuilder> getWeightedBackendServicesOrBuilderList()
       A list of weighted backend services to send traffic to when a route match
 occurs. The weights determine the fraction of traffic that flows to
 their corresponding backend service. If all traffic needs to
 go to a single backend service, there must be oneweightedBackendService with weight set to a non-zero number.

 After a backend service is identified and before forwarding
 the request to
 the backend service, advanced routing actions such as URL rewrites and
 header transformations are applied depending on additional settings
 specified in this HttpRouteAction.
      repeated .google.cloud.compute.v1.WeightedBackendService weighted_backend_services = 337028049;

    • getWeightedBackendServicesOrBuilder

      WeightedBackendServiceOrBuilder getWeightedBackendServicesOrBuilder(int index)
       A list of weighted backend services to send traffic to when a route match
 occurs. The weights determine the fraction of traffic that flows to
 their corresponding backend service. If all traffic needs to
 go to a single backend service, there must be oneweightedBackendService with weight set to a non-zero number.

 After a backend service is identified and before forwarding
 the request to
 the backend service, advanced routing actions such as URL rewrites and
 header transformations are applied depending on additional settings
 specified in this HttpRouteAction.
      repeated .google.cloud.compute.v1.WeightedBackendService weighted_backend_services = 337028049;