// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: envoy/extensions/access_loggers/grpc/v3/als.proto
package io.envoyproxy.envoy.extensions.access_loggers.grpc.v3;
public interface CommonGrpcAccessLogConfigOrBuilder extends
// @@protoc_insertion_point(interface_extends:envoy.extensions.access_loggers.grpc.v3.CommonGrpcAccessLogConfig)
com.google.protobuf.MessageOrBuilder {
/**
*
* The friendly name of the access log to be returned in :ref:`StreamAccessLogsMessage.Identifier
* <envoy_v3_api_msg_service.accesslog.v3.StreamAccessLogsMessage.Identifier>`. This allows the
* access log server to differentiate between different access logs coming from the same Envoy.
*
*
* string log_name = 1 [(.validate.rules) = { ... }
* @return The logName.
*/
java.lang.String getLogName();
/**
*
* The friendly name of the access log to be returned in :ref:`StreamAccessLogsMessage.Identifier
* <envoy_v3_api_msg_service.accesslog.v3.StreamAccessLogsMessage.Identifier>`. This allows the
* access log server to differentiate between different access logs coming from the same Envoy.
*
*
* string log_name = 1 [(.validate.rules) = { ... }
* @return The bytes for logName.
*/
com.google.protobuf.ByteString
getLogNameBytes();
/**
*
* The gRPC service for the access log service.
*
*
* .envoy.config.core.v3.GrpcService grpc_service = 2 [(.validate.rules) = { ... }
* @return Whether the grpcService field is set.
*/
boolean hasGrpcService();
/**
*
* The gRPC service for the access log service.
*
*
* .envoy.config.core.v3.GrpcService grpc_service = 2 [(.validate.rules) = { ... }
* @return The grpcService.
*/
io.envoyproxy.envoy.config.core.v3.GrpcService getGrpcService();
/**
*
* The gRPC service for the access log service.
*
*
* .envoy.config.core.v3.GrpcService grpc_service = 2 [(.validate.rules) = { ... }
*/
io.envoyproxy.envoy.config.core.v3.GrpcServiceOrBuilder getGrpcServiceOrBuilder();
/**
*
* API version for access logs service transport protocol. This describes the access logs service
* gRPC endpoint and version of messages used on the wire.
*
*
* .envoy.config.core.v3.ApiVersion transport_api_version = 6 [(.validate.rules) = { ... }
* @return The enum numeric value on the wire for transportApiVersion.
*/
int getTransportApiVersionValue();
/**
*
* API version for access logs service transport protocol. This describes the access logs service
* gRPC endpoint and version of messages used on the wire.
*
*
* .envoy.config.core.v3.ApiVersion transport_api_version = 6 [(.validate.rules) = { ... }
* @return The transportApiVersion.
*/
io.envoyproxy.envoy.config.core.v3.ApiVersion getTransportApiVersion();
/**
*
* Interval for flushing access logs to the gRPC stream. Logger will flush requests every time
* this interval is elapsed, or when batch size limit is hit, whichever comes first. Defaults to
* 1 second.
*
*
* .google.protobuf.Duration buffer_flush_interval = 3 [(.validate.rules) = { ... }
* @return Whether the bufferFlushInterval field is set.
*/
boolean hasBufferFlushInterval();
/**
*
* Interval for flushing access logs to the gRPC stream. Logger will flush requests every time
* this interval is elapsed, or when batch size limit is hit, whichever comes first. Defaults to
* 1 second.
*
*
* .google.protobuf.Duration buffer_flush_interval = 3 [(.validate.rules) = { ... }
* @return The bufferFlushInterval.
*/
com.google.protobuf.Duration getBufferFlushInterval();
/**
*
* Interval for flushing access logs to the gRPC stream. Logger will flush requests every time
* this interval is elapsed, or when batch size limit is hit, whichever comes first. Defaults to
* 1 second.
*
*
* .google.protobuf.Duration buffer_flush_interval = 3 [(.validate.rules) = { ... }
*/
com.google.protobuf.DurationOrBuilder getBufferFlushIntervalOrBuilder();
/**
*
* Soft size limit in bytes for access log entries buffer. Logger will buffer requests until
* this limit it hit, or every time flush interval is elapsed, whichever comes first. Setting it
* to zero effectively disables the batching. Defaults to 16384.
*
*
* .google.protobuf.UInt32Value buffer_size_bytes = 4;
* @return Whether the bufferSizeBytes field is set.
*/
boolean hasBufferSizeBytes();
/**
*
* Soft size limit in bytes for access log entries buffer. Logger will buffer requests until
* this limit it hit, or every time flush interval is elapsed, whichever comes first. Setting it
* to zero effectively disables the batching. Defaults to 16384.
*
*
* .google.protobuf.UInt32Value buffer_size_bytes = 4;
* @return The bufferSizeBytes.
*/
com.google.protobuf.UInt32Value getBufferSizeBytes();
/**
*
* Soft size limit in bytes for access log entries buffer. Logger will buffer requests until
* this limit it hit, or every time flush interval is elapsed, whichever comes first. Setting it
* to zero effectively disables the batching. Defaults to 16384.
*
*
* .google.protobuf.UInt32Value buffer_size_bytes = 4;
*/
com.google.protobuf.UInt32ValueOrBuilder getBufferSizeBytesOrBuilder();
/**
*
* Additional filter state objects to log in :ref:`filter_state_objects
* <envoy_v3_api_field_data.accesslog.v3.AccessLogCommon.filter_state_objects>`.
* Logger will call ``FilterState::Object::serializeAsProto`` to serialize the filter state object.
*
*
* repeated string filter_state_objects_to_log = 5;
* @return A list containing the filterStateObjectsToLog.
*/
java.util.List
getFilterStateObjectsToLogList();
/**
*
* Additional filter state objects to log in :ref:`filter_state_objects
* <envoy_v3_api_field_data.accesslog.v3.AccessLogCommon.filter_state_objects>`.
* Logger will call ``FilterState::Object::serializeAsProto`` to serialize the filter state object.
*
*
* repeated string filter_state_objects_to_log = 5;
* @return The count of filterStateObjectsToLog.
*/
int getFilterStateObjectsToLogCount();
/**
*
* Additional filter state objects to log in :ref:`filter_state_objects
* <envoy_v3_api_field_data.accesslog.v3.AccessLogCommon.filter_state_objects>`.
* Logger will call ``FilterState::Object::serializeAsProto`` to serialize the filter state object.
*
*
* repeated string filter_state_objects_to_log = 5;
* @param index The index of the element to return.
* @return The filterStateObjectsToLog at the given index.
*/
java.lang.String getFilterStateObjectsToLog(int index);
/**
*
* Additional filter state objects to log in :ref:`filter_state_objects
* <envoy_v3_api_field_data.accesslog.v3.AccessLogCommon.filter_state_objects>`.
* Logger will call ``FilterState::Object::serializeAsProto`` to serialize the filter state object.
*
*
* repeated string filter_state_objects_to_log = 5;
* @param index The index of the value to return.
* @return The bytes of the filterStateObjectsToLog at the given index.
*/
com.google.protobuf.ByteString
getFilterStateObjectsToLogBytes(int index);
/**
*
* Sets the retry policy when the establishment of a gRPC stream fails.
* If the stream succeeds at least once in establishing itself,
* no retry will be performed no matter what gRPC status is received.
* Note that only :ref:`num_retries <envoy_v3_api_field_config.core.v3.RetryPolicy.num_retries>`
* will be used in this configuration. This feature is used only when you are using
* :ref:`Envoy gRPC client <envoy_v3_api_field_config.core.v3.GrpcService.envoy_grpc>`.
*
*
* .envoy.config.core.v3.RetryPolicy grpc_stream_retry_policy = 7;
* @return Whether the grpcStreamRetryPolicy field is set.
*/
boolean hasGrpcStreamRetryPolicy();
/**
*
* Sets the retry policy when the establishment of a gRPC stream fails.
* If the stream succeeds at least once in establishing itself,
* no retry will be performed no matter what gRPC status is received.
* Note that only :ref:`num_retries <envoy_v3_api_field_config.core.v3.RetryPolicy.num_retries>`
* will be used in this configuration. This feature is used only when you are using
* :ref:`Envoy gRPC client <envoy_v3_api_field_config.core.v3.GrpcService.envoy_grpc>`.
*
*
* .envoy.config.core.v3.RetryPolicy grpc_stream_retry_policy = 7;
* @return The grpcStreamRetryPolicy.
*/
io.envoyproxy.envoy.config.core.v3.RetryPolicy getGrpcStreamRetryPolicy();
/**
*
* Sets the retry policy when the establishment of a gRPC stream fails.
* If the stream succeeds at least once in establishing itself,
* no retry will be performed no matter what gRPC status is received.
* Note that only :ref:`num_retries <envoy_v3_api_field_config.core.v3.RetryPolicy.num_retries>`
* will be used in this configuration. This feature is used only when you are using
* :ref:`Envoy gRPC client <envoy_v3_api_field_config.core.v3.GrpcService.envoy_grpc>`.
*
*
* .envoy.config.core.v3.RetryPolicy grpc_stream_retry_policy = 7;
*/
io.envoyproxy.envoy.config.core.v3.RetryPolicyOrBuilder getGrpcStreamRetryPolicyOrBuilder();
/**
*
* A list of custom tags with unique tag name to create tags for the logs.
*
*
* repeated .envoy.type.tracing.v3.CustomTag custom_tags = 8;
*/
java.util.List
getCustomTagsList();
/**
*
* A list of custom tags with unique tag name to create tags for the logs.
*
*
* repeated .envoy.type.tracing.v3.CustomTag custom_tags = 8;
*/
io.envoyproxy.envoy.type.tracing.v3.CustomTag getCustomTags(int index);
/**
*
* A list of custom tags with unique tag name to create tags for the logs.
*
*
* repeated .envoy.type.tracing.v3.CustomTag custom_tags = 8;
*/
int getCustomTagsCount();
/**
*
* A list of custom tags with unique tag name to create tags for the logs.
*
*
* repeated .envoy.type.tracing.v3.CustomTag custom_tags = 8;
*/
java.util.List
getCustomTagsOrBuilderList();
/**
*
* A list of custom tags with unique tag name to create tags for the logs.
*
*
* repeated .envoy.type.tracing.v3.CustomTag custom_tags = 8;
*/
io.envoyproxy.envoy.type.tracing.v3.CustomTagOrBuilder getCustomTagsOrBuilder(
int index);
}
