Class HttpRouteAction (1.30.0)

public final class HttpRouteAction extends GeneratedMessageV3 implements HttpRouteActionOrBuilder

Protobuf type google.cloud.compute.v1.HttpRouteAction

Static Fields

CORS_POLICY_FIELD_NUMBER

public static final int CORS_POLICY_FIELD_NUMBER
Field Value
TypeDescription
int

FAULT_INJECTION_POLICY_FIELD_NUMBER

public static final int FAULT_INJECTION_POLICY_FIELD_NUMBER
Field Value
TypeDescription
int

MAX_STREAM_DURATION_FIELD_NUMBER

public static final int MAX_STREAM_DURATION_FIELD_NUMBER
Field Value
TypeDescription
int

REQUEST_MIRROR_POLICY_FIELD_NUMBER

public static final int REQUEST_MIRROR_POLICY_FIELD_NUMBER
Field Value
TypeDescription
int

RETRY_POLICY_FIELD_NUMBER

public static final int RETRY_POLICY_FIELD_NUMBER
Field Value
TypeDescription
int

TIMEOUT_FIELD_NUMBER

public static final int TIMEOUT_FIELD_NUMBER
Field Value
TypeDescription
int

URL_REWRITE_FIELD_NUMBER

public static final int URL_REWRITE_FIELD_NUMBER
Field Value
TypeDescription
int

WEIGHTED_BACKEND_SERVICES_FIELD_NUMBER

public static final int WEIGHTED_BACKEND_SERVICES_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static HttpRouteAction getDefaultInstance()
Returns
TypeDescription
HttpRouteAction

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static HttpRouteAction.Builder newBuilder()
Returns
TypeDescription
HttpRouteAction.Builder

newBuilder(HttpRouteAction prototype)

public static HttpRouteAction.Builder newBuilder(HttpRouteAction prototype)
Parameter
NameDescription
prototypeHttpRouteAction
Returns
TypeDescription
HttpRouteAction.Builder

parseDelimitedFrom(InputStream input)

public static HttpRouteAction parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
HttpRouteAction
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static HttpRouteAction parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
HttpRouteAction
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static HttpRouteAction parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
HttpRouteAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static HttpRouteAction parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
HttpRouteAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static HttpRouteAction parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
HttpRouteAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static HttpRouteAction parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
HttpRouteAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static HttpRouteAction parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
HttpRouteAction
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static HttpRouteAction parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
HttpRouteAction
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static HttpRouteAction parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
HttpRouteAction
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static HttpRouteAction parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
HttpRouteAction
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static HttpRouteAction parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
HttpRouteAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static HttpRouteAction parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
HttpRouteAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<HttpRouteAction> parser()
Returns
TypeDescription
Parser<HttpRouteAction>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
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
TypeDescription
CorsPolicy

The corsPolicy.

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
TypeDescription
CorsPolicyOrBuilder

getDefaultInstanceForType()

public HttpRouteAction getDefaultInstanceForType()
Returns
TypeDescription
HttpRouteAction

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 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
TypeDescription
HttpFaultInjection

The faultInjectionPolicy.

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 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
TypeDescription
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
TypeDescription
Duration

The maxStreamDuration.

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
TypeDescription
DurationOrBuilder

getParserForType()

public Parser<HttpRouteAction> getParserForType()
Returns
TypeDescription
Parser<HttpRouteAction>
Overrides

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
TypeDescription
RequestMirrorPolicy

The requestMirrorPolicy.

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
TypeDescription
RequestMirrorPolicyOrBuilder

getRetryPolicy()

public HttpRetryPolicy getRetryPolicy()

Specifies the retry policy associated with this route.

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

Returns
TypeDescription
HttpRetryPolicy

The retryPolicy.

getRetryPolicyOrBuilder()

public HttpRetryPolicyOrBuilder getRetryPolicyOrBuilder()

Specifies the retry policy associated with this route.

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

Returns
TypeDescription
HttpRetryPolicyOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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
TypeDescription
Duration

The timeout.

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
TypeDescription
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 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
TypeDescription
UrlRewrite

The urlRewrite.

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 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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
WeightedBackendService

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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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 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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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 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
TypeDescription
boolean

Whether the urlRewrite field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public HttpRouteAction.Builder newBuilderForType()
Returns
TypeDescription
HttpRouteAction.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected HttpRouteAction.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
HttpRouteAction.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public HttpRouteAction.Builder toBuilder()
Returns
TypeDescription
HttpRouteAction.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException