Class CallSettings (4.8.0)

public sealed class CallSettings

Settings to determine how an RPC operates. This type is immutable.

Inheritance

object > CallSettings

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace

Google.Api.Gax.Grpc

Assembly

Google.Api.Gax.Grpc.dll

Constructors

CallSettings(CancellationToken?, Expiration, RetrySettings, Action<Metadata>, WriteOptions, ContextPropagationToken)

public CallSettings(CancellationToken? cancellationToken, Expiration expiration, RetrySettings retry, Action<Metadata> headerMutation, WriteOptions writeOptions, ContextPropagationToken propagationToken)

Constructs an instance with the specified settings.

Parameters
Name	Description
`cancellationToken`	`CancellationToken` Cancellation token that can be used for cancelling the call.
`expiration`	`Expiration` Expiration to use, or null for default expiration behavior.
`retry`	`RetrySettings` Retry to use, or null for default retry behavior.
`headerMutation`	`ActionMetadata` Action to modify the headers to send at the beginning of the call.
`writeOptions`	`WriteOptions` WriteOptions that will be used for the call.
`propagationToken`	`ContextPropagationToken` ContextPropagationToken for propagating settings from a parent call.

CallSettings(CancellationToken?, Expiration, RetrySettings, Action<Metadata>, WriteOptions, ContextPropagationToken, Action<Metadata>, Action<Metadata>)

public CallSettings(CancellationToken? cancellationToken, Expiration expiration, RetrySettings retry, Action<Metadata> headerMutation, WriteOptions writeOptions, ContextPropagationToken propagationToken, Action<Metadata> responseMetadataHandler, Action<Metadata> trailingMetadataHandler)

Constructs an instance with the specified settings.

Parameters
Name	Description
`cancellationToken`	`CancellationToken` Cancellation token that can be used for cancelling the call.
`expiration`	`Expiration` Expiration to use, or null for default expiration behavior.
`retry`	`RetrySettings` Retry to use, or null for default retry behavior.
`headerMutation`	`ActionMetadata` Action to modify the headers to send at the beginning of the call.
`writeOptions`	`WriteOptions` WriteOptions that will be used for the call.
`propagationToken`	`ContextPropagationToken` ContextPropagationToken for propagating settings from a parent call.
`responseMetadataHandler`	`ActionMetadata` Action to invoke when response metadata is received.
`trailingMetadataHandler`	`ActionMetadata` Action to invoke when trailing metadata is received.

Properties

CancellationToken

public CancellationToken? CancellationToken { get; }

Cancellation token that can be used for cancelling the call.

Property Value
Type	Description
`CancellationToken`

Expiration

public Expiration Expiration { get; }

The expiration for the call (either a timeout or a deadline), or null for the default expiration.

Property Value
Type	Description
`Expiration`

HeaderMutation

public Action<Metadata> HeaderMutation { get; }

Delegate to mutate the metadata which will be sent at the start of the call, typically to add custom headers.

Property Value
Type	Description
`ActionMetadata`

PropagationToken

public ContextPropagationToken PropagationToken { get; }

ContextPropagationToken for propagating settings from a parent call.

Property Value
Type	Description
`ContextPropagationToken`

ResponseMetadataHandler

public Action<Metadata> ResponseMetadataHandler { get; }

Delegate to receive the metadata associated with a response.

Property Value
Type	Description
`ActionMetadata`

Retry

public RetrySettings Retry { get; }

RetrySettings to use, or null for default retry behavior.

Property Value
Type	Description
`RetrySettings`

TrailingMetadataHandler

public Action<Metadata> TrailingMetadataHandler { get; }

Delegate to receive the metadata sent after the response.

Property Value
Type	Description
`ActionMetadata`

WriteOptions

public WriteOptions WriteOptions { get; }

WriteOptions that will be used for the call.

Property Value
Type	Description
`WriteOptions`

Methods

FromCancellationToken(CancellationToken)

public static CallSettings FromCancellationToken(CancellationToken cancellationToken)

Creates a CallSettings for the specified cancellation token.

Parameter
Name	Description
`cancellationToken`	`CancellationToken` The cancellation token for the new settings.

Returns
Type	Description
`CallSettings`	A new instance.

FromExpiration(Expiration)

public static CallSettings FromExpiration(Expiration expiration)

Creates a CallSettings for the specified call expiration, or returns null if expiration is null.

Parameter
Name	Description
`expiration`	`Expiration` The call timing for the new settings.

Returns
Type	Description
`CallSettings`	A new instance or null if `expiration` is null..

FromFieldMask(string)

public static CallSettings FromFieldMask(string fieldMask)

