PipelineStage

public protocol PipelineStage

Protocol for implementing pipeline stages.


                    
                    
                    on(request:completionHandler:)

Default implementation

Request modification hook.

Swift

func on(request: PipelineRequest, completionHandler: @escaping OnRequestCompletionHandler)

`request`	The `PipelineRequest` input.
`completionHandler`	A completion handler which forwards the modified request.


                    
                    
                    on(response:completionHandler:)

Default implementation

Response modification hook.

Swift

func on(response: PipelineResponse, completionHandler: @escaping OnResponseCompletionHandler)

`response`	The `PipelineResponse` input.
`completionHandler`	A completion handler which forwards the modified response.


                    
                    
                    on(error:pipelineResponse:completionHandler:)

Default implementation

Response error hook.

Swift

func on(
    error: AzureError,
    pipelineResponse: PipelineResponse,
    completionHandler: @escaping OnErrorCompletionHandler
)

`error`	The `PipelineError` input.
`pipelineResponse`	The `PipelineResponse` object.
`completionHandler`	A completion handler which forwards the error along with a boolean that indicates whether the exception was handled or not.


                    
                    
                    process(request:completionHandler:)

Default implementation

Executes the policy method.

Swift

func process(request pipelineRequest: PipelineRequest, completionHandler: @escaping PipelineStageResultHandler)

`pipelineRequest`	The `PipelineRequest` input.
`completionHandler`	A `PipelineStageResultHandler` completion handler.