public final class HttpRouteAction extends GeneratedMessageV3 implements HttpRouteActionOrBuilder
Protobuf type google.cloud.compute.v1.HttpRouteAction
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
CORS_POLICY_FIELD_NUMBER
public static final int CORS_POLICY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
FAULT_INJECTION_POLICY_FIELD_NUMBER
public static final int FAULT_INJECTION_POLICY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
MAX_STREAM_DURATION_FIELD_NUMBER
public static final int MAX_STREAM_DURATION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
REQUEST_MIRROR_POLICY_FIELD_NUMBER
public static final int REQUEST_MIRROR_POLICY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
RETRY_POLICY_FIELD_NUMBER
public static final int RETRY_POLICY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
TIMEOUT_FIELD_NUMBER
public static final int TIMEOUT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
URL_REWRITE_FIELD_NUMBER
public static final int URL_REWRITE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
WEIGHTED_BACKEND_SERVICES_FIELD_NUMBER
public static final int WEIGHTED_BACKEND_SERVICES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static HttpRouteAction getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static HttpRouteAction.Builder newBuilder()
newBuilder(HttpRouteAction prototype)
public static HttpRouteAction.Builder newBuilder(HttpRouteAction prototype)
public static HttpRouteAction parseDelimitedFrom(InputStream input)
public static HttpRouteAction parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static HttpRouteAction parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static HttpRouteAction parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static HttpRouteAction parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static HttpRouteAction parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static HttpRouteAction parseFrom(CodedInputStream input)
public static HttpRouteAction parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static HttpRouteAction parseFrom(InputStream input)
public static HttpRouteAction parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static HttpRouteAction parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static HttpRouteAction parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<HttpRouteAction> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
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;
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;
getDefaultInstanceForType()
public HttpRouteAction getDefaultInstanceForType()
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;
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;
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.
|
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;
getParserForType()
public Parser<HttpRouteAction> getParserForType()
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;
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;
getRetryPolicy()
public HttpRetryPolicy getRetryPolicy()
Specifies the retry policy associated with this route.
optional .google.cloud.compute.v1.HttpRetryPolicy retry_policy = 56799913;
getRetryPolicyOrBuilder()
public HttpRetryPolicyOrBuilder getRetryPolicyOrBuilder()
Specifies the retry policy associated with this route.
optional .google.cloud.compute.v1.HttpRetryPolicy retry_policy = 56799913;
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
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 |
|---|
| Type | Description |
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;
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;
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;
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
|
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;
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
|
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 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 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 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.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public HttpRouteAction.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected HttpRouteAction.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public HttpRouteAction.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
