Class HttpRouteAction.Builder (1.54.0)

public static final class HttpRouteAction.Builder extends GeneratedMessageV3.Builder<HttpRouteAction.Builder> implements HttpRouteActionOrBuilder

Protobuf type google.cloud.compute.v1.HttpRouteAction

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllWeightedBackendServices(Iterable<? extends WeightedBackendService> values)

public HttpRouteAction.Builder addAllWeightedBackendServices(Iterable<? extends WeightedBackendService> values)

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
values Iterable<? extends com.google.cloud.compute.v1.WeightedBackendService>
Returns
Type Description
HttpRouteAction.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public HttpRouteAction.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
HttpRouteAction.Builder
Overrides

addWeightedBackendServices(WeightedBackendService value)

public HttpRouteAction.Builder addWeightedBackendServices(WeightedBackendService value)

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
value WeightedBackendService
Returns
Type Description
HttpRouteAction.Builder

addWeightedBackendServices(WeightedBackendService.Builder builderForValue)

public HttpRouteAction.Builder addWeightedBackendServices(WeightedBackendService.Builder builderForValue)

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
builderForValue WeightedBackendService.Builder
Returns
Type Description
HttpRouteAction.Builder

addWeightedBackendServices(int index, WeightedBackendService value)

public HttpRouteAction.Builder addWeightedBackendServices(int index, WeightedBackendService value)

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;

Parameters
Name Description
index int
value WeightedBackendService
Returns
Type Description
HttpRouteAction.Builder

addWeightedBackendServices(int index, WeightedBackendService.Builder builderForValue)

public HttpRouteAction.Builder addWeightedBackendServices(int index, WeightedBackendService.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue WeightedBackendService.Builder
Returns
Type Description
HttpRouteAction.Builder

addWeightedBackendServicesBuilder()

public WeightedBackendService.Builder addWeightedBackendServicesBuilder()

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
WeightedBackendService.Builder

addWeightedBackendServicesBuilder(int index)

public WeightedBackendService.Builder addWeightedBackendServicesBuilder(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.Builder

build()

public HttpRouteAction build()
Returns
Type Description
HttpRouteAction

buildPartial()

public HttpRouteAction buildPartial()
Returns
Type Description
HttpRouteAction

clear()

public HttpRouteAction.Builder clear()
Returns
Type Description
HttpRouteAction.Builder
Overrides

clearCorsPolicy()

public HttpRouteAction.Builder clearCorsPolicy()

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
HttpRouteAction.Builder

clearFaultInjectionPolicy()

public HttpRouteAction.Builder clearFaultInjectionPolicy()

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
Type Description
HttpRouteAction.Builder

clearField(Descriptors.FieldDescriptor field)

public HttpRouteAction.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
HttpRouteAction.Builder
Overrides

clearMaxStreamDuration()

public HttpRouteAction.Builder clearMaxStreamDuration()

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
HttpRouteAction.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public HttpRouteAction.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
HttpRouteAction.Builder
Overrides

clearRequestMirrorPolicy()

public HttpRouteAction.Builder clearRequestMirrorPolicy()

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
HttpRouteAction.Builder

clearRetryPolicy()

public HttpRouteAction.Builder clearRetryPolicy()

Specifies the retry policy associated with this route.

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

Returns
Type Description
HttpRouteAction.Builder

clearTimeout()

public HttpRouteAction.Builder clearTimeout()

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
HttpRouteAction.Builder

clearUrlRewrite()

public HttpRouteAction.Builder clearUrlRewrite()

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
Type Description
HttpRouteAction.Builder

clearWeightedBackendServices()

public HttpRouteAction.Builder clearWeightedBackendServices()

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
HttpRouteAction.Builder

clone()

public HttpRouteAction.Builder clone()
Returns
Type Description
HttpRouteAction.Builder
Overrides

getCorsPolicy()

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

getCorsPolicyBuilder()

public CorsPolicy.Builder getCorsPolicyBuilder()

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

getCorsPolicyOrBuilder()

public 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

getDefaultInstanceForType()

public HttpRouteAction getDefaultInstanceForType()
Returns
Type Description
HttpRouteAction

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFaultInjectionPolicy()

public 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
Type Description
HttpFaultInjection

The faultInjectionPolicy.

getFaultInjectionPolicyBuilder()

public HttpFaultInjection.Builder getFaultInjectionPolicyBuilder()

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
Type Description
HttpFaultInjection.Builder

getFaultInjectionPolicyOrBuilder()

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

Returns
Type Description
HttpFaultInjectionOrBuilder

getMaxStreamDuration()

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

getMaxStreamDurationBuilder()

public Duration.Builder getMaxStreamDurationBuilder()

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

getMaxStreamDurationOrBuilder()

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

getRequestMirrorPolicyBuilder()

public RequestMirrorPolicy.Builder getRequestMirrorPolicyBuilder()

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

getRequestMirrorPolicyOrBuilder()

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

getRetryPolicyBuilder()

public HttpRetryPolicy.Builder getRetryPolicyBuilder()

Specifies the retry policy associated with this route.

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

Returns
Type Description
HttpRetryPolicy.Builder

getRetryPolicyOrBuilder()

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

getTimeoutBuilder()

public Duration.Builder getTimeoutBuilder()

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

getTimeoutOrBuilder()

public 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 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
Type Description
UrlRewrite

The urlRewrite.

getUrlRewriteBuilder()

public UrlRewrite.Builder getUrlRewriteBuilder()

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
Type Description
UrlRewrite.Builder

getUrlRewriteOrBuilder()

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

Returns
Type Description
UrlRewriteOrBuilder

getWeightedBackendServices(int index)

public 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

getWeightedBackendServicesBuilder(int index)

public WeightedBackendService.Builder getWeightedBackendServicesBuilder(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.Builder

getWeightedBackendServicesBuilderList()

public List<WeightedBackendService.Builder> getWeightedBackendServicesBuilderList()

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<Builder>

getWeightedBackendServicesCount()

public 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 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 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 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 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 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
Type Description
boolean

Whether the faultInjectionPolicy field is set.

hasMaxStreamDuration()

public 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 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 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 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 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
Type Description
boolean

Whether the urlRewrite field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCorsPolicy(CorsPolicy value)

public HttpRouteAction.Builder mergeCorsPolicy(CorsPolicy value)

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;

Parameter
Name Description
value CorsPolicy
Returns
Type Description
HttpRouteAction.Builder

mergeFaultInjectionPolicy(HttpFaultInjection value)

public HttpRouteAction.Builder mergeFaultInjectionPolicy(HttpFaultInjection value)

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;

Parameter
Name Description
value HttpFaultInjection
Returns
Type Description
HttpRouteAction.Builder

mergeFrom(HttpRouteAction other)

public HttpRouteAction.Builder mergeFrom(HttpRouteAction other)
Parameter
Name Description
other HttpRouteAction
Returns
Type Description
HttpRouteAction.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public HttpRouteAction.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HttpRouteAction.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public HttpRouteAction.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
HttpRouteAction.Builder
Overrides

mergeMaxStreamDuration(Duration value)

public HttpRouteAction.Builder mergeMaxStreamDuration(Duration value)

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;

Parameter
Name Description
value Duration
Returns
Type Description
HttpRouteAction.Builder

mergeRequestMirrorPolicy(RequestMirrorPolicy value)

public HttpRouteAction.Builder mergeRequestMirrorPolicy(RequestMirrorPolicy value)

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;

Parameter
Name Description
value RequestMirrorPolicy
Returns
Type Description
HttpRouteAction.Builder

mergeRetryPolicy(HttpRetryPolicy value)

public HttpRouteAction.Builder mergeRetryPolicy(HttpRetryPolicy value)

Specifies the retry policy associated with this route.

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

Parameter
Name Description
value HttpRetryPolicy
Returns
Type Description
HttpRouteAction.Builder

mergeTimeout(Duration value)

public HttpRouteAction.Builder mergeTimeout(Duration value)

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;

Parameter
Name Description
value Duration
Returns
Type Description
HttpRouteAction.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final HttpRouteAction.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
HttpRouteAction.Builder
Overrides

mergeUrlRewrite(UrlRewrite value)

public HttpRouteAction.Builder mergeUrlRewrite(UrlRewrite value)

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;

Parameter
Name Description
value UrlRewrite
Returns
Type Description
HttpRouteAction.Builder

removeWeightedBackendServices(int index)

public HttpRouteAction.Builder removeWeightedBackendServices(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
HttpRouteAction.Builder

setCorsPolicy(CorsPolicy value)

public HttpRouteAction.Builder setCorsPolicy(CorsPolicy value)

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;

Parameter
Name Description
value CorsPolicy
Returns
Type Description
HttpRouteAction.Builder

setCorsPolicy(CorsPolicy.Builder builderForValue)

public HttpRouteAction.Builder setCorsPolicy(CorsPolicy.Builder builderForValue)

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;

Parameter
Name Description
builderForValue CorsPolicy.Builder
Returns
Type Description
HttpRouteAction.Builder

setFaultInjectionPolicy(HttpFaultInjection value)

public HttpRouteAction.Builder setFaultInjectionPolicy(HttpFaultInjection value)

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;

Parameter
Name Description
value HttpFaultInjection
Returns
Type Description
HttpRouteAction.Builder

setFaultInjectionPolicy(HttpFaultInjection.Builder builderForValue)

public HttpRouteAction.Builder setFaultInjectionPolicy(HttpFaultInjection.Builder builderForValue)

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;

Parameter
Name Description
builderForValue HttpFaultInjection.Builder
Returns
Type Description
HttpRouteAction.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public HttpRouteAction.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
HttpRouteAction.Builder
Overrides

setMaxStreamDuration(Duration value)

public HttpRouteAction.Builder setMaxStreamDuration(Duration value)

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;

Parameter
Name Description
value Duration
Returns
Type Description
HttpRouteAction.Builder

setMaxStreamDuration(Duration.Builder builderForValue)

public HttpRouteAction.Builder setMaxStreamDuration(Duration.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Duration.Builder
Returns
Type Description
HttpRouteAction.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public HttpRouteAction.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
HttpRouteAction.Builder
Overrides

setRequestMirrorPolicy(RequestMirrorPolicy value)

public HttpRouteAction.Builder setRequestMirrorPolicy(RequestMirrorPolicy value)

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;

Parameter
Name Description
value RequestMirrorPolicy
Returns
Type Description
HttpRouteAction.Builder

setRequestMirrorPolicy(RequestMirrorPolicy.Builder builderForValue)

public HttpRouteAction.Builder setRequestMirrorPolicy(RequestMirrorPolicy.Builder builderForValue)

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;

Parameter
Name Description
builderForValue RequestMirrorPolicy.Builder
Returns
Type Description
HttpRouteAction.Builder

setRetryPolicy(HttpRetryPolicy value)

public HttpRouteAction.Builder setRetryPolicy(HttpRetryPolicy value)

Specifies the retry policy associated with this route.

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

Parameter
Name Description
value HttpRetryPolicy
Returns
Type Description
HttpRouteAction.Builder

setRetryPolicy(HttpRetryPolicy.Builder builderForValue)

public HttpRouteAction.Builder setRetryPolicy(HttpRetryPolicy.Builder builderForValue)

Specifies the retry policy associated with this route.

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

Parameter
Name Description
builderForValue HttpRetryPolicy.Builder
Returns
Type Description
HttpRouteAction.Builder

setTimeout(Duration value)

public HttpRouteAction.Builder setTimeout(Duration value)

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;

Parameter
Name Description
value Duration
Returns
Type Description
HttpRouteAction.Builder

setTimeout(Duration.Builder builderForValue)

public HttpRouteAction.Builder setTimeout(Duration.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Duration.Builder
Returns
Type Description
HttpRouteAction.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final HttpRouteAction.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
HttpRouteAction.Builder
Overrides

setUrlRewrite(UrlRewrite value)

public HttpRouteAction.Builder setUrlRewrite(UrlRewrite value)

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;

Parameter
Name Description
value UrlRewrite
Returns
Type Description
HttpRouteAction.Builder

setUrlRewrite(UrlRewrite.Builder builderForValue)

public HttpRouteAction.Builder setUrlRewrite(UrlRewrite.Builder builderForValue)

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;

Parameter
Name Description
builderForValue UrlRewrite.Builder
Returns
Type Description
HttpRouteAction.Builder

setWeightedBackendServices(int index, WeightedBackendService value)

public HttpRouteAction.Builder setWeightedBackendServices(int index, WeightedBackendService value)

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;

Parameters
Name Description
index int
value WeightedBackendService
Returns
Type Description
HttpRouteAction.Builder

setWeightedBackendServices(int index, WeightedBackendService.Builder builderForValue)

public HttpRouteAction.Builder setWeightedBackendServices(int index, WeightedBackendService.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue WeightedBackendService.Builder
Returns
Type Description
HttpRouteAction.Builder