Interface HTTPFaultOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
HTTPFault
,HTTPFault.Builder
public interface HTTPFaultOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptiongetAbort()
If specified, the filter will abort requests based on the values in the object.The runtime key to override the :ref:`default <config_http_filters_fault_injection_runtime>` runtime.com.google.protobuf.ByteString
The runtime key to override the :ref:`default <config_http_filters_fault_injection_runtime>` runtime.The runtime key to override the :ref:`default <config_http_filters_fault_injection_runtime>` runtime.com.google.protobuf.ByteString
The runtime key to override the :ref:`default <config_http_filters_fault_injection_runtime>` runtime.If specified, the filter will abort requests based on the values in the object.The runtime key to override the :ref:`default <config_http_filters_fault_injection_runtime>` runtime.com.google.protobuf.ByteString
The runtime key to override the :ref:`default <config_http_filters_fault_injection_runtime>` runtime.getDelay()
If specified, the filter will inject delays based on the values in the object.The runtime key to override the :ref:`default <config_http_filters_fault_injection_runtime>` runtime.com.google.protobuf.ByteString
The runtime key to override the :ref:`default <config_http_filters_fault_injection_runtime>` runtime.If specified, the filter will inject delays based on the values in the object.The runtime key to override the :ref:`default <config_http_filters_fault_injection_runtime>` runtime.com.google.protobuf.ByteString
The runtime key to override the :ref:`default <config_http_filters_fault_injection_runtime>` runtime.boolean
To control whether stats storage is allocated dynamically for each downstream server.getDownstreamNodes
(int index) Faults are injected for the specified list of downstream hosts.com.google.protobuf.ByteString
getDownstreamNodesBytes
(int index) Faults are injected for the specified list of downstream hosts.int
Faults are injected for the specified list of downstream hosts.Faults are injected for the specified list of downstream hosts.com.google.protobuf.Struct
When an abort or delay fault is executed, the metadata struct provided here will be added to the request's dynamic metadata under the namespace corresponding to the name of the fault filter.com.google.protobuf.StructOrBuilder
When an abort or delay fault is executed, the metadata struct provided here will be added to the request's dynamic metadata under the namespace corresponding to the name of the fault filter.getHeaders
(int index) Specifies a set of headers that the filter should match on.int
Specifies a set of headers that the filter should match on.Specifies a set of headers that the filter should match on.getHeadersOrBuilder
(int index) Specifies a set of headers that the filter should match on.List
<? extends HeaderMatcherOrBuilder> Specifies a set of headers that the filter should match on.com.google.protobuf.UInt32Value
The maximum number of faults that can be active at a single time via the configured fault filter.com.google.protobuf.UInt32ValueOrBuilder
The maximum number of faults that can be active at a single time via the configured fault filter.The runtime key to override the :ref:`default <config_http_filters_fault_injection_runtime>` runtime.com.google.protobuf.ByteString
The runtime key to override the :ref:`default <config_http_filters_fault_injection_runtime>` runtime.The response rate limit to be applied to the response body of the stream.The response rate limit to be applied to the response body of the stream.The runtime key to override the :ref:`default <config_http_filters_fault_injection_runtime>` runtime.com.google.protobuf.ByteString
The runtime key to override the :ref:`default <config_http_filters_fault_injection_runtime>` runtime.Specifies the name of the (destination) upstream cluster that the filter should match on.com.google.protobuf.ByteString
Specifies the name of the (destination) upstream cluster that the filter should match on.boolean
hasAbort()
If specified, the filter will abort requests based on the values in the object.boolean
hasDelay()
If specified, the filter will inject delays based on the values in the object.boolean
When an abort or delay fault is executed, the metadata struct provided here will be added to the request's dynamic metadata under the namespace corresponding to the name of the fault filter.boolean
The maximum number of faults that can be active at a single time via the configured fault filter.boolean
The response rate limit to be applied to the response body of the stream.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
hasDelay
boolean hasDelay()If specified, the filter will inject delays based on the values in the object.
.envoy.extensions.filters.common.fault.v3.FaultDelay delay = 1;
- Returns:
- Whether the delay field is set.
-
getDelay
FaultDelay getDelay()If specified, the filter will inject delays based on the values in the object.
.envoy.extensions.filters.common.fault.v3.FaultDelay delay = 1;
- Returns:
- The delay.
-
getDelayOrBuilder
FaultDelayOrBuilder getDelayOrBuilder()If specified, the filter will inject delays based on the values in the object.
.envoy.extensions.filters.common.fault.v3.FaultDelay delay = 1;
-
hasAbort
boolean hasAbort()If specified, the filter will abort requests based on the values in the object. At least ``abort`` or ``delay`` must be specified.
.envoy.extensions.filters.http.fault.v3.FaultAbort abort = 2;
- Returns:
- Whether the abort field is set.
-
getAbort
FaultAbort getAbort()If specified, the filter will abort requests based on the values in the object. At least ``abort`` or ``delay`` must be specified.
.envoy.extensions.filters.http.fault.v3.FaultAbort abort = 2;
- Returns:
- The abort.
-
getAbortOrBuilder
FaultAbortOrBuilder getAbortOrBuilder()If specified, the filter will abort requests based on the values in the object. At least ``abort`` or ``delay`` must be specified.
.envoy.extensions.filters.http.fault.v3.FaultAbort abort = 2;
-
getUpstreamCluster
String getUpstreamCluster()Specifies the name of the (destination) upstream cluster that the filter should match on. Fault injection will be restricted to requests bound to the specific upstream cluster.
string upstream_cluster = 3;
- Returns:
- The upstreamCluster.
-
getUpstreamClusterBytes
com.google.protobuf.ByteString getUpstreamClusterBytes()Specifies the name of the (destination) upstream cluster that the filter should match on. Fault injection will be restricted to requests bound to the specific upstream cluster.
string upstream_cluster = 3;
- Returns:
- The bytes for upstreamCluster.
-
getHeadersList
List<HeaderMatcher> getHeadersList()Specifies a set of headers that the filter should match on. The fault injection filter can be applied selectively to requests that match a set of headers specified in the fault filter config. The chances of actual fault injection further depend on the value of the :ref:`percentage <envoy_v3_api_field_extensions.filters.http.fault.v3.FaultAbort.percentage>` field. The filter will check the request's headers against all the specified headers in the filter config. A match will happen if all the headers in the config are present in the request with the same values (or based on presence if the ``value`` field is not in the config).
repeated .envoy.config.route.v3.HeaderMatcher headers = 4;
-
getHeaders
Specifies a set of headers that the filter should match on. The fault injection filter can be applied selectively to requests that match a set of headers specified in the fault filter config. The chances of actual fault injection further depend on the value of the :ref:`percentage <envoy_v3_api_field_extensions.filters.http.fault.v3.FaultAbort.percentage>` field. The filter will check the request's headers against all the specified headers in the filter config. A match will happen if all the headers in the config are present in the request with the same values (or based on presence if the ``value`` field is not in the config).
repeated .envoy.config.route.v3.HeaderMatcher headers = 4;
-
getHeadersCount
int getHeadersCount()Specifies a set of headers that the filter should match on. The fault injection filter can be applied selectively to requests that match a set of headers specified in the fault filter config. The chances of actual fault injection further depend on the value of the :ref:`percentage <envoy_v3_api_field_extensions.filters.http.fault.v3.FaultAbort.percentage>` field. The filter will check the request's headers against all the specified headers in the filter config. A match will happen if all the headers in the config are present in the request with the same values (or based on presence if the ``value`` field is not in the config).
repeated .envoy.config.route.v3.HeaderMatcher headers = 4;
-
getHeadersOrBuilderList
List<? extends HeaderMatcherOrBuilder> getHeadersOrBuilderList()Specifies a set of headers that the filter should match on. The fault injection filter can be applied selectively to requests that match a set of headers specified in the fault filter config. The chances of actual fault injection further depend on the value of the :ref:`percentage <envoy_v3_api_field_extensions.filters.http.fault.v3.FaultAbort.percentage>` field. The filter will check the request's headers against all the specified headers in the filter config. A match will happen if all the headers in the config are present in the request with the same values (or based on presence if the ``value`` field is not in the config).
repeated .envoy.config.route.v3.HeaderMatcher headers = 4;
-
getHeadersOrBuilder
Specifies a set of headers that the filter should match on. The fault injection filter can be applied selectively to requests that match a set of headers specified in the fault filter config. The chances of actual fault injection further depend on the value of the :ref:`percentage <envoy_v3_api_field_extensions.filters.http.fault.v3.FaultAbort.percentage>` field. The filter will check the request's headers against all the specified headers in the filter config. A match will happen if all the headers in the config are present in the request with the same values (or based on presence if the ``value`` field is not in the config).
repeated .envoy.config.route.v3.HeaderMatcher headers = 4;
-
getDownstreamNodesList
Faults are injected for the specified list of downstream hosts. If this setting is not set, faults are injected for all downstream nodes. Downstream node name is taken from :ref:`the HTTP x-envoy-downstream-service-node <config_http_conn_man_headers_downstream-service-node>` header and compared against downstream_nodes list.
repeated string downstream_nodes = 5;
- Returns:
- A list containing the downstreamNodes.
-
getDownstreamNodesCount
int getDownstreamNodesCount()Faults are injected for the specified list of downstream hosts. If this setting is not set, faults are injected for all downstream nodes. Downstream node name is taken from :ref:`the HTTP x-envoy-downstream-service-node <config_http_conn_man_headers_downstream-service-node>` header and compared against downstream_nodes list.
repeated string downstream_nodes = 5;
- Returns:
- The count of downstreamNodes.
-
getDownstreamNodes
Faults are injected for the specified list of downstream hosts. If this setting is not set, faults are injected for all downstream nodes. Downstream node name is taken from :ref:`the HTTP x-envoy-downstream-service-node <config_http_conn_man_headers_downstream-service-node>` header and compared against downstream_nodes list.
repeated string downstream_nodes = 5;
- Parameters:
index
- The index of the element to return.- Returns:
- The downstreamNodes at the given index.
-
getDownstreamNodesBytes
com.google.protobuf.ByteString getDownstreamNodesBytes(int index) Faults are injected for the specified list of downstream hosts. If this setting is not set, faults are injected for all downstream nodes. Downstream node name is taken from :ref:`the HTTP x-envoy-downstream-service-node <config_http_conn_man_headers_downstream-service-node>` header and compared against downstream_nodes list.
repeated string downstream_nodes = 5;
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the downstreamNodes at the given index.
-
hasMaxActiveFaults
boolean hasMaxActiveFaults()The maximum number of faults that can be active at a single time via the configured fault filter. Note that because this setting can be overridden at the route level, it's possible for the number of active faults to be greater than this value (if injected via a different route). If not specified, defaults to unlimited. This setting can be overridden via ``runtime <config_http_filters_fault_injection_runtime>`` and any faults that are not injected due to overflow will be indicated via the ``faults_overflow <config_http_filters_fault_injection_stats>`` stat. .. attention:: Like other :ref:`circuit breakers <arch_overview_circuit_break>` in Envoy, this is a fuzzy limit. It's possible for the number of active faults to rise slightly above the configured amount due to the implementation details.
.google.protobuf.UInt32Value max_active_faults = 6;
- Returns:
- Whether the maxActiveFaults field is set.
-
getMaxActiveFaults
com.google.protobuf.UInt32Value getMaxActiveFaults()The maximum number of faults that can be active at a single time via the configured fault filter. Note that because this setting can be overridden at the route level, it's possible for the number of active faults to be greater than this value (if injected via a different route). If not specified, defaults to unlimited. This setting can be overridden via ``runtime <config_http_filters_fault_injection_runtime>`` and any faults that are not injected due to overflow will be indicated via the ``faults_overflow <config_http_filters_fault_injection_stats>`` stat. .. attention:: Like other :ref:`circuit breakers <arch_overview_circuit_break>` in Envoy, this is a fuzzy limit. It's possible for the number of active faults to rise slightly above the configured amount due to the implementation details.
.google.protobuf.UInt32Value max_active_faults = 6;
- Returns:
- The maxActiveFaults.
-
getMaxActiveFaultsOrBuilder
com.google.protobuf.UInt32ValueOrBuilder getMaxActiveFaultsOrBuilder()The maximum number of faults that can be active at a single time via the configured fault filter. Note that because this setting can be overridden at the route level, it's possible for the number of active faults to be greater than this value (if injected via a different route). If not specified, defaults to unlimited. This setting can be overridden via ``runtime <config_http_filters_fault_injection_runtime>`` and any faults that are not injected due to overflow will be indicated via the ``faults_overflow <config_http_filters_fault_injection_stats>`` stat. .. attention:: Like other :ref:`circuit breakers <arch_overview_circuit_break>` in Envoy, this is a fuzzy limit. It's possible for the number of active faults to rise slightly above the configured amount due to the implementation details.
.google.protobuf.UInt32Value max_active_faults = 6;
-
hasResponseRateLimit
boolean hasResponseRateLimit()The response rate limit to be applied to the response body of the stream. When configured, the percentage can be overridden by the :ref:`fault.http.rate_limit.response_percent <config_http_filters_fault_injection_runtime>` runtime key. .. attention:: This is a per-stream limit versus a connection level limit. This means that concurrent streams will each get an independent limit.
.envoy.extensions.filters.common.fault.v3.FaultRateLimit response_rate_limit = 7;
- Returns:
- Whether the responseRateLimit field is set.
-
getResponseRateLimit
FaultRateLimit getResponseRateLimit()The response rate limit to be applied to the response body of the stream. When configured, the percentage can be overridden by the :ref:`fault.http.rate_limit.response_percent <config_http_filters_fault_injection_runtime>` runtime key. .. attention:: This is a per-stream limit versus a connection level limit. This means that concurrent streams will each get an independent limit.
.envoy.extensions.filters.common.fault.v3.FaultRateLimit response_rate_limit = 7;
- Returns:
- The responseRateLimit.
-
getResponseRateLimitOrBuilder
FaultRateLimitOrBuilder getResponseRateLimitOrBuilder()The response rate limit to be applied to the response body of the stream. When configured, the percentage can be overridden by the :ref:`fault.http.rate_limit.response_percent <config_http_filters_fault_injection_runtime>` runtime key. .. attention:: This is a per-stream limit versus a connection level limit. This means that concurrent streams will each get an independent limit.
.envoy.extensions.filters.common.fault.v3.FaultRateLimit response_rate_limit = 7;
-
getDelayPercentRuntime
String getDelayPercentRuntime()The runtime key to override the :ref:`default <config_http_filters_fault_injection_runtime>` runtime. The default is: fault.http.delay.fixed_delay_percent
string delay_percent_runtime = 8;
- Returns:
- The delayPercentRuntime.
-
getDelayPercentRuntimeBytes
com.google.protobuf.ByteString getDelayPercentRuntimeBytes()The runtime key to override the :ref:`default <config_http_filters_fault_injection_runtime>` runtime. The default is: fault.http.delay.fixed_delay_percent
string delay_percent_runtime = 8;
- Returns:
- The bytes for delayPercentRuntime.
-
getAbortPercentRuntime
String getAbortPercentRuntime()The runtime key to override the :ref:`default <config_http_filters_fault_injection_runtime>` runtime. The default is: fault.http.abort.abort_percent
string abort_percent_runtime = 9;
- Returns:
- The abortPercentRuntime.
-
getAbortPercentRuntimeBytes
com.google.protobuf.ByteString getAbortPercentRuntimeBytes()The runtime key to override the :ref:`default <config_http_filters_fault_injection_runtime>` runtime. The default is: fault.http.abort.abort_percent
string abort_percent_runtime = 9;
- Returns:
- The bytes for abortPercentRuntime.
-
getDelayDurationRuntime
String getDelayDurationRuntime()The runtime key to override the :ref:`default <config_http_filters_fault_injection_runtime>` runtime. The default is: fault.http.delay.fixed_duration_ms
string delay_duration_runtime = 10;
- Returns:
- The delayDurationRuntime.
-
getDelayDurationRuntimeBytes
com.google.protobuf.ByteString getDelayDurationRuntimeBytes()The runtime key to override the :ref:`default <config_http_filters_fault_injection_runtime>` runtime. The default is: fault.http.delay.fixed_duration_ms
string delay_duration_runtime = 10;
- Returns:
- The bytes for delayDurationRuntime.
-
getAbortHttpStatusRuntime
String getAbortHttpStatusRuntime()The runtime key to override the :ref:`default <config_http_filters_fault_injection_runtime>` runtime. The default is: fault.http.abort.http_status
string abort_http_status_runtime = 11;
- Returns:
- The abortHttpStatusRuntime.
-
getAbortHttpStatusRuntimeBytes
com.google.protobuf.ByteString getAbortHttpStatusRuntimeBytes()The runtime key to override the :ref:`default <config_http_filters_fault_injection_runtime>` runtime. The default is: fault.http.abort.http_status
string abort_http_status_runtime = 11;
- Returns:
- The bytes for abortHttpStatusRuntime.
-
getMaxActiveFaultsRuntime
String getMaxActiveFaultsRuntime()The runtime key to override the :ref:`default <config_http_filters_fault_injection_runtime>` runtime. The default is: fault.http.max_active_faults
string max_active_faults_runtime = 12;
- Returns:
- The maxActiveFaultsRuntime.
-
getMaxActiveFaultsRuntimeBytes
com.google.protobuf.ByteString getMaxActiveFaultsRuntimeBytes()The runtime key to override the :ref:`default <config_http_filters_fault_injection_runtime>` runtime. The default is: fault.http.max_active_faults
string max_active_faults_runtime = 12;
- Returns:
- The bytes for maxActiveFaultsRuntime.
-
getResponseRateLimitPercentRuntime
String getResponseRateLimitPercentRuntime()The runtime key to override the :ref:`default <config_http_filters_fault_injection_runtime>` runtime. The default is: fault.http.rate_limit.response_percent
string response_rate_limit_percent_runtime = 13;
- Returns:
- The responseRateLimitPercentRuntime.
-
getResponseRateLimitPercentRuntimeBytes
com.google.protobuf.ByteString getResponseRateLimitPercentRuntimeBytes()The runtime key to override the :ref:`default <config_http_filters_fault_injection_runtime>` runtime. The default is: fault.http.rate_limit.response_percent
string response_rate_limit_percent_runtime = 13;
- Returns:
- The bytes for responseRateLimitPercentRuntime.
-
getAbortGrpcStatusRuntime
String getAbortGrpcStatusRuntime()The runtime key to override the :ref:`default <config_http_filters_fault_injection_runtime>` runtime. The default is: fault.http.abort.grpc_status
string abort_grpc_status_runtime = 14;
- Returns:
- The abortGrpcStatusRuntime.
-
getAbortGrpcStatusRuntimeBytes
com.google.protobuf.ByteString getAbortGrpcStatusRuntimeBytes()The runtime key to override the :ref:`default <config_http_filters_fault_injection_runtime>` runtime. The default is: fault.http.abort.grpc_status
string abort_grpc_status_runtime = 14;
- Returns:
- The bytes for abortGrpcStatusRuntime.
-
getDisableDownstreamClusterStats
boolean getDisableDownstreamClusterStats()To control whether stats storage is allocated dynamically for each downstream server. If set to true, "x-envoy-downstream-service-cluster" field of header will be ignored by this filter. If set to false, dynamic stats storage will be allocated for the downstream cluster name. Default value is false.
bool disable_downstream_cluster_stats = 15;
- Returns:
- The disableDownstreamClusterStats.
-
hasFilterMetadata
boolean hasFilterMetadata()When an abort or delay fault is executed, the metadata struct provided here will be added to the request's dynamic metadata under the namespace corresponding to the name of the fault filter. This data can be logged as part of Access Logs using the :ref:`command operator <config_access_log_command_operators>` %DYNAMIC_METADATA(NAMESPACE)%, where NAMESPACE is the name of the fault filter.
.google.protobuf.Struct filter_metadata = 16;
- Returns:
- Whether the filterMetadata field is set.
-
getFilterMetadata
com.google.protobuf.Struct getFilterMetadata()When an abort or delay fault is executed, the metadata struct provided here will be added to the request's dynamic metadata under the namespace corresponding to the name of the fault filter. This data can be logged as part of Access Logs using the :ref:`command operator <config_access_log_command_operators>` %DYNAMIC_METADATA(NAMESPACE)%, where NAMESPACE is the name of the fault filter.
.google.protobuf.Struct filter_metadata = 16;
- Returns:
- The filterMetadata.
-
getFilterMetadataOrBuilder
com.google.protobuf.StructOrBuilder getFilterMetadataOrBuilder()When an abort or delay fault is executed, the metadata struct provided here will be added to the request's dynamic metadata under the namespace corresponding to the name of the fault filter. This data can be logged as part of Access Logs using the :ref:`command operator <config_access_log_command_operators>` %DYNAMIC_METADATA(NAMESPACE)%, where NAMESPACE is the name of the fault filter.
.google.protobuf.Struct filter_metadata = 16;
-