io.envoyproxy.envoy.extensions.access_loggers.fluentd.v3.FluentdAccessLogConfigOrBuilder Maven / Gradle / Ivy
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: envoy/extensions/access_loggers/fluentd/v3/fluentd.proto
// Protobuf Java Version: 3.25.1
package io.envoyproxy.envoy.extensions.access_loggers.fluentd.v3;
public interface FluentdAccessLogConfigOrBuilder extends
// @@protoc_insertion_point(interface_extends:envoy.extensions.access_loggers.fluentd.v3.FluentdAccessLogConfig)
com.google.protobuf.MessageOrBuilder {
/**
*
* The upstream cluster to connect to for streaming the Fluentd messages.
*
*
* string cluster = 1 [(.validate.rules) = { ... }
* @return The cluster.
*/
java.lang.String getCluster();
/**
*
* The upstream cluster to connect to for streaming the Fluentd messages.
*
*
* string cluster = 1 [(.validate.rules) = { ... }
* @return The bytes for cluster.
*/
com.google.protobuf.ByteString
getClusterBytes();
/**
*
* A tag is a string separated with '.' (e.g. log.type) to categorize events.
* See: https://github.com/fluent/fluentd/wiki/Forward-Protocol-Specification-v1#message-modes
*
*
* string tag = 2 [(.validate.rules) = { ... }
* @return The tag.
*/
java.lang.String getTag();
/**
*
* A tag is a string separated with '.' (e.g. log.type) to categorize events.
* See: https://github.com/fluent/fluentd/wiki/Forward-Protocol-Specification-v1#message-modes
*
*
* string tag = 2 [(.validate.rules) = { ... }
* @return The bytes for tag.
*/
com.google.protobuf.ByteString
getTagBytes();
/**
*
* The prefix to use when emitting :ref:`statistics <config_access_log_stats>`.
*
*
* string stat_prefix = 3 [(.validate.rules) = { ... }
* @return The statPrefix.
*/
java.lang.String getStatPrefix();
/**
*
* The prefix to use when emitting :ref:`statistics <config_access_log_stats>`.
*
*
* string stat_prefix = 3 [(.validate.rules) = { ... }
* @return The bytes for statPrefix.
*/
com.google.protobuf.ByteString
getStatPrefixBytes();
/**
*
* Interval for flushing access logs to the TCP 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 = 4 [(.validate.rules) = { ... }
* @return Whether the bufferFlushInterval field is set.
*/
boolean hasBufferFlushInterval();
/**
*
* Interval for flushing access logs to the TCP 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 = 4 [(.validate.rules) = { ... }
* @return The bufferFlushInterval.
*/
com.google.protobuf.Duration getBufferFlushInterval();
/**
*
* Interval for flushing access logs to the TCP 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 = 4 [(.validate.rules) = { ... }
*/
com.google.protobuf.DurationOrBuilder getBufferFlushIntervalOrBuilder();
/**
*
* Soft size limit in bytes for access log entries buffer. The logger will buffer requests until
* this limit it hit, or every time flush interval is elapsed, whichever comes first. When the buffer
* limit is hit, the logger will immediately flush the buffer contents. Setting it to zero effectively
* disables the batching. Defaults to 16384.
*
*
* .google.protobuf.UInt32Value buffer_size_bytes = 5;
* @return Whether the bufferSizeBytes field is set.
*/
boolean hasBufferSizeBytes();
/**
*
* Soft size limit in bytes for access log entries buffer. The logger will buffer requests until
* this limit it hit, or every time flush interval is elapsed, whichever comes first. When the buffer
* limit is hit, the logger will immediately flush the buffer contents. Setting it to zero effectively
* disables the batching. Defaults to 16384.
*
*
* .google.protobuf.UInt32Value buffer_size_bytes = 5;
* @return The bufferSizeBytes.
*/
com.google.protobuf.UInt32Value getBufferSizeBytes();
/**
*
* Soft size limit in bytes for access log entries buffer. The logger will buffer requests until
* this limit it hit, or every time flush interval is elapsed, whichever comes first. When the buffer
* limit is hit, the logger will immediately flush the buffer contents. Setting it to zero effectively
* disables the batching. Defaults to 16384.
*
*
* .google.protobuf.UInt32Value buffer_size_bytes = 5;
*/
com.google.protobuf.UInt32ValueOrBuilder getBufferSizeBytesOrBuilder();
/**
*
* A struct that represents the record that is sent for each log entry.
* https://github.com/fluent/fluentd/wiki/Forward-Protocol-Specification-v1#entry
* Values are rendered as strings, numbers, or boolean values as appropriate.
* Nested JSON objects may be produced by some command operators (e.g. FILTER_STATE or DYNAMIC_METADATA).
* See :ref:`format string<config_access_log_format_strings>` documentation for a specific command operator details.
*
* .. validated-code-block:: yaml
* :type-name: envoy.extensions.access_loggers.fluentd.v3.FluentdAccessLogConfig
*
* record:
* status: "%RESPONSE_CODE%"
* message: "%LOCAL_REPLY_BODY%"
*
* The following msgpack record would be created:
*
* .. code-block:: json
*
* {
* "status": 500,
* "message": "My error message"
* }
*
*
* .google.protobuf.Struct record = 6 [(.validate.rules) = { ... }
* @return Whether the record field is set.
*/
boolean hasRecord();
/**
*
* A struct that represents the record that is sent for each log entry.
* https://github.com/fluent/fluentd/wiki/Forward-Protocol-Specification-v1#entry
* Values are rendered as strings, numbers, or boolean values as appropriate.
* Nested JSON objects may be produced by some command operators (e.g. FILTER_STATE or DYNAMIC_METADATA).
* See :ref:`format string<config_access_log_format_strings>` documentation for a specific command operator details.
*
* .. validated-code-block:: yaml
* :type-name: envoy.extensions.access_loggers.fluentd.v3.FluentdAccessLogConfig
*
* record:
* status: "%RESPONSE_CODE%"
* message: "%LOCAL_REPLY_BODY%"
*
* The following msgpack record would be created:
*
* .. code-block:: json
*
* {
* "status": 500,
* "message": "My error message"
* }
*
*
* .google.protobuf.Struct record = 6 [(.validate.rules) = { ... }
* @return The record.
*/
com.google.protobuf.Struct getRecord();
/**
*
* A struct that represents the record that is sent for each log entry.
* https://github.com/fluent/fluentd/wiki/Forward-Protocol-Specification-v1#entry
* Values are rendered as strings, numbers, or boolean values as appropriate.
* Nested JSON objects may be produced by some command operators (e.g. FILTER_STATE or DYNAMIC_METADATA).
* See :ref:`format string<config_access_log_format_strings>` documentation for a specific command operator details.
*
* .. validated-code-block:: yaml
* :type-name: envoy.extensions.access_loggers.fluentd.v3.FluentdAccessLogConfig
*
* record:
* status: "%RESPONSE_CODE%"
* message: "%LOCAL_REPLY_BODY%"
*
* The following msgpack record would be created:
*
* .. code-block:: json
*
* {
* "status": 500,
* "message": "My error message"
* }
*
*
* .google.protobuf.Struct record = 6 [(.validate.rules) = { ... }
*/
com.google.protobuf.StructOrBuilder getRecordOrBuilder();
/**
*
* Optional retry, in case upstream connection has failed. If this field is not set, the default values will be applied,
* as specified in the :ref:`RetryOptions <envoy_v3_api_msg_extensions.access_loggers.fluentd.v3.FluentdAccessLogConfig.RetryOptions>`
* configuration.
*
*
* .envoy.extensions.access_loggers.fluentd.v3.FluentdAccessLogConfig.RetryOptions retry_options = 7;
* @return Whether the retryOptions field is set.
*/
boolean hasRetryOptions();
/**
*
* Optional retry, in case upstream connection has failed. If this field is not set, the default values will be applied,
* as specified in the :ref:`RetryOptions <envoy_v3_api_msg_extensions.access_loggers.fluentd.v3.FluentdAccessLogConfig.RetryOptions>`
* configuration.
*
*
* .envoy.extensions.access_loggers.fluentd.v3.FluentdAccessLogConfig.RetryOptions retry_options = 7;
* @return The retryOptions.
*/
io.envoyproxy.envoy.extensions.access_loggers.fluentd.v3.FluentdAccessLogConfig.RetryOptions getRetryOptions();
/**
*
* Optional retry, in case upstream connection has failed. If this field is not set, the default values will be applied,
* as specified in the :ref:`RetryOptions <envoy_v3_api_msg_extensions.access_loggers.fluentd.v3.FluentdAccessLogConfig.RetryOptions>`
* configuration.
*
*
* .envoy.extensions.access_loggers.fluentd.v3.FluentdAccessLogConfig.RetryOptions retry_options = 7;
*/
io.envoyproxy.envoy.extensions.access_loggers.fluentd.v3.FluentdAccessLogConfig.RetryOptionsOrBuilder getRetryOptionsOrBuilder();
/**
*
* Specifies a collection of Formatter plugins that can be called from the access log configuration.
* See the formatters extensions documentation for details.
* [#extension-category: envoy.formatter]
*
*
* repeated .envoy.config.core.v3.TypedExtensionConfig formatters = 8;
*/
java.util.List
getFormattersList();
/**
*
* Specifies a collection of Formatter plugins that can be called from the access log configuration.
* See the formatters extensions documentation for details.
* [#extension-category: envoy.formatter]
*
*
* repeated .envoy.config.core.v3.TypedExtensionConfig formatters = 8;
*/
io.envoyproxy.envoy.config.core.v3.TypedExtensionConfig getFormatters(int index);
/**
*
* Specifies a collection of Formatter plugins that can be called from the access log configuration.
* See the formatters extensions documentation for details.
* [#extension-category: envoy.formatter]
*
*
* repeated .envoy.config.core.v3.TypedExtensionConfig formatters = 8;
*/
int getFormattersCount();
/**
*
* Specifies a collection of Formatter plugins that can be called from the access log configuration.
* See the formatters extensions documentation for details.
* [#extension-category: envoy.formatter]
*
*
* repeated .envoy.config.core.v3.TypedExtensionConfig formatters = 8;
*/
java.util.List
getFormattersOrBuilderList();
/**
*
* Specifies a collection of Formatter plugins that can be called from the access log configuration.
* See the formatters extensions documentation for details.
* [#extension-category: envoy.formatter]
*
*
* repeated .envoy.config.core.v3.TypedExtensionConfig formatters = 8;
*/
io.envoyproxy.envoy.config.core.v3.TypedExtensionConfigOrBuilder getFormattersOrBuilder(
int index);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy