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

Class ExtProcOverrides

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.filters.http.ext_proc.v3.ExtProcOverrides
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ExtProcOverridesOrBuilder, Serializable
public final class ExtProcOverrides extends com.google.protobuf.GeneratedMessageV3 implements ExtProcOverridesOrBuilder
 Overrides that may be set on a per-route basis
 [#next-free-field: 10]
Protobuf type envoy.extensions.filters.http.ext_proc.v3.ExtProcOverrides
See Also:

  • Field Details

    • PROCESSING_MODE_FIELD_NUMBER

      public static final int PROCESSING_MODE_FIELD_NUMBER
      See Also:

    • ASYNC_MODE_FIELD_NUMBER

      public static final int ASYNC_MODE_FIELD_NUMBER
      See Also:

    • REQUEST_ATTRIBUTES_FIELD_NUMBER

      public static final int REQUEST_ATTRIBUTES_FIELD_NUMBER
      See Also:

    • RESPONSE_ATTRIBUTES_FIELD_NUMBER

      public static final int RESPONSE_ATTRIBUTES_FIELD_NUMBER
      See Also:

    • GRPC_SERVICE_FIELD_NUMBER

      public static final int GRPC_SERVICE_FIELD_NUMBER
      See Also:

    • METADATA_OPTIONS_FIELD_NUMBER

      public static final int METADATA_OPTIONS_FIELD_NUMBER
      See Also:

    • GRPC_INITIAL_METADATA_FIELD_NUMBER

      public static final int GRPC_INITIAL_METADATA_FIELD_NUMBER
      See Also:

    • FAILURE_MODE_ALLOW_FIELD_NUMBER

      public static final int FAILURE_MODE_ALLOW_FIELD_NUMBER
      See Also:

    • PROCESSING_REQUEST_MODIFIER_FIELD_NUMBER

      public static final int PROCESSING_REQUEST_MODIFIER_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

    • hasProcessingMode

      public boolean hasProcessingMode()
       Set a different processing mode for this route than the default.
      .envoy.extensions.filters.http.ext_proc.v3.ProcessingMode processing_mode = 1;
      Specified by:
      hasProcessingMode in interface ExtProcOverridesOrBuilder
      Returns:
      Whether the processingMode field is set.

    • getProcessingMode

      public ProcessingMode getProcessingMode()
       Set a different processing mode for this route than the default.
      .envoy.extensions.filters.http.ext_proc.v3.ProcessingMode processing_mode = 1;
      Specified by:
      getProcessingMode in interface ExtProcOverridesOrBuilder
      Returns:
      The processingMode.

    • getProcessingModeOrBuilder

      public ProcessingModeOrBuilder getProcessingModeOrBuilder()
       Set a different processing mode for this route than the default.
      .envoy.extensions.filters.http.ext_proc.v3.ProcessingMode processing_mode = 1;
      Specified by:
      getProcessingModeOrBuilder in interface ExtProcOverridesOrBuilder

    • getAsyncMode

      @Deprecated public boolean getAsyncMode()
      Deprecated.
      envoy.extensions.filters.http.ext_proc.v3.ExtProcOverrides.async_mode is deprecated. See envoy/extensions/filters/http/ext_proc/v3/ext_proc.proto;l=460
       [#not-implemented-hide:]
 Set a different asynchronous processing option than the default.
 Deprecated and not implemented.
      bool async_mode = 2 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Specified by:
      getAsyncMode in interface ExtProcOverridesOrBuilder
      Returns:
      The asyncMode.

    • getRequestAttributesList

      public com.google.protobuf.ProtocolStringList getRequestAttributesList()
       [#not-implemented-hide:]
 Set different optional attributes than the default setting of the
 ``request_attributes`` field.
      repeated string request_attributes = 3;
      Specified by:
      getRequestAttributesList in interface ExtProcOverridesOrBuilder
      Returns:
      A list containing the requestAttributes.

    • getRequestAttributesCount

      public int getRequestAttributesCount()
       [#not-implemented-hide:]
 Set different optional attributes than the default setting of the
 ``request_attributes`` field.
      repeated string request_attributes = 3;
      Specified by:
      getRequestAttributesCount in interface ExtProcOverridesOrBuilder
      Returns:
      The count of requestAttributes.

    • getRequestAttributes

      public String getRequestAttributes(int index)
       [#not-implemented-hide:]
 Set different optional attributes than the default setting of the
 ``request_attributes`` field.
      repeated string request_attributes = 3;
      Specified by:
      getRequestAttributes in interface ExtProcOverridesOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The requestAttributes at the given index.

    • getRequestAttributesBytes

      public com.google.protobuf.ByteString getRequestAttributesBytes(int index)
       [#not-implemented-hide:]
 Set different optional attributes than the default setting of the
 ``request_attributes`` field.
      repeated string request_attributes = 3;
      Specified by:
      getRequestAttributesBytes in interface ExtProcOverridesOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the requestAttributes at the given index.

    • getResponseAttributesList

      public com.google.protobuf.ProtocolStringList getResponseAttributesList()
       [#not-implemented-hide:]
 Set different optional properties than the default setting of the
 ``response_attributes`` field.
      repeated string response_attributes = 4;
      Specified by:
      getResponseAttributesList in interface ExtProcOverridesOrBuilder
      Returns:
      A list containing the responseAttributes.

    • getResponseAttributesCount

      public int getResponseAttributesCount()
       [#not-implemented-hide:]
 Set different optional properties than the default setting of the
 ``response_attributes`` field.
      repeated string response_attributes = 4;
      Specified by:
      getResponseAttributesCount in interface ExtProcOverridesOrBuilder
      Returns:
      The count of responseAttributes.

    • getResponseAttributes

      public String getResponseAttributes(int index)
       [#not-implemented-hide:]
 Set different optional properties than the default setting of the
 ``response_attributes`` field.
      repeated string response_attributes = 4;
      Specified by:
      getResponseAttributes in interface ExtProcOverridesOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The responseAttributes at the given index.

    • getResponseAttributesBytes

      public com.google.protobuf.ByteString getResponseAttributesBytes(int index)
       [#not-implemented-hide:]
 Set different optional properties than the default setting of the
 ``response_attributes`` field.
      repeated string response_attributes = 4;
      Specified by:
      getResponseAttributesBytes in interface ExtProcOverridesOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the responseAttributes at the given index.

    • hasGrpcService

      public boolean hasGrpcService()
       Set a different gRPC service for this route than the default.
      .envoy.config.core.v3.GrpcService grpc_service = 5;
      Specified by:
      hasGrpcService in interface ExtProcOverridesOrBuilder
      Returns:
      Whether the grpcService field is set.

    • getGrpcService

      public GrpcService getGrpcService()
       Set a different gRPC service for this route than the default.
      .envoy.config.core.v3.GrpcService grpc_service = 5;
      Specified by:
      getGrpcService in interface ExtProcOverridesOrBuilder
      Returns:
      The grpcService.

    • getGrpcServiceOrBuilder

      public GrpcServiceOrBuilder getGrpcServiceOrBuilder()
       Set a different gRPC service for this route than the default.
      .envoy.config.core.v3.GrpcService grpc_service = 5;
      Specified by:
      getGrpcServiceOrBuilder in interface ExtProcOverridesOrBuilder

    • hasMetadataOptions

      public boolean hasMetadataOptions()
       Options related to the sending and receiving of dynamic metadata.
 Lists of forwarding and receiving namespaces will be overridden in their entirety,
 meaning the most-specific config that specifies this override will be the final
 config used. It is the prerogative of the control plane to ensure this
 most-specific config contains the correct final overrides.
      .envoy.extensions.filters.http.ext_proc.v3.MetadataOptions metadata_options = 6;
      Specified by:
      hasMetadataOptions in interface ExtProcOverridesOrBuilder
      Returns:
      Whether the metadataOptions field is set.

    • getMetadataOptions

      public MetadataOptions getMetadataOptions()
       Options related to the sending and receiving of dynamic metadata.
 Lists of forwarding and receiving namespaces will be overridden in their entirety,
 meaning the most-specific config that specifies this override will be the final
 config used. It is the prerogative of the control plane to ensure this
 most-specific config contains the correct final overrides.
      .envoy.extensions.filters.http.ext_proc.v3.MetadataOptions metadata_options = 6;
      Specified by:
      getMetadataOptions in interface ExtProcOverridesOrBuilder
      Returns:
      The metadataOptions.

    • getMetadataOptionsOrBuilder

      public MetadataOptionsOrBuilder getMetadataOptionsOrBuilder()
       Options related to the sending and receiving of dynamic metadata.
 Lists of forwarding and receiving namespaces will be overridden in their entirety,
 meaning the most-specific config that specifies this override will be the final
 config used. It is the prerogative of the control plane to ensure this
 most-specific config contains the correct final overrides.
      .envoy.extensions.filters.http.ext_proc.v3.MetadataOptions metadata_options = 6;
      Specified by:
      getMetadataOptionsOrBuilder in interface ExtProcOverridesOrBuilder

    • getGrpcInitialMetadataList

      public List<HeaderValue> getGrpcInitialMetadataList()
       Additional metadata to include into streams initiated to the ``ext_proc`` gRPC
 service. This can be used for scenarios in which additional ad hoc
 authorization headers (e.g. ``x-foo-bar: baz-key``) are to be injected or
 when a route needs to partially override inherited metadata.
      repeated .envoy.config.core.v3.HeaderValue grpc_initial_metadata = 7;
      Specified by:
      getGrpcInitialMetadataList in interface ExtProcOverridesOrBuilder

    • getGrpcInitialMetadataOrBuilderList

      public List<? extends HeaderValueOrBuilder> getGrpcInitialMetadataOrBuilderList()
       Additional metadata to include into streams initiated to the ``ext_proc`` gRPC
 service. This can be used for scenarios in which additional ad hoc
 authorization headers (e.g. ``x-foo-bar: baz-key``) are to be injected or
 when a route needs to partially override inherited metadata.
      repeated .envoy.config.core.v3.HeaderValue grpc_initial_metadata = 7;
      Specified by:
      getGrpcInitialMetadataOrBuilderList in interface ExtProcOverridesOrBuilder

    • getGrpcInitialMetadataCount

      public int getGrpcInitialMetadataCount()
       Additional metadata to include into streams initiated to the ``ext_proc`` gRPC
 service. This can be used for scenarios in which additional ad hoc
 authorization headers (e.g. ``x-foo-bar: baz-key``) are to be injected or
 when a route needs to partially override inherited metadata.
      repeated .envoy.config.core.v3.HeaderValue grpc_initial_metadata = 7;
      Specified by:
      getGrpcInitialMetadataCount in interface ExtProcOverridesOrBuilder

    • getGrpcInitialMetadata

      public HeaderValue getGrpcInitialMetadata(int index)
       Additional metadata to include into streams initiated to the ``ext_proc`` gRPC
 service. This can be used for scenarios in which additional ad hoc
 authorization headers (e.g. ``x-foo-bar: baz-key``) are to be injected or
 when a route needs to partially override inherited metadata.
      repeated .envoy.config.core.v3.HeaderValue grpc_initial_metadata = 7;
      Specified by:
      getGrpcInitialMetadata in interface ExtProcOverridesOrBuilder

    • getGrpcInitialMetadataOrBuilder

      public HeaderValueOrBuilder getGrpcInitialMetadataOrBuilder(int index)
       Additional metadata to include into streams initiated to the ``ext_proc`` gRPC
 service. This can be used for scenarios in which additional ad hoc
 authorization headers (e.g. ``x-foo-bar: baz-key``) are to be injected or
 when a route needs to partially override inherited metadata.
      repeated .envoy.config.core.v3.HeaderValue grpc_initial_metadata = 7;
      Specified by:
      getGrpcInitialMetadataOrBuilder in interface ExtProcOverridesOrBuilder

    • hasFailureModeAllow

      public boolean hasFailureModeAllow()
       If true, the filter will not fail closed if the gRPC stream is prematurely closed
 or could not be opened. This field is the per-route override of
 :ref:`failure_mode_allow <envoy_v3_api_field_extensions.filters.http.ext_proc.v3.ExternalProcessor.failure_mode_allow>`.
      .google.protobuf.BoolValue failure_mode_allow = 8;
      Specified by:
      hasFailureModeAllow in interface ExtProcOverridesOrBuilder
      Returns:
      Whether the failureModeAllow field is set.

    • getFailureModeAllow

      public com.google.protobuf.BoolValue getFailureModeAllow()
       If true, the filter will not fail closed if the gRPC stream is prematurely closed
 or could not be opened. This field is the per-route override of
 :ref:`failure_mode_allow <envoy_v3_api_field_extensions.filters.http.ext_proc.v3.ExternalProcessor.failure_mode_allow>`.
      .google.protobuf.BoolValue failure_mode_allow = 8;
      Specified by:
      getFailureModeAllow in interface ExtProcOverridesOrBuilder
      Returns:
      The failureModeAllow.

    • getFailureModeAllowOrBuilder

      public com.google.protobuf.BoolValueOrBuilder getFailureModeAllowOrBuilder()
       If true, the filter will not fail closed if the gRPC stream is prematurely closed
 or could not be opened. This field is the per-route override of
 :ref:`failure_mode_allow <envoy_v3_api_field_extensions.filters.http.ext_proc.v3.ExternalProcessor.failure_mode_allow>`.
      .google.protobuf.BoolValue failure_mode_allow = 8;
      Specified by:
      getFailureModeAllowOrBuilder in interface ExtProcOverridesOrBuilder

    • hasProcessingRequestModifier

      public boolean hasProcessingRequestModifier()
       Decorator to introduce custom logic that runs after the ``ProcessingRequest`` is constructed, but
 before it is sent to the External Processor. The ``ProcessingRequest`` may be modified.
 This is a per-route override of
 :ref:`processing_request_modifier <envoy_v3_api_field_extensions.filters.http.ext_proc.v3.ExternalProcessor.processing_request_modifier>`.
      .envoy.config.core.v3.TypedExtensionConfig processing_request_modifier = 9 [(.xds.annotations.v3.field_status) = { ... }
      Specified by:
      hasProcessingRequestModifier in interface ExtProcOverridesOrBuilder
      Returns:
      Whether the processingRequestModifier field is set.

    • getProcessingRequestModifier

      public TypedExtensionConfig getProcessingRequestModifier()
       Decorator to introduce custom logic that runs after the ``ProcessingRequest`` is constructed, but
 before it is sent to the External Processor. The ``ProcessingRequest`` may be modified.
 This is a per-route override of
 :ref:`processing_request_modifier <envoy_v3_api_field_extensions.filters.http.ext_proc.v3.ExternalProcessor.processing_request_modifier>`.
      .envoy.config.core.v3.TypedExtensionConfig processing_request_modifier = 9 [(.xds.annotations.v3.field_status) = { ... }
      Specified by:
      getProcessingRequestModifier in interface ExtProcOverridesOrBuilder
      Returns:
      The processingRequestModifier.

    • getProcessingRequestModifierOrBuilder

      public TypedExtensionConfigOrBuilder getProcessingRequestModifierOrBuilder()
       Decorator to introduce custom logic that runs after the ``ProcessingRequest`` is constructed, but
 before it is sent to the External Processor. The ``ProcessingRequest`` may be modified.
 This is a per-route override of
 :ref:`processing_request_modifier <envoy_v3_api_field_extensions.filters.http.ext_proc.v3.ExternalProcessor.processing_request_modifier>`.
      .envoy.config.core.v3.TypedExtensionConfig processing_request_modifier = 9 [(.xds.annotations.v3.field_status) = { ... }
      Specified by:
      getProcessingRequestModifierOrBuilder in interface ExtProcOverridesOrBuilder

    • 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 ExtProcOverrides parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static ExtProcOverrides.Builder newBuilder()

    • newBuilder

      public static ExtProcOverrides.Builder newBuilder(ExtProcOverrides prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static ExtProcOverrides getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<ExtProcOverrides> 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 ExtProcOverrides getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder