Package io.envoyproxy.envoy.extensions.filters.network.ext_proc.v3

Interface NetworkExternalProcessorOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
NetworkExternalProcessor, NetworkExternalProcessor.Builder
public interface NetworkExternalProcessorOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getFailureModeAllow()
    By default, if the gRPC stream cannot be established, or if it is closed prematurely with an error, the filter will fail, leading to the close of connection.
    GrpcService
    getGrpcService()
    The gRPC service that will process network traffic.
    GrpcServiceOrBuilder
    getGrpcServiceOrBuilder()
    The gRPC service that will process network traffic.
    com.google.protobuf.Duration
    getMessageTimeout()
    Specifies the timeout for each individual message sent on the stream and when the filter is running in synchronous mode.
    com.google.protobuf.DurationOrBuilder
    getMessageTimeoutOrBuilder()
    Specifies the timeout for each individual message sent on the stream and when the filter is running in synchronous mode.
    MetadataOptions
    getMetadataOptions()
    Options related to the sending and receiving of dynamic metadata.
    MetadataOptionsOrBuilder
    getMetadataOptionsOrBuilder()
    Options related to the sending and receiving of dynamic metadata.
    ProcessingMode
    getProcessingMode()
    Options for controlling processing behavior.
    ProcessingModeOrBuilder
    getProcessingModeOrBuilder()
    Options for controlling processing behavior.
    String
    getStatPrefix()
    string stat_prefix = 5 [(.validate.rules) = { ... }
    com.google.protobuf.ByteString
    getStatPrefixBytes()
    string stat_prefix = 5 [(.validate.rules) = { ... }
    boolean
    hasGrpcService()
    The gRPC service that will process network traffic.
    boolean
    hasMessageTimeout()
    Specifies the timeout for each individual message sent on the stream and when the filter is running in synchronous mode.
    boolean
    hasMetadataOptions()
    Options related to the sending and receiving of dynamic metadata.
    boolean
    hasProcessingMode()
    Options for controlling processing behavior.

    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

    • hasGrpcService

      boolean hasGrpcService()
       The gRPC service that will process network traffic.
 This service must implement the NetworkExternalProcessor service
 defined in the proto file /envoy/service/network_ext_proc/v3/external_processor.proto.
      .envoy.config.core.v3.GrpcService grpc_service = 1;
      Returns:
      Whether the grpcService field is set.

    • getGrpcService

      GrpcService getGrpcService()
       The gRPC service that will process network traffic.
 This service must implement the NetworkExternalProcessor service
 defined in the proto file /envoy/service/network_ext_proc/v3/external_processor.proto.
      .envoy.config.core.v3.GrpcService grpc_service = 1;
      Returns:
      The grpcService.

    • getGrpcServiceOrBuilder

      GrpcServiceOrBuilder getGrpcServiceOrBuilder()
       The gRPC service that will process network traffic.
 This service must implement the NetworkExternalProcessor service
 defined in the proto file /envoy/service/network_ext_proc/v3/external_processor.proto.
      .envoy.config.core.v3.GrpcService grpc_service = 1;

    • getFailureModeAllow

      boolean getFailureModeAllow()
       By default, if the gRPC stream cannot be established, or if it is closed
 prematurely with an error, the filter will fail, leading to the close of connection.
 With this parameter set to true, however, then if the gRPC stream is prematurely closed
 or could not be opened, processing continues without error.
      bool failure_mode_allow = 2;
      Returns:
      The failureModeAllow.

    • hasProcessingMode

      boolean hasProcessingMode()
       Options for controlling processing behavior.
      .envoy.extensions.filters.network.ext_proc.v3.ProcessingMode processing_mode = 3;
      Returns:
      Whether the processingMode field is set.

    • getProcessingMode

      ProcessingMode getProcessingMode()
       Options for controlling processing behavior.
      .envoy.extensions.filters.network.ext_proc.v3.ProcessingMode processing_mode = 3;
      Returns:
      The processingMode.

    • getProcessingModeOrBuilder

      ProcessingModeOrBuilder getProcessingModeOrBuilder()
       Options for controlling processing behavior.
      .envoy.extensions.filters.network.ext_proc.v3.ProcessingMode processing_mode = 3;

    • hasMessageTimeout

      boolean hasMessageTimeout()
       Specifies the timeout for each individual message sent on the stream and
 when the filter is running in synchronous mode. Whenever
 the proxy sends a message on the stream that requires a response, it will
 reset this timer, and will stop processing and return an error (subject
 to the processing mode) if the timer expires. Default is 200 ms.
      .google.protobuf.Duration message_timeout = 4 [(.validate.rules) = { ... }
      Returns:
      Whether the messageTimeout field is set.

    • getMessageTimeout

      com.google.protobuf.Duration getMessageTimeout()
       Specifies the timeout for each individual message sent on the stream and
 when the filter is running in synchronous mode. Whenever
 the proxy sends a message on the stream that requires a response, it will
 reset this timer, and will stop processing and return an error (subject
 to the processing mode) if the timer expires. Default is 200 ms.
      .google.protobuf.Duration message_timeout = 4 [(.validate.rules) = { ... }
      Returns:
      The messageTimeout.

    • getMessageTimeoutOrBuilder

      com.google.protobuf.DurationOrBuilder getMessageTimeoutOrBuilder()
       Specifies the timeout for each individual message sent on the stream and
 when the filter is running in synchronous mode. Whenever
 the proxy sends a message on the stream that requires a response, it will
 reset this timer, and will stop processing and return an error (subject
 to the processing mode) if the timer expires. Default is 200 ms.
      .google.protobuf.Duration message_timeout = 4 [(.validate.rules) = { ... }

    • getStatPrefix

      String getStatPrefix()
      string stat_prefix = 5 [(.validate.rules) = { ... }
      Returns:
      The statPrefix.

    • getStatPrefixBytes

      com.google.protobuf.ByteString getStatPrefixBytes()
      string stat_prefix = 5 [(.validate.rules) = { ... }
      Returns:
      The bytes for statPrefix.

    • hasMetadataOptions

      boolean hasMetadataOptions()
       Options related to the sending and receiving of dynamic metadata.
      .envoy.extensions.filters.network.ext_proc.v3.MetadataOptions metadata_options = 6;
      Returns:
      Whether the metadataOptions field is set.

    • getMetadataOptions

      MetadataOptions getMetadataOptions()
       Options related to the sending and receiving of dynamic metadata.
      .envoy.extensions.filters.network.ext_proc.v3.MetadataOptions metadata_options = 6;
      Returns:
      The metadataOptions.

    • getMetadataOptionsOrBuilder

      MetadataOptionsOrBuilder getMetadataOptionsOrBuilder()
       Options related to the sending and receiving of dynamic metadata.
      .envoy.extensions.filters.network.ext_proc.v3.MetadataOptions metadata_options = 6;