Class ServiceSettingsBase

Common settings for all services.

Inheritance

System.Object

ServiceSettingsBase

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Google.Api.Gax.Grpc

Assembly: Google.Api.Gax.Grpc.dll

Syntax

public abstract class ServiceSettingsBase

Constructors

ServiceSettingsBase()

Constructs a new service settings base object with a default version header, unset call settings and unset clock.

Declaration

protected ServiceSettingsBase()

ServiceSettingsBase(ServiceSettingsBase)

Constructs a new service settings base object by cloning the settings from an existing one.

Declaration

protected ServiceSettingsBase(ServiceSettingsBase existing)

Parameters

Type	Name	Description
ServiceSettingsBase	existing	The existing settings object to clone settings from. Must not be null.

Properties

CallSettings

If not null, CallSettings that are applied to every RPC performed by the client. If null or unset, RPC default settings will be used for all settings.

Declaration

public CallSettings CallSettings { get; set; }

Property Value

Type	Description
CallSettings

Clock

If not null, the clock used to calculate RPC deadlines. If null or unset, the SystemClock is used.

Declaration

public IClock Clock { get; set; }

Property Value

Type	Description
IClock

Remarks

This is primarily only to be set for testing. In production code generally leave this unset to use the SystemClock.

Interceptor

An optional gRPC interceptor to perform arbitrary interception tasks (such as logging) on gRPC calls. Note that this property is not used by code generated before August 2nd 2018: only packages created on or after that date are aware of this property.

Declaration

public Interceptor Interceptor { get; set; }

Property Value

Type	Description
Interceptor

Scheduler

If not null, the scheduler used for delays between operations (e.g. for retry). If null or unset, the SystemScheduler is used.

Declaration

public IScheduler Scheduler { get; set; }

Property Value

Type	Description
IScheduler

Remarks

This is primarily only to be set for testing. In production code generally leave this unset to use the SystemScheduler.

VersionHeaderBuilder

A builder for x-goog-api-client version headers. Additional library versions can be appended via this property. End-users should almost never need to use this property; it is primarily for use in Google libraries which provide a higher level abstraction over the generated client libraries.

Declaration

public VersionHeaderBuilder VersionHeaderBuilder { get; }

Property Value

Type	Description
VersionHeaderBuilder