public static final class HttpRoute.RouteAction extends GeneratedMessageV3 implements HttpRoute.RouteActionOrBuilder
The specifications for routing traffic and applying associated policies.
Protobuf type google.cloud.networkservices.v1.HttpRoute.RouteAction
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
CORS_POLICY_FIELD_NUMBER
public static final int CORS_POLICY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DESTINATIONS_FIELD_NUMBER
public static final int DESTINATIONS_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 |
|
REDIRECT_FIELD_NUMBER
public static final int REDIRECT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int REQUEST_HEADER_MODIFIER_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 |
|
public static final int RESPONSE_HEADER_MODIFIER_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 |
|
Static Methods
getDefaultInstance()
public static HttpRoute.RouteAction getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static HttpRoute.RouteAction.Builder newBuilder()
newBuilder(HttpRoute.RouteAction prototype)
public static HttpRoute.RouteAction.Builder newBuilder(HttpRoute.RouteAction prototype)
public static HttpRoute.RouteAction parseDelimitedFrom(InputStream input)
public static HttpRoute.RouteAction parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static HttpRoute.RouteAction parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static HttpRoute.RouteAction parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static HttpRoute.RouteAction parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static HttpRoute.RouteAction parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static HttpRoute.RouteAction parseFrom(CodedInputStream input)
public static HttpRoute.RouteAction parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static HttpRoute.RouteAction parseFrom(InputStream input)
public static HttpRoute.RouteAction parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static HttpRoute.RouteAction parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static HttpRoute.RouteAction parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<HttpRoute.RouteAction> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getCorsPolicy()
public HttpRoute.CorsPolicy getCorsPolicy()
The specification for allowing client side cross-origin requests.
.google.cloud.networkservices.v1.HttpRoute.CorsPolicy cors_policy = 11;
getCorsPolicyOrBuilder()
public HttpRoute.CorsPolicyOrBuilder getCorsPolicyOrBuilder()
The specification for allowing client side cross-origin requests.
.google.cloud.networkservices.v1.HttpRoute.CorsPolicy cors_policy = 11;
getDefaultInstanceForType()
public HttpRoute.RouteAction getDefaultInstanceForType()
getDestinations(int index)
public HttpRoute.Destination getDestinations(int index)
The destination to which traffic should be forwarded.
repeated .google.cloud.networkservices.v1.HttpRoute.Destination destinations = 1;
| Parameter |
| Name |
Description |
index |
int
|
getDestinationsCount()
public int getDestinationsCount()
The destination to which traffic should be forwarded.
repeated .google.cloud.networkservices.v1.HttpRoute.Destination destinations = 1;
| Returns |
| Type |
Description |
int |
|
getDestinationsList()
public List<HttpRoute.Destination> getDestinationsList()
The destination to which traffic should be forwarded.
repeated .google.cloud.networkservices.v1.HttpRoute.Destination destinations = 1;
getDestinationsOrBuilder(int index)
public HttpRoute.DestinationOrBuilder getDestinationsOrBuilder(int index)
The destination to which traffic should be forwarded.
repeated .google.cloud.networkservices.v1.HttpRoute.Destination destinations = 1;
| Parameter |
| Name |
Description |
index |
int
|
getDestinationsOrBuilderList()
public List<? extends HttpRoute.DestinationOrBuilder> getDestinationsOrBuilderList()
The destination to which traffic should be forwarded.
repeated .google.cloud.networkservices.v1.HttpRoute.Destination destinations = 1;
| Returns |
| Type |
Description |
List<? extends com.google.cloud.networkservices.v1.HttpRoute.DestinationOrBuilder> |
|
getFaultInjectionPolicy()
public HttpRoute.FaultInjectionPolicy 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 on a percentage of requests before sending those requests to
the backend service. Similarly requests from clients can be aborted for a
percentage of requests.
timeout and retry_policy will be ignored by clients that are configured
with a fault_injection_policy
.google.cloud.networkservices.v1.HttpRoute.FaultInjectionPolicy fault_injection_policy = 4;
getFaultInjectionPolicyOrBuilder()
public HttpRoute.FaultInjectionPolicyOrBuilder 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 on a percentage of requests before sending those requests to
the backend service. Similarly requests from clients can be aborted for a
percentage of requests.
timeout and retry_policy will be ignored by clients that are configured
with a fault_injection_policy
.google.cloud.networkservices.v1.HttpRoute.FaultInjectionPolicy fault_injection_policy = 4;
getParserForType()
public Parser<HttpRoute.RouteAction> getParserForType()
Overrides
getRedirect()
public HttpRoute.Redirect getRedirect()
If set, the request is directed as configured by this field.
.google.cloud.networkservices.v1.HttpRoute.Redirect redirect = 2;
getRedirectOrBuilder()
public HttpRoute.RedirectOrBuilder getRedirectOrBuilder()
If set, the request is directed as configured by this field.
.google.cloud.networkservices.v1.HttpRoute.Redirect redirect = 2;
public HttpRoute.HeaderModifier getRequestHeaderModifier()
The specification for modifying the headers of a matching request prior
to delivery of the request to the destination. If HeaderModifiers are set
on both the Destination and the RouteAction, they will be merged.
Conflicts between the two will not be resolved on the configuration.
.google.cloud.networkservices.v1.HttpRoute.HeaderModifier request_header_modifier = 5;
public HttpRoute.HeaderModifierOrBuilder getRequestHeaderModifierOrBuilder()
The specification for modifying the headers of a matching request prior
to delivery of the request to the destination. If HeaderModifiers are set
on both the Destination and the RouteAction, they will be merged.
Conflicts between the two will not be resolved on the configuration.
.google.cloud.networkservices.v1.HttpRoute.HeaderModifier request_header_modifier = 5;
getRequestMirrorPolicy()
public HttpRoute.RequestMirrorPolicy getRequestMirrorPolicy()
Specifies the policy on how requests intended for the routes destination
are shadowed to a separate mirrored destination. Proxy will not wait for
the shadow destination to respond before returning the response. Prior to
sending traffic to the shadow service, the host/authority header is
suffixed with -shadow.
.google.cloud.networkservices.v1.HttpRoute.RequestMirrorPolicy request_mirror_policy = 10;
getRequestMirrorPolicyOrBuilder()
public HttpRoute.RequestMirrorPolicyOrBuilder getRequestMirrorPolicyOrBuilder()
Specifies the policy on how requests intended for the routes destination
are shadowed to a separate mirrored destination. Proxy will not wait for
the shadow destination to respond before returning the response. Prior to
sending traffic to the shadow service, the host/authority header is
suffixed with -shadow.
.google.cloud.networkservices.v1.HttpRoute.RequestMirrorPolicy request_mirror_policy = 10;
public HttpRoute.HeaderModifier getResponseHeaderModifier()
The specification for modifying the headers of a response prior to
sending the response back to the client. If HeaderModifiers are set
on both the Destination and the RouteAction, they will be merged.
Conflicts between the two will not be resolved on the configuration.
.google.cloud.networkservices.v1.HttpRoute.HeaderModifier response_header_modifier = 6;
public HttpRoute.HeaderModifierOrBuilder getResponseHeaderModifierOrBuilder()
The specification for modifying the headers of a response prior to
sending the response back to the client. If HeaderModifiers are set
on both the Destination and the RouteAction, they will be merged.
Conflicts between the two will not be resolved on the configuration.
.google.cloud.networkservices.v1.HttpRoute.HeaderModifier response_header_modifier = 6;
getRetryPolicy()
public HttpRoute.RetryPolicy getRetryPolicy()
Specifies the retry policy associated with this route.
.google.cloud.networkservices.v1.HttpRoute.RetryPolicy retry_policy = 9;
getRetryPolicyOrBuilder()
public HttpRoute.RetryPolicyOrBuilder getRetryPolicyOrBuilder()
Specifies the retry policy associated with this route.
.google.cloud.networkservices.v1.HttpRoute.RetryPolicy retry_policy = 9;
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getTimeout()
public Duration getTimeout()
Specifies the timeout for selected route. Timeout is computed from the
time the request has been fully processed (i.e. end of stream) up until
the response has been completely processed. Timeout includes all retries.
.google.protobuf.Duration timeout = 8;
| Returns |
| Type |
Description |
Duration |
The timeout.
|
getTimeoutOrBuilder()
public DurationOrBuilder getTimeoutOrBuilder()
Specifies the timeout for selected route. Timeout is computed from the
time the request has been fully processed (i.e. end of stream) up until
the response has been completely processed. Timeout includes all retries.
.google.protobuf.Duration timeout = 8;
getUrlRewrite()
public HttpRoute.URLRewrite getUrlRewrite()
The specification for rewrite URL before forwarding requests to the
destination.
.google.cloud.networkservices.v1.HttpRoute.URLRewrite url_rewrite = 7;
getUrlRewriteOrBuilder()
public HttpRoute.URLRewriteOrBuilder getUrlRewriteOrBuilder()
The specification for rewrite URL before forwarding requests to the
destination.
.google.cloud.networkservices.v1.HttpRoute.URLRewrite url_rewrite = 7;
hasCorsPolicy()
public boolean hasCorsPolicy()
The specification for allowing client side cross-origin requests.
.google.cloud.networkservices.v1.HttpRoute.CorsPolicy cors_policy = 11;
| 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 on a percentage of requests before sending those requests to
the backend service. Similarly requests from clients can be aborted for a
percentage of requests.
timeout and retry_policy will be ignored by clients that are configured
with a fault_injection_policy
.google.cloud.networkservices.v1.HttpRoute.FaultInjectionPolicy fault_injection_policy = 4;
| Returns |
| Type |
Description |
boolean |
Whether the faultInjectionPolicy field is set.
|
hasRedirect()
public boolean hasRedirect()
If set, the request is directed as configured by this field.
.google.cloud.networkservices.v1.HttpRoute.Redirect redirect = 2;
| Returns |
| Type |
Description |
boolean |
Whether the redirect field is set.
|
public boolean hasRequestHeaderModifier()
The specification for modifying the headers of a matching request prior
to delivery of the request to the destination. If HeaderModifiers are set
on both the Destination and the RouteAction, they will be merged.
Conflicts between the two will not be resolved on the configuration.
.google.cloud.networkservices.v1.HttpRoute.HeaderModifier request_header_modifier = 5;
| Returns |
| Type |
Description |
boolean |
Whether the requestHeaderModifier field is set.
|
hasRequestMirrorPolicy()
public boolean hasRequestMirrorPolicy()
Specifies the policy on how requests intended for the routes destination
are shadowed to a separate mirrored destination. Proxy will not wait for
the shadow destination to respond before returning the response. Prior to
sending traffic to the shadow service, the host/authority header is
suffixed with -shadow.
.google.cloud.networkservices.v1.HttpRoute.RequestMirrorPolicy request_mirror_policy = 10;
| Returns |
| Type |
Description |
boolean |
Whether the requestMirrorPolicy field is set.
|
public boolean hasResponseHeaderModifier()
The specification for modifying the headers of a response prior to
sending the response back to the client. If HeaderModifiers are set
on both the Destination and the RouteAction, they will be merged.
Conflicts between the two will not be resolved on the configuration.
.google.cloud.networkservices.v1.HttpRoute.HeaderModifier response_header_modifier = 6;
| Returns |
| Type |
Description |
boolean |
Whether the responseHeaderModifier field is set.
|
hasRetryPolicy()
public boolean hasRetryPolicy()
Specifies the retry policy associated with this route.
.google.cloud.networkservices.v1.HttpRoute.RetryPolicy retry_policy = 9;
| Returns |
| Type |
Description |
boolean |
Whether the retryPolicy field is set.
|
hasTimeout()
public boolean hasTimeout()
Specifies the timeout for selected route. Timeout is computed from the
time the request has been fully processed (i.e. end of stream) up until
the response has been completely processed. Timeout includes all retries.
.google.protobuf.Duration timeout = 8;
| Returns |
| Type |
Description |
boolean |
Whether the timeout field is set.
|
hasUrlRewrite()
public boolean hasUrlRewrite()
The specification for rewrite URL before forwarding requests to the
destination.
.google.cloud.networkservices.v1.HttpRoute.URLRewrite url_rewrite = 7;
| 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 HttpRoute.RouteAction.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected HttpRoute.RouteAction.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public HttpRoute.RouteAction.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
