Interface HttpRouteActionOrBuilder (1.27.0)

Version 1.27.0

• 1.65.0 (latest)
• 1.64.0
• 1.63.0
• 1.62.0
• 1.61.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.0
• 1.9.1
• 1.8.1
• 1.7.2
• 1.6.0-beta

public interface HttpRouteActionOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCorsPolicy()

public abstract 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
Type	Description
CorsPolicy	The corsPolicy.

getCorsPolicyOrBuilder()

public abstract 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;

Returns
Type	Description
CorsPolicyOrBuilder

getFaultInjectionPolicy()

public abstract 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 global external HTTP(S) load balancer (classic). 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
Type	Description
HttpFaultInjection	The faultInjectionPolicy.

getFaultInjectionPolicyOrBuilder()

public abstract 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 global external HTTP(S) load balancer (classic). 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
Type	Description
HttpFaultInjectionOrBuilder

getMaxStreamDuration()

public abstract 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 maximum maxStreamDuration 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 to INTERNAL_SELF_MANAGED.

optional .google.cloud.compute.v1.Duration max_stream_duration = 61428376;

Returns
Type	Description
Duration	The maxStreamDuration.

getMaxStreamDurationOrBuilder()

public abstract 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 maximum maxStreamDuration 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 to INTERNAL_SELF_MANAGED.

optional .google.cloud.compute.v1.Duration max_stream_duration = 61428376;

Returns
Type	Description
DurationOrBuilder

getRequestMirrorPolicy()

public abstract 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
Type	Description
RequestMirrorPolicy	The requestMirrorPolicy.

getRequestMirrorPolicyOrBuilder()

public abstract 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;

Returns
Type	Description
RequestMirrorPolicyOrBuilder

getRetryPolicy()

public abstract HttpRetryPolicy getRetryPolicy()

Specifies the retry policy associated with this route.

optional .google.cloud.compute.v1.HttpRetryPolicy retry_policy = 56799913;

Returns
Type	Description
HttpRetryPolicy	The retryPolicy.

getRetryPolicyOrBuilder()

public abstract HttpRetryPolicyOrBuilder getRetryPolicyOrBuilder()

Specifies the retry policy associated with this route.

optional .google.cloud.compute.v1.HttpRetryPolicy retry_policy = 56799913;

Returns
Type	Description
HttpRetryPolicyOrBuilder

getTimeout()

public abstract 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
Type	Description
Duration	The timeout.

getTimeoutOrBuilder()

public abstract 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;

Returns
Type	Description
DurationOrBuilder

getUrlRewrite()

public abstract 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 external HTTP(S) 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
Type	Description
UrlRewrite	The urlRewrite.

getUrlRewriteOrBuilder()

public abstract 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 external HTTP(S) 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
Type	Description
UrlRewriteOrBuilder

getWeightedBackendServices(int index)

public abstract 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 one weightedBackendService 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;

Parameter
Name	Description
index	int

Returns
Type	Description
WeightedBackendService

getWeightedBackendServicesCount()

public abstract 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 one weightedBackendService 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;

Returns
Type	Description
int

getWeightedBackendServicesList()

public abstract 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 one weightedBackendService 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;

Returns
Type	Description
List<WeightedBackendService>

getWeightedBackendServicesOrBuilder(int index)

public abstract 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 one weightedBackendService 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;

Parameter
Name	Description
index	int

Returns
Type	Description
WeightedBackendServiceOrBuilder

getWeightedBackendServicesOrBuilderList()

public abstract 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 one weightedBackendService 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;

Returns
Type	Description
List<? extends com.google.cloud.compute.v1.WeightedBackendServiceOrBuilder>

hasCorsPolicy()

public abstract 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
Type	Description
boolean	Whether the corsPolicy field is set.

hasFaultInjectionPolicy()

public abstract 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 global external HTTP(S) load balancer (classic). 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
Type	Description
boolean	Whether the faultInjectionPolicy field is set.

hasMaxStreamDuration()

public abstract 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 maximum maxStreamDuration 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 to INTERNAL_SELF_MANAGED.

optional .google.cloud.compute.v1.Duration max_stream_duration = 61428376;

Returns
Type	Description
boolean	Whether the maxStreamDuration field is set.

hasRequestMirrorPolicy()

public abstract 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
Type	Description
boolean	Whether the requestMirrorPolicy field is set.

hasRetryPolicy()

public abstract boolean hasRetryPolicy()

Specifies the retry policy associated with this route.

optional .google.cloud.compute.v1.HttpRetryPolicy retry_policy = 56799913;

Returns
Type	Description
boolean	Whether the retryPolicy field is set.

hasTimeout()

public abstract 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
Type	Description
boolean	Whether the timeout field is set.

hasUrlRewrite()

public abstract 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 external HTTP(S) 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
Type	Description
boolean	Whether the urlRewrite field is set.