Share via

ClientPipeline.Create Method

  • Reference

Definition

Namespace:
System.ClientModel.Primitives
Assembly:
System.ClientModel.dll
Package:
System.ClientModel v1.2.1
Package:
System.ClientModel v1.1.0-beta.7

Overloads

Create(ClientPipelineOptions)

Create an instance of a ClientPipeline from the provided ClientPipelineOptions.
Create(ClientPipelineOptions, ReadOnlySpan<PipelinePolicy>, ReadOnlySpan<PipelinePolicy>, ReadOnlySpan<PipelinePolicy>)

Create an instance of a ClientPipeline from the provided ClientPipelineOptions and PipelinePolicy collections.

Create(ClientPipelineOptions)

Source:
ClientPipeline.cs
Source:
ClientPipeline.cs

Create an instance of a ClientPipeline from the provided ClientPipelineOptions.

public static System.ClientModel.Primitives.ClientPipeline Create (System.ClientModel.Primitives.ClientPipelineOptions? options = default);
static member Create : System.ClientModel.Primitives.ClientPipelineOptions -> System.ClientModel.Primitives.ClientPipeline
Public Shared Function Create (Optional options As ClientPipelineOptions = Nothing) As ClientPipeline

Parameters

options
ClientPipelineOptions

If provided, the ClientPipelineOptions to use to construct the ClientPipeline.

Returns

ClientPipeline

The created ClientPipeline instance.

Applies to

Create(ClientPipelineOptions, ReadOnlySpan<PipelinePolicy>, ReadOnlySpan<PipelinePolicy>, ReadOnlySpan<PipelinePolicy>)

Source:
ClientPipeline.cs
Source:
ClientPipeline.cs

Create an instance of a ClientPipeline from the provided ClientPipelineOptions and PipelinePolicy collections.

public static System.ClientModel.Primitives.ClientPipeline Create (System.ClientModel.Primitives.ClientPipelineOptions options, ReadOnlySpan<System.ClientModel.Primitives.PipelinePolicy> perCallPolicies, ReadOnlySpan<System.ClientModel.Primitives.PipelinePolicy> perTryPolicies, ReadOnlySpan<System.ClientModel.Primitives.PipelinePolicy> beforeTransportPolicies);
static member Create : System.ClientModel.Primitives.ClientPipelineOptions * ReadOnlySpan<System.ClientModel.Primitives.PipelinePolicy> * ReadOnlySpan<System.ClientModel.Primitives.PipelinePolicy> * ReadOnlySpan<System.ClientModel.Primitives.PipelinePolicy> -> System.ClientModel.Primitives.ClientPipeline
Public Shared Function Create (options As ClientPipelineOptions, perCallPolicies As ReadOnlySpan(Of PipelinePolicy), perTryPolicies As ReadOnlySpan(Of PipelinePolicy), beforeTransportPolicies As ReadOnlySpan(Of PipelinePolicy)) As ClientPipeline

Parameters

options
ClientPipelineOptions

The ClientPipelineOptions to use to construct the ClientPipeline.

perCallPolicies
ReadOnlySpan<PipelinePolicy>

A collection of PipelinePolicy instances to add to the default pipeline before the pipeline's retry policy.

perTryPolicies
ReadOnlySpan<PipelinePolicy>

A collection of PipelinePolicy instances to add to the default pipeline after the pipeline's retry policy.

beforeTransportPolicies
ReadOnlySpan<PipelinePolicy>

A collection of PipelinePolicy instances to add to the default pipeline before the pipeline's transport.

Returns

ClientPipeline

The created ClientPipeline instance.

Remarks

Policies provided in options are intended to come from the end-user of a client who has passed the ClientPipelineOptions instance to the client's constructor. The client constructor implementation is intended to pass client-specific policies using the perCallPolicies, perTryPolicies, and beforeTransportPolicies parameters and should not modify the ClientPipelineOptions provided by the client user.

Applies to