Package io.envoyproxy.envoy.service.network_ext_proc.v3

Class ProcessingResponse

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.service.network_ext_proc.v3.ProcessingResponse
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ProcessingResponseOrBuilder, Serializable
public final class ProcessingResponse extends com.google.protobuf.GeneratedMessageV3 implements ProcessingResponseOrBuilder
 ProcessingResponse contains the response from the external processing server to Envoy.
 Each response corresponds to a ProcessingRequest and indicates how the network
 traffic should be handled.
 [#next-free-field: 6]
Protobuf type envoy.service.network_ext_proc.v3.ProcessingResponse
See Also:

  • Field Details

    • READ_DATA_FIELD_NUMBER

      public static final int READ_DATA_FIELD_NUMBER
      See Also:

    • WRITE_DATA_FIELD_NUMBER

      public static final int WRITE_DATA_FIELD_NUMBER
      See Also:

    • DATA_PROCESSING_STATUS_FIELD_NUMBER

      public static final int DATA_PROCESSING_STATUS_FIELD_NUMBER
      See Also:

    • CONNECTION_STATUS_FIELD_NUMBER

      public static final int CONNECTION_STATUS_FIELD_NUMBER
      See Also:

    • DYNAMIC_METADATA_FIELD_NUMBER

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

    • hasReadData

      public boolean hasReadData()
       The processed ReadData containing potentially modified data for the request path.
 This should be sent in response to a ProcessingRequest with read_data, and the
 previous data in ProcessingRequest will be replaced by the new data in Envoy's data plane.
 If this is set, write_data should not be set.
      .envoy.service.network_ext_proc.v3.Data read_data = 1;
      Specified by:
      hasReadData in interface ProcessingResponseOrBuilder
      Returns:
      Whether the readData field is set.

    • getReadData

      public Data getReadData()
       The processed ReadData containing potentially modified data for the request path.
 This should be sent in response to a ProcessingRequest with read_data, and the
 previous data in ProcessingRequest will be replaced by the new data in Envoy's data plane.
 If this is set, write_data should not be set.
      .envoy.service.network_ext_proc.v3.Data read_data = 1;
      Specified by:
      getReadData in interface ProcessingResponseOrBuilder
      Returns:
      The readData.

    • getReadDataOrBuilder

      public DataOrBuilder getReadDataOrBuilder()
       The processed ReadData containing potentially modified data for the request path.
 This should be sent in response to a ProcessingRequest with read_data, and the
 previous data in ProcessingRequest will be replaced by the new data in Envoy's data plane.
 If this is set, write_data should not be set.
      .envoy.service.network_ext_proc.v3.Data read_data = 1;
      Specified by:
      getReadDataOrBuilder in interface ProcessingResponseOrBuilder

    • hasWriteData

      public boolean hasWriteData()
       The processed WriteData containing potentially modified data for the response path.
 This should be sent in response to a ProcessingRequest with write_data, and the
 previous data in ProcessingRequest will be replaced by the new data in Envoy's data plane.
 If this is set, read_data should not be set.
      .envoy.service.network_ext_proc.v3.Data write_data = 2;
      Specified by:
      hasWriteData in interface ProcessingResponseOrBuilder
      Returns:
      Whether the writeData field is set.

    • getWriteData

      public Data getWriteData()
       The processed WriteData containing potentially modified data for the response path.
 This should be sent in response to a ProcessingRequest with write_data, and the
 previous data in ProcessingRequest will be replaced by the new data in Envoy's data plane.
 If this is set, read_data should not be set.
      .envoy.service.network_ext_proc.v3.Data write_data = 2;
      Specified by:
      getWriteData in interface ProcessingResponseOrBuilder
      Returns:
      The writeData.

    • getWriteDataOrBuilder

      public DataOrBuilder getWriteDataOrBuilder()
       The processed WriteData containing potentially modified data for the response path.
 This should be sent in response to a ProcessingRequest with write_data, and the
 previous data in ProcessingRequest will be replaced by the new data in Envoy's data plane.
 If this is set, read_data should not be set.
      .envoy.service.network_ext_proc.v3.Data write_data = 2;
      Specified by:
      getWriteDataOrBuilder in interface ProcessingResponseOrBuilder

    • getDataProcessingStatusValue

      public int getDataProcessingStatusValue()
       Indicates whether the data was modified or not.
 This is mandatory and tells Envoy whether to use the original or modified data.
      .envoy.service.network_ext_proc.v3.ProcessingResponse.DataProcessedStatus data_processing_status = 3;
      Specified by:
      getDataProcessingStatusValue in interface ProcessingResponseOrBuilder
      Returns:
      The enum numeric value on the wire for dataProcessingStatus.

    • getDataProcessingStatus

      public ProcessingResponse.DataProcessedStatus getDataProcessingStatus()
       Indicates whether the data was modified or not.
 This is mandatory and tells Envoy whether to use the original or modified data.
      .envoy.service.network_ext_proc.v3.ProcessingResponse.DataProcessedStatus data_processing_status = 3;
      Specified by:
      getDataProcessingStatus in interface ProcessingResponseOrBuilder
      Returns:
      The dataProcessingStatus.

    • getConnectionStatusValue

      public int getConnectionStatusValue()
       Optional: Determines the connection behavior after processing.
 If not specified, CONTINUE is assumed, and the connection proceeds normally.
 Use CLOSE or CLOSE_RST to terminate the connection based on processing results.
      .envoy.service.network_ext_proc.v3.ProcessingResponse.ConnectionStatus connection_status = 4;
      Specified by:
      getConnectionStatusValue in interface ProcessingResponseOrBuilder
      Returns:
      The enum numeric value on the wire for connectionStatus.

    • getConnectionStatus

      public ProcessingResponse.ConnectionStatus getConnectionStatus()
       Optional: Determines the connection behavior after processing.
 If not specified, CONTINUE is assumed, and the connection proceeds normally.
 Use CLOSE or CLOSE_RST to terminate the connection based on processing results.
      .envoy.service.network_ext_proc.v3.ProcessingResponse.ConnectionStatus connection_status = 4;
      Specified by:
      getConnectionStatus in interface ProcessingResponseOrBuilder
      Returns:
      The connectionStatus.

    • hasDynamicMetadata

      public boolean hasDynamicMetadata()
       Optional metadata associated with the request.
 This can include connection properties, filter configuration, and any other
 contextual information that might be useful for processing decisions.

 The metadata is not automatically propagated from request to response.
 The external processor must include any needed metadata in its response.
      .google.protobuf.Struct dynamic_metadata = 5;
      Specified by:
      hasDynamicMetadata in interface ProcessingResponseOrBuilder
      Returns:
      Whether the dynamicMetadata field is set.

    • getDynamicMetadata

      public com.google.protobuf.Struct getDynamicMetadata()
       Optional metadata associated with the request.
 This can include connection properties, filter configuration, and any other
 contextual information that might be useful for processing decisions.

 The metadata is not automatically propagated from request to response.
 The external processor must include any needed metadata in its response.
      .google.protobuf.Struct dynamic_metadata = 5;
      Specified by:
      getDynamicMetadata in interface ProcessingResponseOrBuilder
      Returns:
      The dynamicMetadata.

    • getDynamicMetadataOrBuilder

      public com.google.protobuf.StructOrBuilder getDynamicMetadataOrBuilder()
       Optional metadata associated with the request.
 This can include connection properties, filter configuration, and any other
 contextual information that might be useful for processing decisions.

 The metadata is not automatically propagated from request to response.
 The external processor must include any needed metadata in its response.
      .google.protobuf.Struct dynamic_metadata = 5;
      Specified by:
      getDynamicMetadataOrBuilder in interface ProcessingResponseOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static ProcessingResponse.Builder newBuilder()

    • newBuilder

      public static ProcessingResponse.Builder newBuilder(ProcessingResponse prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static ProcessingResponse getDefaultInstance()

    • parser

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

    • getParserForType

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