All Superinterfaces:: com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:: FluentdAccessLogConfig, FluentdAccessLogConfig.Builder

public interface FluentdAccessLogConfigOrBuilder extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type

Method

Description

com.google.protobuf.Duration

getBufferFlushInterval()

Interval for flushing access logs to the TCP stream.

com.google.protobuf.DurationOrBuilder

getBufferFlushIntervalOrBuilder()

Interval for flushing access logs to the TCP stream.

com.google.protobuf.UInt32Value

getBufferSizeBytes()

Soft size limit in bytes for access log entries buffer.

com.google.protobuf.UInt32ValueOrBuilder

getBufferSizeBytesOrBuilder()

Soft size limit in bytes for access log entries buffer.

String

getCluster()

The upstream cluster to connect to for streaming the Fluentd messages.

com.google.protobuf.ByteString

getClusterBytes()

The upstream cluster to connect to for streaming the Fluentd messages.

TypedExtensionConfig

getFormatters(int index)

Specifies a collection of Formatter plugins that can be called from the access log configuration.

int

getFormattersCount()

Specifies a collection of Formatter plugins that can be called from the access log configuration.

List<TypedExtensionConfig>

getFormattersList()

Specifies a collection of Formatter plugins that can be called from the access log configuration.

TypedExtensionConfigOrBuilder

getFormattersOrBuilder(int index)

Specifies a collection of Formatter plugins that can be called from the access log configuration.

List<? extends TypedExtensionConfigOrBuilder>

getFormattersOrBuilderList()

Specifies a collection of Formatter plugins that can be called from the access log configuration.

com.google.protobuf.Struct

getRecord()

A struct that represents the record that is sent for each log entry.

com.google.protobuf.StructOrBuilder

getRecordOrBuilder()

A struct that represents the record that is sent for each log entry.

FluentdAccessLogConfig.RetryOptions

getRetryOptions()

Optional retry, in case upstream connection has failed.

FluentdAccessLogConfig.RetryOptionsOrBuilder

getRetryOptionsOrBuilder()

Optional retry, in case upstream connection has failed.

String

getStatPrefix()

The prefix to use when emitting :ref:`statistics <config_access_log_stats>`.

com.google.protobuf.ByteString

getStatPrefixBytes()

The prefix to use when emitting :ref:`statistics <config_access_log_stats>`.

String

getTag()

A tag is a string separated with '.'

com.google.protobuf.ByteString

getTagBytes()

A tag is a string separated with '.'

boolean

hasBufferFlushInterval()

Interval for flushing access logs to the TCP stream.

boolean

hasBufferSizeBytes()

Soft size limit in bytes for access log entries buffer.

boolean

hasRecord()

A struct that represents the record that is sent for each log entry.

boolean

hasRetryOptions()

Optional retry, in case upstream connection has failed.

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

getCluster

String getCluster()
```
 The upstream cluster to connect to for streaming the Fluentd messages.
 
```
string cluster = 1 [(.validate.rules) = { ... }
Returns:

The cluster.
getClusterBytes

com.google.protobuf.ByteString getClusterBytes()
```
 The upstream cluster to connect to for streaming the Fluentd messages.
 
```
string cluster = 1 [(.validate.rules) = { ... }
Returns:

The bytes for cluster.

getTag

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) = { ... }

Returns:: The tag.

getTagBytes

com.google.protobuf.ByteString getTagBytes()

 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) = { ... }

Returns:: The bytes for tag.

getStatPrefix

String getStatPrefix()
```
 The prefix to use when emitting :ref:`statistics <config_access_log_stats>`.
 
```
string stat_prefix = 3 [(.validate.rules) = { ... }
Returns:

The statPrefix.
getStatPrefixBytes

com.google.protobuf.ByteString getStatPrefixBytes()
```
 The prefix to use when emitting :ref:`statistics <config_access_log_stats>`.
 
```
string stat_prefix = 3 [(.validate.rules) = { ... }
Returns:

The bytes for statPrefix.

hasBufferFlushInterval

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) = { ... }

Returns:: Whether the bufferFlushInterval field is set.

getBufferFlushInterval

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) = { ... }

Returns:: The bufferFlushInterval.

getBufferFlushIntervalOrBuilder

com.google.protobuf.DurationOrBuilder getBufferFlushIntervalOrBuilder()

 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) = { ... }

hasBufferSizeBytes

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;

Returns:: Whether the bufferSizeBytes field is set.

getBufferSizeBytes

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;

Returns:: The bufferSizeBytes.

getBufferSizeBytesOrBuilder

com.google.protobuf.UInt32ValueOrBuilder getBufferSizeBytesOrBuilder()

 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;

hasRecord

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) = { ... }

Returns:: Whether the record field is set.

getRecord

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) = { ... }

Returns:: The record.

getRecordOrBuilder

com.google.protobuf.StructOrBuilder getRecordOrBuilder()

 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) = { ... }

hasRetryOptions

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;

Returns:: Whether the retryOptions field is set.

getRetryOptions

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;

Returns:: The retryOptions.

getRetryOptionsOrBuilder

FluentdAccessLogConfig.RetryOptionsOrBuilder getRetryOptionsOrBuilder()

 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;