Save Processing Response from external processor. (proto)

This extension has the qualified name envoy.http.ext_proc.response_processors.save_processing_response

Note

This extension is work-in-progress. Functionality is incomplete and it is not intended for production use.

This extension has an unknown security posture and should only be used in deployments where both the downstream and upstream are trusted.

Tip

This extension extends and can be used with the following extension category:

envoy.http.ext_proc.response_processors

Warning

This API feature is currently work-in-progress. API features marked as work-in-progress are not considered stable, are not covered by the threat model, are not supported by the security team, and are subject to breaking changes. Do not use this feature without understanding each of the previous points.

extensions.http.ext_proc.response_processors.save_processing_response.v3.SaveProcessingResponse

[extensions.http.ext_proc.response_processors.save_processing_response.v3.SaveProcessingResponse proto]

Extension to save the response from the external processor as filter state with name “envoy.http.ext_proc.response_processors.save_processing_response[.:ref:filter_state_name_suffix <envoy_v3_api_field_extensions.http.ext_proc.response_processors.save_processing_response.v3.SaveProcessingResponse.filter_state_name>]. This extension supports saving of request and response headers and trailers, and immediate response.

Note

Response processors are currently in alpha.

{
  "filter_state_name_suffix": ...,
  "save_request_headers": {...},
  "save_response_headers": {...},
  "save_request_trailers": {...},
  "save_response_trailers": {...},
  "save_immediate_response": {...}
}

filter_state_name_suffix: (string) The default filter state name is “envoy.http.ext_proc.response_processors.save_processing_response”. If defined, filter_state_name_suffix is appended to this. For example, setting filter_state_name_suffix to “xyz” will set the filter state name to “envoy.http.ext_proc.response_processors.save_processing_response.xyz”

save_request_headers: (extensions.http.ext_proc.response_processors.save_processing_response.v3.SaveProcessingResponse.SaveOptions) Save the response to filter state when request_headers is set.

save_response_headers: (extensions.http.ext_proc.response_processors.save_processing_response.v3.SaveProcessingResponse.SaveOptions) Save the response to filter state when response_headers is set.

save_request_trailers: (extensions.http.ext_proc.response_processors.save_processing_response.v3.SaveProcessingResponse.SaveOptions) Save the response to filter state when request_trailers is set.

save_response_trailers: (extensions.http.ext_proc.response_processors.save_processing_response.v3.SaveProcessingResponse.SaveOptions) Save the response to filter state when response_trailers is set.

save_immediate_response: (extensions.http.ext_proc.response_processors.save_processing_response.v3.SaveProcessingResponse.SaveOptions) Save the response to filter state when immediate_response is set.

extensions.http.ext_proc.response_processors.save_processing_response.v3.SaveProcessingResponse.SaveOptions

[extensions.http.ext_proc.response_processors.save_processing_response.v3.SaveProcessingResponse.SaveOptions proto]

{
  "save_response": ...,
  "save_on_error": ...
}

save_response: (bool) Whether or not to save the response for the response type.

save_on_error: (bool) When true, saves the response if there was an error when processing the response from the external processor.