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

Class CommonGrpcAccessLogConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.access_loggers.grpc.v3.CommonGrpcAccessLogConfig
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, CommonGrpcAccessLogConfigOrBuilder, Serializable
public final class CommonGrpcAccessLogConfig extends com.google.protobuf.GeneratedMessageV3 implements CommonGrpcAccessLogConfigOrBuilder
 Common configuration for gRPC access logs.
 [#next-free-field: 9]
Protobuf type envoy.extensions.access_loggers.grpc.v3.CommonGrpcAccessLogConfig
See Also:

  • Field Details

    • LOG_NAME_FIELD_NUMBER

      public static final int LOG_NAME_FIELD_NUMBER
      See Also:

    • GRPC_SERVICE_FIELD_NUMBER

      public static final int GRPC_SERVICE_FIELD_NUMBER
      See Also:

    • TRANSPORT_API_VERSION_FIELD_NUMBER

      public static final int TRANSPORT_API_VERSION_FIELD_NUMBER
      See Also:

    • BUFFER_FLUSH_INTERVAL_FIELD_NUMBER

      public static final int BUFFER_FLUSH_INTERVAL_FIELD_NUMBER
      See Also:

    • BUFFER_SIZE_BYTES_FIELD_NUMBER

      public static final int BUFFER_SIZE_BYTES_FIELD_NUMBER
      See Also:

    • FILTER_STATE_OBJECTS_TO_LOG_FIELD_NUMBER

      public static final int FILTER_STATE_OBJECTS_TO_LOG_FIELD_NUMBER
      See Also:

    • GRPC_STREAM_RETRY_POLICY_FIELD_NUMBER

      public static final int GRPC_STREAM_RETRY_POLICY_FIELD_NUMBER
      See Also:

    • CUSTOM_TAGS_FIELD_NUMBER

      public static final int CUSTOM_TAGS_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getLogName

      public 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) = { ... }
      Specified by:
      getLogName in interface CommonGrpcAccessLogConfigOrBuilder
      Returns:
      The logName.

    • getLogNameBytes

      public 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) = { ... }
      Specified by:
      getLogNameBytes in interface CommonGrpcAccessLogConfigOrBuilder
      Returns:
      The bytes for logName.

    • hasGrpcService

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

    • getGrpcService

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

    • getGrpcServiceOrBuilder

      public GrpcServiceOrBuilder getGrpcServiceOrBuilder()
       The gRPC service for the access log service.
      .envoy.config.core.v3.GrpcService grpc_service = 2 [(.validate.rules) = { ... }
      Specified by:
      getGrpcServiceOrBuilder in interface CommonGrpcAccessLogConfigOrBuilder

    • getTransportApiVersionValue

      public 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) = { ... }
      Specified by:
      getTransportApiVersionValue in interface CommonGrpcAccessLogConfigOrBuilder
      Returns:
      The enum numeric value on the wire for transportApiVersion.

    • getTransportApiVersion

      public 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) = { ... }
      Specified by:
      getTransportApiVersion in interface CommonGrpcAccessLogConfigOrBuilder
      Returns:
      The transportApiVersion.

    • hasBufferFlushInterval

      public 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) = { ... }
      Specified by:
      hasBufferFlushInterval in interface CommonGrpcAccessLogConfigOrBuilder
      Returns:
      Whether the bufferFlushInterval field is set.

    • getBufferFlushInterval

      public 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) = { ... }
      Specified by:
      getBufferFlushInterval in interface CommonGrpcAccessLogConfigOrBuilder
      Returns:
      The bufferFlushInterval.

    • getBufferFlushIntervalOrBuilder

      public 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) = { ... }
      Specified by:
      getBufferFlushIntervalOrBuilder in interface CommonGrpcAccessLogConfigOrBuilder

    • hasBufferSizeBytes

      public 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;
      Specified by:
      hasBufferSizeBytes in interface CommonGrpcAccessLogConfigOrBuilder
      Returns:
      Whether the bufferSizeBytes field is set.

    • getBufferSizeBytes

      public 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;
      Specified by:
      getBufferSizeBytes in interface CommonGrpcAccessLogConfigOrBuilder
      Returns:
      The bufferSizeBytes.

    • getBufferSizeBytesOrBuilder

      public 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;
      Specified by:
      getBufferSizeBytesOrBuilder in interface CommonGrpcAccessLogConfigOrBuilder

    • getFilterStateObjectsToLogList

      public com.google.protobuf.ProtocolStringList 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;
      Specified by:
      getFilterStateObjectsToLogList in interface CommonGrpcAccessLogConfigOrBuilder
      Returns:
      A list containing the filterStateObjectsToLog.

    • getFilterStateObjectsToLogCount

      public 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;
      Specified by:
      getFilterStateObjectsToLogCount in interface CommonGrpcAccessLogConfigOrBuilder
      Returns:
      The count of filterStateObjectsToLog.

    • getFilterStateObjectsToLog

      public 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;
      Specified by:
      getFilterStateObjectsToLog in interface CommonGrpcAccessLogConfigOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The filterStateObjectsToLog at the given index.

    • getFilterStateObjectsToLogBytes

      public 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;
      Specified by:
      getFilterStateObjectsToLogBytes in interface CommonGrpcAccessLogConfigOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the filterStateObjectsToLog at the given index.

    • hasGrpcStreamRetryPolicy

      public 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;
      Specified by:
      hasGrpcStreamRetryPolicy in interface CommonGrpcAccessLogConfigOrBuilder
      Returns:
      Whether the grpcStreamRetryPolicy field is set.

    • getGrpcStreamRetryPolicy

      public 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;
      Specified by:
      getGrpcStreamRetryPolicy in interface CommonGrpcAccessLogConfigOrBuilder
      Returns:
      The grpcStreamRetryPolicy.

    • getGrpcStreamRetryPolicyOrBuilder

      public 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;
      Specified by:
      getGrpcStreamRetryPolicyOrBuilder in interface CommonGrpcAccessLogConfigOrBuilder

    • getCustomTagsList

      public 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;
      Specified by:
      getCustomTagsList in interface CommonGrpcAccessLogConfigOrBuilder

    • getCustomTagsOrBuilderList

      public 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;
      Specified by:
      getCustomTagsOrBuilderList in interface CommonGrpcAccessLogConfigOrBuilder

    • getCustomTagsCount

      public 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;
      Specified by:
      getCustomTagsCount in interface CommonGrpcAccessLogConfigOrBuilder

    • getCustomTags

      public 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;
      Specified by:
      getCustomTags in interface CommonGrpcAccessLogConfigOrBuilder

    • getCustomTagsOrBuilder

      public 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;
      Specified by:
      getCustomTagsOrBuilder in interface CommonGrpcAccessLogConfigOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static CommonGrpcAccessLogConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CommonGrpcAccessLogConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CommonGrpcAccessLogConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CommonGrpcAccessLogConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CommonGrpcAccessLogConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CommonGrpcAccessLogConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CommonGrpcAccessLogConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CommonGrpcAccessLogConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static CommonGrpcAccessLogConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static CommonGrpcAccessLogConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CommonGrpcAccessLogConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CommonGrpcAccessLogConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public CommonGrpcAccessLogConfig.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static CommonGrpcAccessLogConfig.Builder newBuilder()

    • newBuilder

      public static CommonGrpcAccessLogConfig.Builder newBuilder(CommonGrpcAccessLogConfig prototype)

    • toBuilder

      public CommonGrpcAccessLogConfig.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected CommonGrpcAccessLogConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static CommonGrpcAccessLogConfig getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<CommonGrpcAccessLogConfig> parser()

    • getParserForType

      public com.google.protobuf.Parser<CommonGrpcAccessLogConfig> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public CommonGrpcAccessLogConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder