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

Interface ProcessingResponseOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    ProcessingResponse.ConnectionStatus
    getConnectionStatus()
    Optional: Determines the connection behavior after processing.
    int
    getConnectionStatusValue()
    Optional: Determines the connection behavior after processing.
    ProcessingResponse.DataProcessedStatus
    getDataProcessingStatus()
    Indicates whether the data was modified or not.
    int
    getDataProcessingStatusValue()
    Indicates whether the data was modified or not.
    com.google.protobuf.Struct
    getDynamicMetadata()
    Optional metadata associated with the request.
    com.google.protobuf.StructOrBuilder
    getDynamicMetadataOrBuilder()
    Optional metadata associated with the request.
    Data
    getReadData()
    The processed ReadData containing potentially modified data for the request path.
    DataOrBuilder
    getReadDataOrBuilder()
    The processed ReadData containing potentially modified data for the request path.
    Data
    getWriteData()
    The processed WriteData containing potentially modified data for the response path.
    DataOrBuilder
    getWriteDataOrBuilder()
    The processed WriteData containing potentially modified data for the response path.
    boolean
    hasDynamicMetadata()
    Optional metadata associated with the request.
    boolean
    hasReadData()
    The processed ReadData containing potentially modified data for the request path.
    boolean
    hasWriteData()
    The processed WriteData containing potentially modified data for the response path.

    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

    • hasReadData

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

    • getReadData

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

    • getReadDataOrBuilder

      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;

    • hasWriteData

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

    • getWriteData

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

    • getWriteDataOrBuilder

      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;

    • getDataProcessingStatusValue

      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;
      Returns:
      The enum numeric value on the wire for dataProcessingStatus.

    • getDataProcessingStatus

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

    • getConnectionStatusValue

      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;
      Returns:
      The enum numeric value on the wire for connectionStatus.

    • getConnectionStatus

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

    • hasDynamicMetadata

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

    • getDynamicMetadata

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

    • getDynamicMetadataOrBuilder

      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;