Package io.envoyproxy.envoy.extensions.access_loggers.grpc.v3

Interface CommonGrpcAccessLogConfigOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    CommonGrpcAccessLogConfig, CommonGrpcAccessLogConfig.Builder
    public interface CommonGrpcAccessLogConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getLogName

        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) = { ... }
        Returns:
        The logName.

      • getLogNameBytes

        com.google.protobuf.ByteString getLogNameBytes()
         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) = { ... }
        Returns:
        The bytes for logName.

      • hasGrpcService

        boolean hasGrpcService()
         The gRPC service for the access log service.
        .envoy.config.core.v3.GrpcService grpc_service = 2 [(.validate.rules) = { ... }
        Returns:
        Whether the grpcService field is set.

      • getGrpcService

        GrpcService getGrpcService()
         The gRPC service for the access log service.
        .envoy.config.core.v3.GrpcService grpc_service = 2 [(.validate.rules) = { ... }
        Returns:
        The grpcService.

      • getGrpcServiceOrBuilder

        GrpcServiceOrBuilder getGrpcServiceOrBuilder()
         The gRPC service for the access log service.
        .envoy.config.core.v3.GrpcService grpc_service = 2 [(.validate.rules) = { ... }

      • getTransportApiVersionValue

        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) = { ... }
        Returns:
        The enum numeric value on the wire for transportApiVersion.

      • getTransportApiVersion

        ApiVersion getTransportApiVersion()
         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) = { ... }
        Returns:
        The transportApiVersion.

      • hasBufferFlushInterval

        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) = { ... }
        Returns:
        Whether the bufferFlushInterval field is set.

      • getBufferFlushInterval

        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) = { ... }
        Returns:
        The bufferFlushInterval.

      • getBufferFlushIntervalOrBuilder

        com.google.protobuf.DurationOrBuilder getBufferFlushIntervalOrBuilder()
         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) = { ... }

      • hasBufferSizeBytes

        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;
        Returns:
        Whether the bufferSizeBytes field is set.

      • getBufferSizeBytes

        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;
        Returns:
        The bufferSizeBytes.

      • getBufferSizeBytesOrBuilder

        com.google.protobuf.UInt32ValueOrBuilder getBufferSizeBytesOrBuilder()
         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;

      • getFilterStateObjectsToLogList

        List<String> 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;
        Returns:
        A list containing the filterStateObjectsToLog.

      • getFilterStateObjectsToLogCount

        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;
        Returns:
        The count of filterStateObjectsToLog.

      • getFilterStateObjectsToLog

        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;
        Parameters:
        index - The index of the element to return.
        Returns:
        The filterStateObjectsToLog at the given index.

      • getFilterStateObjectsToLogBytes

        com.google.protobuf.ByteString getFilterStateObjectsToLogBytes​(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;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the filterStateObjectsToLog at the given index.

      • hasGrpcStreamRetryPolicy

        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;
        Returns:
        Whether the grpcStreamRetryPolicy field is set.

      • getGrpcStreamRetryPolicy

        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;
        Returns:
        The grpcStreamRetryPolicy.

      • getGrpcStreamRetryPolicyOrBuilder

        RetryPolicyOrBuilder getGrpcStreamRetryPolicyOrBuilder()
         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;

      • getCustomTagsList

        List<CustomTag> 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;

      • getCustomTags

        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;

      • getCustomTagsCount

        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;

      • getCustomTagsOrBuilderList

        List<? extends CustomTagOrBuilder> 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;

      • getCustomTagsOrBuilder

        CustomTagOrBuilder getCustomTagsOrBuilder​(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;