Creates a CallSettings that will include a field mask in the request, to limit which fields are returned in the response.

Parameter
Name	Description
`fieldMask`	`string` The field mask for the request. Must not be null.

Returns
Type	Description
`CallSettings`	A new instance.

Remarks

The precise effect on the request is not guaranteed: it may be through a header or a side-channel, for example. Likewise the effect of combining multiple settings containing field masks is not specified.

FromGoogleRequestParamsHeader(string)

public static CallSettings FromGoogleRequestParamsHeader(string escapedHeaderValue)

Creates a CallSettings which applies an x-goog-request-params header with the specified escaped header value.

Parameter
Name	Description
`escapedHeaderValue`	`string` The value of the x-goog-request-params header. Must be escaped. Must not be null or empty.

Returns
Type	Description
`CallSettings`	A CallSettings which applies the appropriate header.

Remarks

This method is intended to be called from API-specific client libraries; it would be very unusual for it to be appropriate to call from application code.

FromGoogleRequestParamsHeader(string, string)

public static CallSettings FromGoogleRequestParamsHeader(string parameterName, string value)

Creates a CallSettings which applies an x-goog-request-params header with the specified parameter name and value.

Parameters
Name	Description
`parameterName`	`string` The name of the parameter. Must not be null.
`value`	`string` The value of the parameter, which may be null. A null value is equivalent to providing an empty string.

Returns
Type	Description
`CallSettings`	A CallSettings which applies the appropriate header with a single parameter.

Remarks

The value is URL-encoded; it is expected that parameterName is already URL-encoded.

This method is intended to be called from API-specific client libraries; it would be very unusual for it to be appropriate to call from application code.

FromHeader(string, string)

public static CallSettings FromHeader(string name, string value)

Creates a CallSettings for the specified header name and value.

Parameters
Name	Description
`name`	`string` The name of the header to add. Must not be null.
`value`	`string` The value of the header to add. Must not be null.

Returns
Type	Description
`CallSettings`	A new instance.

FromHeaderMutation(Action<Metadata>)

public static CallSettings FromHeaderMutation(Action<Metadata> headerMutation)

Creates a CallSettings for the specified header mutation, or returns null if headerMutation is null.

Parameter
Name	Description
`headerMutation`	`ActionMetadata` Action to modify the headers to send at the beginning of the call.

Returns
Type	Description
`CallSettings`	A new instance, or null if `headerMutation` is null..

FromResponseMetadataHandler(Action<Metadata>)

public static CallSettings FromResponseMetadataHandler(Action<Metadata> responseMetadataHandler)

Creates a CallSettings for the specified response metadata handler, or returns null if responseMetadataHandler is null.

Parameter
Name	Description
`responseMetadataHandler`	`ActionMetadata` Action to receive response metadata when the call completes.

Returns
Type	Description
`CallSettings`	A new instance, or null if `responseMetadataHandler` is null..

FromRetry(RetrySettings)

public static CallSettings FromRetry(RetrySettings retry)

Creates a CallSettings for the specified retry settings, or returns null if retry is null.

Parameter
Name	Description
`retry`	`RetrySettings` The call timing for the new settings.

Returns
Type	Description
`CallSettings`	A new instance or null if `retry` is null..

FromTrailingMetadataHandler(Action<Metadata>)

public static CallSettings FromTrailingMetadataHandler(Action<Metadata> trailingMetadataHandler)

Creates a CallSettings for the specified trailing metadata handler, or returns null if trailingMetadataHandler is null.

Parameter
Name	Description
`trailingMetadataHandler`	`ActionMetadata` Action to receive trailing metadata when the call completes.

Returns
Type	Description
`CallSettings`	A new instance, or null if `trailingMetadataHandler` is null..

Extension Methods

CallSettingsExtensions.MergedWith(CallSettings, CallSettings)

CallSettingsExtensions.WithCancellationToken(CallSettings, CancellationToken)

CallSettingsExtensions.WithDeadline(CallSettings, DateTime)

CallSettingsExtensions.WithEarlierDeadline(CallSettings, DateTime?, IClock)

CallSettingsExtensions.WithExpiration(CallSettings, Expiration)

CallSettingsExtensions.WithHeader(CallSettings, string, string)

CallSettingsExtensions.WithResponseMetadataHandler(CallSettings, Action<Metadata>)

CallSettingsExtensions.WithRetry(CallSettings, RetrySettings)

CallSettingsExtensions.WithTimeout(CallSettings, TimeSpan)

CallSettingsExtensions.WithTrailingMetadataHandler(CallSettings, Action<Metadata>)