public sealed class CallSettings
Settings to determine how an RPC operates. This type is immutable.
Namespace
Google.Api.Gax.GrpcAssembly
Google.Api.Gax.Grpc.dll
Constructors
CallSettings(Nullable<CancellationToken>, CallCredentials, Expiration, RetrySettings, Action<Metadata>, WriteOptions, ContextPropagationToken)
[Obsolete("This is obsolete as it allows per-call credentials to be specified. Please use an alternative overload and see https://github.com/googleapis/gax-dotnet/blob/master/docs/PER_CALL_CREDENTIAL.md for more information.")]
public CallSettings(CancellationToken? cancellationToken, CallCredentials credentials, Expiration expiration, RetrySettings retry, Action<Metadata> headerMutation, WriteOptions writeOptions, ContextPropagationToken propagationToken)
Obsolete. This is obsolete as it allows per-call credentials to be specified. Please use CallSettings(Nullable<CancellationToken>, Expiration, RetrySettings, Action<Metadata>, WriteOptions, ContextPropagationToken), and see https://github.com/googleapis/gax-dotnet/blob/master/docs/PER_CALL_CREDENTIAL.md for more information. Constructs an instance with the specified settings.
Parameters | |
---|---|
Name | Description |
cancellationToken | Nullable<CancellationToken> Cancellation token that can be used for cancelling the call. |
credentials | CallCredentials Credentials to use for 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 | Action<Metadata> Action to modify the headers to send at the beginning of the call. |
writeOptions | WriteOptions that will be used for the call. |
propagationToken | ContextPropagationToken for propagating settings from a parent call. |
CallSettings(Nullable<CancellationToken>, CallCredentials, Expiration, RetrySettings, Action<Metadata>, WriteOptions, ContextPropagationToken, Action<Metadata>, Action<Metadata>)
[Obsolete("This is obsolete as it allows per-call credentials to be specified. Please use an alternative overload and see https://github.com/googleapis/gax-dotnet/blob/master/docs/PER_CALL_CREDENTIAL.md for more information.")]
public CallSettings(CancellationToken? cancellationToken, CallCredentials credentials, Expiration expiration, RetrySettings retry, Action<Metadata> headerMutation, WriteOptions writeOptions, ContextPropagationToken propagationToken, Action<Metadata> responseMetadataHandler, Action<Metadata> trailingMetadataHandler)
Obsolete. This is obsolete as it allows per-call credentials to be specified. Please use CallSettings(Nullable<CancellationToken>, Expiration, RetrySettings, Action<Metadata>, WriteOptions, ContextPropagationToken, Action<Metadata>, Action<Metadata>), and see https://github.com/googleapis/gax-dotnet/blob/master/docs/PER_CALL_CREDENTIAL.md for more information. Constructs an instance with the specified settings.
Parameters | |
---|---|
Name | Description |
cancellationToken | Nullable<CancellationToken> Cancellation token that can be used for cancelling the call. |
credentials | CallCredentials Credentials to use for 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 | Action<Metadata> Action to modify the headers to send at the beginning of the call. |
writeOptions | WriteOptions that will be used for the call. |
propagationToken | ContextPropagationToken for propagating settings from a parent call. |
responseMetadataHandler | Action<Metadata> Action to invoke when response metadata is received. |
trailingMetadataHandler | Action<Metadata> Action to invoke when trailing metadata is received. |
CallSettings(Nullable<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 | Nullable<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 | Action<Metadata> Action to modify the headers to send at the beginning of the call. |
writeOptions | WriteOptions that will be used for the call. |
propagationToken | ContextPropagationToken for propagating settings from a parent call. |
CallSettings(Nullable<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 | Nullable<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 | Action<Metadata> Action to modify the headers to send at the beginning of the call. |
writeOptions | WriteOptions that will be used for the call. |
propagationToken | ContextPropagationToken for propagating settings from a parent call. |
responseMetadataHandler | Action<Metadata> Action to invoke when response metadata is received. |
trailingMetadataHandler | Action<Metadata> 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 |
Nullable<CancellationToken> |
Credentials
[Obsolete("https://github.com/googleapis/gax-dotnet/blob/master/PER_CALL_CREDENTIAL.md")]
public CallCredentials Credentials { get; }
Credentials to use for the call.
Property Value | |
---|---|
Type | Description |
CallCredentials |
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 |
Action<Metadata> |
PropagationToken
public ContextPropagationToken PropagationToken { get; }
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 |
Action<Metadata> |
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 |
Action<Metadata> |
WriteOptions
public WriteOptions WriteOptions { get; }
that will be used for the call.
Property Value | |
---|---|
Type | Description |
WriteOptions |
Methods
FromCallCredentials(CallCredentials)
[Obsolete("https://github.com/googleapis/gax-dotnet/blob/master/PER_CALL_CREDENTIAL.md")]
public static CallSettings FromCallCredentials(CallCredentials credentials)
Obsolete. See: https://github.com/googleapis/gax-dotnet/blob/master/PER_CALL_CREDENTIAL.md
Creates a CallSettings for the specified call credentials, or returns null
if credentials
is null.
Parameter | |
---|---|
Name | Description |
credentials | CallCredentials The call credentials for the new settings. |
Returns | |
---|---|
Type | Description |
CallSettings | A new instance, or null if |
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 |
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. |
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.
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 | Action<Metadata> Action to modify the headers to send at the beginning of the call. |
Returns | |
---|---|
Type | Description |
CallSettings | A new instance, or null if |
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 | Action<Metadata> Action to receive response metadata when the call completes. |
Returns | |
---|---|
Type | Description |
CallSettings | A new instance, or null if |
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 |
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 | Action<Metadata> Action to receive trailing metadata when the call completes. |
Returns | |
---|---|
Type | Description |
CallSettings | A new instance, or null if |