io.envoyproxy.envoy.data.accesslog.v2.AccessLogCommonOrBuilder Maven / Gradle / Ivy
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: envoy/data/accesslog/v2/accesslog.proto
package io.envoyproxy.envoy.data.accesslog.v2;
public interface AccessLogCommonOrBuilder extends
// @@protoc_insertion_point(interface_extends:envoy.data.accesslog.v2.AccessLogCommon)
com.google.protobuf.MessageOrBuilder {
/**
*
* [#not-implemented-hide:]
* This field indicates the rate at which this log entry was sampled.
* Valid range is (0.0, 1.0].
*
*
* double sample_rate = 1 [(.validate.rules) = { ... }
* @return The sampleRate.
*/
double getSampleRate();
/**
*
* This field is the remote/origin address on which the request from the user was received.
* Note: This may not be the physical peer. E.g, if the remote address is inferred from for
* example the x-forwarder-for header, proxy protocol, etc.
*
*
* .envoy.api.v2.core.Address downstream_remote_address = 2;
* @return Whether the downstreamRemoteAddress field is set.
*/
boolean hasDownstreamRemoteAddress();
/**
*
* This field is the remote/origin address on which the request from the user was received.
* Note: This may not be the physical peer. E.g, if the remote address is inferred from for
* example the x-forwarder-for header, proxy protocol, etc.
*
*
* .envoy.api.v2.core.Address downstream_remote_address = 2;
* @return The downstreamRemoteAddress.
*/
io.envoyproxy.envoy.api.v2.core.Address getDownstreamRemoteAddress();
/**
*
* This field is the remote/origin address on which the request from the user was received.
* Note: This may not be the physical peer. E.g, if the remote address is inferred from for
* example the x-forwarder-for header, proxy protocol, etc.
*
*
* .envoy.api.v2.core.Address downstream_remote_address = 2;
*/
io.envoyproxy.envoy.api.v2.core.AddressOrBuilder getDownstreamRemoteAddressOrBuilder();
/**
*
* This field is the local/destination address on which the request from the user was received.
*
*
* .envoy.api.v2.core.Address downstream_local_address = 3;
* @return Whether the downstreamLocalAddress field is set.
*/
boolean hasDownstreamLocalAddress();
/**
*
* This field is the local/destination address on which the request from the user was received.
*
*
* .envoy.api.v2.core.Address downstream_local_address = 3;
* @return The downstreamLocalAddress.
*/
io.envoyproxy.envoy.api.v2.core.Address getDownstreamLocalAddress();
/**
*
* This field is the local/destination address on which the request from the user was received.
*
*
* .envoy.api.v2.core.Address downstream_local_address = 3;
*/
io.envoyproxy.envoy.api.v2.core.AddressOrBuilder getDownstreamLocalAddressOrBuilder();
/**
*
* If the connection is secure,S this field will contain TLS properties.
*
*
* .envoy.data.accesslog.v2.TLSProperties tls_properties = 4;
* @return Whether the tlsProperties field is set.
*/
boolean hasTlsProperties();
/**
*
* If the connection is secure,S this field will contain TLS properties.
*
*
* .envoy.data.accesslog.v2.TLSProperties tls_properties = 4;
* @return The tlsProperties.
*/
io.envoyproxy.envoy.data.accesslog.v2.TLSProperties getTlsProperties();
/**
*
* If the connection is secure,S this field will contain TLS properties.
*
*
* .envoy.data.accesslog.v2.TLSProperties tls_properties = 4;
*/
io.envoyproxy.envoy.data.accesslog.v2.TLSPropertiesOrBuilder getTlsPropertiesOrBuilder();
/**
*
* The time that Envoy started servicing this request. This is effectively the time that the first
* downstream byte is received.
*
*
* .google.protobuf.Timestamp start_time = 5;
* @return Whether the startTime field is set.
*/
boolean hasStartTime();
/**
*
* The time that Envoy started servicing this request. This is effectively the time that the first
* downstream byte is received.
*
*
* .google.protobuf.Timestamp start_time = 5;
* @return The startTime.
*/
com.google.protobuf.Timestamp getStartTime();
/**
*
* The time that Envoy started servicing this request. This is effectively the time that the first
* downstream byte is received.
*
*
* .google.protobuf.Timestamp start_time = 5;
*/
com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder();
/**
*
* Interval between the first downstream byte received and the last
* downstream byte received (i.e. time it takes to receive a request).
*
*
* .google.protobuf.Duration time_to_last_rx_byte = 6;
* @return Whether the timeToLastRxByte field is set.
*/
boolean hasTimeToLastRxByte();
/**
*
* Interval between the first downstream byte received and the last
* downstream byte received (i.e. time it takes to receive a request).
*
*
* .google.protobuf.Duration time_to_last_rx_byte = 6;
* @return The timeToLastRxByte.
*/
com.google.protobuf.Duration getTimeToLastRxByte();
/**
*
* Interval between the first downstream byte received and the last
* downstream byte received (i.e. time it takes to receive a request).
*
*
* .google.protobuf.Duration time_to_last_rx_byte = 6;
*/
com.google.protobuf.DurationOrBuilder getTimeToLastRxByteOrBuilder();
/**
*
* Interval between the first downstream byte received and the first upstream byte sent. There may
* by considerable delta between *time_to_last_rx_byte* and this value due to filters.
* Additionally, the same caveats apply as documented in *time_to_last_downstream_tx_byte* about
* not accounting for kernel socket buffer time, etc.
*
*
* .google.protobuf.Duration time_to_first_upstream_tx_byte = 7;
* @return Whether the timeToFirstUpstreamTxByte field is set.
*/
boolean hasTimeToFirstUpstreamTxByte();
/**
*
* Interval between the first downstream byte received and the first upstream byte sent. There may
* by considerable delta between *time_to_last_rx_byte* and this value due to filters.
* Additionally, the same caveats apply as documented in *time_to_last_downstream_tx_byte* about
* not accounting for kernel socket buffer time, etc.
*
*
* .google.protobuf.Duration time_to_first_upstream_tx_byte = 7;
* @return The timeToFirstUpstreamTxByte.
*/
com.google.protobuf.Duration getTimeToFirstUpstreamTxByte();
/**
*
* Interval between the first downstream byte received and the first upstream byte sent. There may
* by considerable delta between *time_to_last_rx_byte* and this value due to filters.
* Additionally, the same caveats apply as documented in *time_to_last_downstream_tx_byte* about
* not accounting for kernel socket buffer time, etc.
*
*
* .google.protobuf.Duration time_to_first_upstream_tx_byte = 7;
*/
com.google.protobuf.DurationOrBuilder getTimeToFirstUpstreamTxByteOrBuilder();
/**
*
* Interval between the first downstream byte received and the last upstream byte sent. There may
* by considerable delta between *time_to_last_rx_byte* and this value due to filters.
* Additionally, the same caveats apply as documented in *time_to_last_downstream_tx_byte* about
* not accounting for kernel socket buffer time, etc.
*
*
* .google.protobuf.Duration time_to_last_upstream_tx_byte = 8;
* @return Whether the timeToLastUpstreamTxByte field is set.
*/
boolean hasTimeToLastUpstreamTxByte();
/**
*
* Interval between the first downstream byte received and the last upstream byte sent. There may
* by considerable delta between *time_to_last_rx_byte* and this value due to filters.
* Additionally, the same caveats apply as documented in *time_to_last_downstream_tx_byte* about
* not accounting for kernel socket buffer time, etc.
*
*
* .google.protobuf.Duration time_to_last_upstream_tx_byte = 8;
* @return The timeToLastUpstreamTxByte.
*/
com.google.protobuf.Duration getTimeToLastUpstreamTxByte();
/**
*
* Interval between the first downstream byte received and the last upstream byte sent. There may
* by considerable delta between *time_to_last_rx_byte* and this value due to filters.
* Additionally, the same caveats apply as documented in *time_to_last_downstream_tx_byte* about
* not accounting for kernel socket buffer time, etc.
*
*
* .google.protobuf.Duration time_to_last_upstream_tx_byte = 8;
*/
com.google.protobuf.DurationOrBuilder getTimeToLastUpstreamTxByteOrBuilder();
/**
*
* Interval between the first downstream byte received and the first upstream
* byte received (i.e. time it takes to start receiving a response).
*
*
* .google.protobuf.Duration time_to_first_upstream_rx_byte = 9;
* @return Whether the timeToFirstUpstreamRxByte field is set.
*/
boolean hasTimeToFirstUpstreamRxByte();
/**
*
* Interval between the first downstream byte received and the first upstream
* byte received (i.e. time it takes to start receiving a response).
*
*
* .google.protobuf.Duration time_to_first_upstream_rx_byte = 9;
* @return The timeToFirstUpstreamRxByte.
*/
com.google.protobuf.Duration getTimeToFirstUpstreamRxByte();
/**
*
* Interval between the first downstream byte received and the first upstream
* byte received (i.e. time it takes to start receiving a response).
*
*
* .google.protobuf.Duration time_to_first_upstream_rx_byte = 9;
*/
com.google.protobuf.DurationOrBuilder getTimeToFirstUpstreamRxByteOrBuilder();
/**
*
* Interval between the first downstream byte received and the last upstream
* byte received (i.e. time it takes to receive a complete response).
*
*
* .google.protobuf.Duration time_to_last_upstream_rx_byte = 10;
* @return Whether the timeToLastUpstreamRxByte field is set.
*/
boolean hasTimeToLastUpstreamRxByte();
/**
*
* Interval between the first downstream byte received and the last upstream
* byte received (i.e. time it takes to receive a complete response).
*
*
* .google.protobuf.Duration time_to_last_upstream_rx_byte = 10;
* @return The timeToLastUpstreamRxByte.
*/
com.google.protobuf.Duration getTimeToLastUpstreamRxByte();
/**
*
* Interval between the first downstream byte received and the last upstream
* byte received (i.e. time it takes to receive a complete response).
*
*
* .google.protobuf.Duration time_to_last_upstream_rx_byte = 10;
*/
com.google.protobuf.DurationOrBuilder getTimeToLastUpstreamRxByteOrBuilder();
/**
*
* Interval between the first downstream byte received and the first downstream byte sent.
* There may be a considerable delta between the *time_to_first_upstream_rx_byte* and this field
* due to filters. Additionally, the same caveats apply as documented in
* *time_to_last_downstream_tx_byte* about not accounting for kernel socket buffer time, etc.
*
*
* .google.protobuf.Duration time_to_first_downstream_tx_byte = 11;
* @return Whether the timeToFirstDownstreamTxByte field is set.
*/
boolean hasTimeToFirstDownstreamTxByte();
/**
*
* Interval between the first downstream byte received and the first downstream byte sent.
* There may be a considerable delta between the *time_to_first_upstream_rx_byte* and this field
* due to filters. Additionally, the same caveats apply as documented in
* *time_to_last_downstream_tx_byte* about not accounting for kernel socket buffer time, etc.
*
*
* .google.protobuf.Duration time_to_first_downstream_tx_byte = 11;
* @return The timeToFirstDownstreamTxByte.
*/
com.google.protobuf.Duration getTimeToFirstDownstreamTxByte();
/**
*
* Interval between the first downstream byte received and the first downstream byte sent.
* There may be a considerable delta between the *time_to_first_upstream_rx_byte* and this field
* due to filters. Additionally, the same caveats apply as documented in
* *time_to_last_downstream_tx_byte* about not accounting for kernel socket buffer time, etc.
*
*
* .google.protobuf.Duration time_to_first_downstream_tx_byte = 11;
*/
com.google.protobuf.DurationOrBuilder getTimeToFirstDownstreamTxByteOrBuilder();
/**
*
* Interval between the first downstream byte received and the last downstream byte sent.
* Depending on protocol, buffering, windowing, filters, etc. there may be a considerable delta
* between *time_to_last_upstream_rx_byte* and this field. Note also that this is an approximate
* time. In the current implementation it does not include kernel socket buffer time. In the
* current implementation it also does not include send window buffering inside the HTTP/2 codec.
* In the future it is likely that work will be done to make this duration more accurate.
*
*
* .google.protobuf.Duration time_to_last_downstream_tx_byte = 12;
* @return Whether the timeToLastDownstreamTxByte field is set.
*/
boolean hasTimeToLastDownstreamTxByte();
/**
*
* Interval between the first downstream byte received and the last downstream byte sent.
* Depending on protocol, buffering, windowing, filters, etc. there may be a considerable delta
* between *time_to_last_upstream_rx_byte* and this field. Note also that this is an approximate
* time. In the current implementation it does not include kernel socket buffer time. In the
* current implementation it also does not include send window buffering inside the HTTP/2 codec.
* In the future it is likely that work will be done to make this duration more accurate.
*
*
* .google.protobuf.Duration time_to_last_downstream_tx_byte = 12;
* @return The timeToLastDownstreamTxByte.
*/
com.google.protobuf.Duration getTimeToLastDownstreamTxByte();
/**
*
* Interval between the first downstream byte received and the last downstream byte sent.
* Depending on protocol, buffering, windowing, filters, etc. there may be a considerable delta
* between *time_to_last_upstream_rx_byte* and this field. Note also that this is an approximate
* time. In the current implementation it does not include kernel socket buffer time. In the
* current implementation it also does not include send window buffering inside the HTTP/2 codec.
* In the future it is likely that work will be done to make this duration more accurate.
*
*
* .google.protobuf.Duration time_to_last_downstream_tx_byte = 12;
*/
com.google.protobuf.DurationOrBuilder getTimeToLastDownstreamTxByteOrBuilder();
/**
*
* The upstream remote/destination address that handles this exchange. This does not include
* retries.
*
*
* .envoy.api.v2.core.Address upstream_remote_address = 13;
* @return Whether the upstreamRemoteAddress field is set.
*/
boolean hasUpstreamRemoteAddress();
/**
*
* The upstream remote/destination address that handles this exchange. This does not include
* retries.
*
*
* .envoy.api.v2.core.Address upstream_remote_address = 13;
* @return The upstreamRemoteAddress.
*/
io.envoyproxy.envoy.api.v2.core.Address getUpstreamRemoteAddress();
/**
*
* The upstream remote/destination address that handles this exchange. This does not include
* retries.
*
*
* .envoy.api.v2.core.Address upstream_remote_address = 13;
*/
io.envoyproxy.envoy.api.v2.core.AddressOrBuilder getUpstreamRemoteAddressOrBuilder();
/**
*
* The upstream local/origin address that handles this exchange. This does not include retries.
*
*
* .envoy.api.v2.core.Address upstream_local_address = 14;
* @return Whether the upstreamLocalAddress field is set.
*/
boolean hasUpstreamLocalAddress();
/**
*
* The upstream local/origin address that handles this exchange. This does not include retries.
*
*
* .envoy.api.v2.core.Address upstream_local_address = 14;
* @return The upstreamLocalAddress.
*/
io.envoyproxy.envoy.api.v2.core.Address getUpstreamLocalAddress();
/**
*
* The upstream local/origin address that handles this exchange. This does not include retries.
*
*
* .envoy.api.v2.core.Address upstream_local_address = 14;
*/
io.envoyproxy.envoy.api.v2.core.AddressOrBuilder getUpstreamLocalAddressOrBuilder();
/**
*
* The upstream cluster that *upstream_remote_address* belongs to.
*
*
* string upstream_cluster = 15;
* @return The upstreamCluster.
*/
java.lang.String getUpstreamCluster();
/**
*
* The upstream cluster that *upstream_remote_address* belongs to.
*
*
* string upstream_cluster = 15;
* @return The bytes for upstreamCluster.
*/
com.google.protobuf.ByteString
getUpstreamClusterBytes();
/**
*
* Flags indicating occurrences during request/response processing.
*
*
* .envoy.data.accesslog.v2.ResponseFlags response_flags = 16;
* @return Whether the responseFlags field is set.
*/
boolean hasResponseFlags();
/**
*
* Flags indicating occurrences during request/response processing.
*
*
* .envoy.data.accesslog.v2.ResponseFlags response_flags = 16;
* @return The responseFlags.
*/
io.envoyproxy.envoy.data.accesslog.v2.ResponseFlags getResponseFlags();
/**
*
* Flags indicating occurrences during request/response processing.
*
*
* .envoy.data.accesslog.v2.ResponseFlags response_flags = 16;
*/
io.envoyproxy.envoy.data.accesslog.v2.ResponseFlagsOrBuilder getResponseFlagsOrBuilder();
/**
*
* All metadata encountered during request processing, including endpoint
* selection.
* This can be used to associate IDs attached to the various configurations
* used to process this request with the access log entry. For example, a
* route created from a higher level forwarding rule with some ID can place
* that ID in this field and cross reference later. It can also be used to
* determine if a canary endpoint was used or not.
*
*
* .envoy.api.v2.core.Metadata metadata = 17;
* @return Whether the metadata field is set.
*/
boolean hasMetadata();
/**
*
* All metadata encountered during request processing, including endpoint
* selection.
* This can be used to associate IDs attached to the various configurations
* used to process this request with the access log entry. For example, a
* route created from a higher level forwarding rule with some ID can place
* that ID in this field and cross reference later. It can also be used to
* determine if a canary endpoint was used or not.
*
*
* .envoy.api.v2.core.Metadata metadata = 17;
* @return The metadata.
*/
io.envoyproxy.envoy.api.v2.core.Metadata getMetadata();
/**
*
* All metadata encountered during request processing, including endpoint
* selection.
* This can be used to associate IDs attached to the various configurations
* used to process this request with the access log entry. For example, a
* route created from a higher level forwarding rule with some ID can place
* that ID in this field and cross reference later. It can also be used to
* determine if a canary endpoint was used or not.
*
*
* .envoy.api.v2.core.Metadata metadata = 17;
*/
io.envoyproxy.envoy.api.v2.core.MetadataOrBuilder getMetadataOrBuilder();
/**
*
* If upstream connection failed due to transport socket (e.g. TLS handshake), provides the
* failure reason from the transport socket. The format of this field depends on the configured
* upstream transport socket. Common TLS failures are in
* :ref:`TLS trouble shooting <arch_overview_ssl_trouble_shooting>`.
*
*
* string upstream_transport_failure_reason = 18;
* @return The upstreamTransportFailureReason.
*/
java.lang.String getUpstreamTransportFailureReason();
/**
*
* If upstream connection failed due to transport socket (e.g. TLS handshake), provides the
* failure reason from the transport socket. The format of this field depends on the configured
* upstream transport socket. Common TLS failures are in
* :ref:`TLS trouble shooting <arch_overview_ssl_trouble_shooting>`.
*
*
* string upstream_transport_failure_reason = 18;
* @return The bytes for upstreamTransportFailureReason.
*/
com.google.protobuf.ByteString
getUpstreamTransportFailureReasonBytes();
/**
*
* The name of the route
*
*
* string route_name = 19;
* @return The routeName.
*/
java.lang.String getRouteName();
/**
*
* The name of the route
*
*
* string route_name = 19;
* @return The bytes for routeName.
*/
com.google.protobuf.ByteString
getRouteNameBytes();
/**
*
* This field is the downstream direct remote address on which the request from the user was
* received. Note: This is always the physical peer, even if the remote address is inferred from
* for example the x-forwarder-for header, proxy protocol, etc.
*
*
* .envoy.api.v2.core.Address downstream_direct_remote_address = 20;
* @return Whether the downstreamDirectRemoteAddress field is set.
*/
boolean hasDownstreamDirectRemoteAddress();
/**
*
* This field is the downstream direct remote address on which the request from the user was
* received. Note: This is always the physical peer, even if the remote address is inferred from
* for example the x-forwarder-for header, proxy protocol, etc.
*
*
* .envoy.api.v2.core.Address downstream_direct_remote_address = 20;
* @return The downstreamDirectRemoteAddress.
*/
io.envoyproxy.envoy.api.v2.core.Address getDownstreamDirectRemoteAddress();
/**
*
* This field is the downstream direct remote address on which the request from the user was
* received. Note: This is always the physical peer, even if the remote address is inferred from
* for example the x-forwarder-for header, proxy protocol, etc.
*
*
* .envoy.api.v2.core.Address downstream_direct_remote_address = 20;
*/
io.envoyproxy.envoy.api.v2.core.AddressOrBuilder getDownstreamDirectRemoteAddressOrBuilder();
/**
*
* Map of filter state in stream info that have been configured to be logged. If the filter
* state serialized to any message other than `google.protobuf.Any` it will be packed into
* `google.protobuf.Any`.
*
*
* map<string, .google.protobuf.Any> filter_state_objects = 21;
*/
int getFilterStateObjectsCount();
/**
*
* Map of filter state in stream info that have been configured to be logged. If the filter
* state serialized to any message other than `google.protobuf.Any` it will be packed into
* `google.protobuf.Any`.
*
*
* map<string, .google.protobuf.Any> filter_state_objects = 21;
*/
boolean containsFilterStateObjects(
java.lang.String key);
/**
* Use {@link #getFilterStateObjectsMap()} instead.
*/
@java.lang.Deprecated
java.util.Map
getFilterStateObjects();
/**
*
* Map of filter state in stream info that have been configured to be logged. If the filter
* state serialized to any message other than `google.protobuf.Any` it will be packed into
* `google.protobuf.Any`.
*
*
* map<string, .google.protobuf.Any> filter_state_objects = 21;
*/
java.util.Map
getFilterStateObjectsMap();
/**
*
* Map of filter state in stream info that have been configured to be logged. If the filter
* state serialized to any message other than `google.protobuf.Any` it will be packed into
* `google.protobuf.Any`.
*
*
* map<string, .google.protobuf.Any> filter_state_objects = 21;
*/
/* nullable */
com.google.protobuf.Any getFilterStateObjectsOrDefault(
java.lang.String key,
/* nullable */
com.google.protobuf.Any defaultValue);
/**
*
* Map of filter state in stream info that have been configured to be logged. If the filter
* state serialized to any message other than `google.protobuf.Any` it will be packed into
* `google.protobuf.Any`.
*
*
* map<string, .google.protobuf.Any> filter_state_objects = 21;
*/
com.google.protobuf.Any getFilterStateObjectsOrThrow(
java.lang.String key);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy