Class ServiceSettingsBase (4.4.0)

public abstract class ServiceSettingsBase

Common settings for all services.

Inheritance

object > ServiceSettingsBase

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace

Google.Api.Gax.Grpc

Assembly

Google.Api.Gax.Grpc.dll

Constructors

ServiceSettingsBase()

protected ServiceSettingsBase()

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

ServiceSettingsBase(ServiceSettingsBase)

protected ServiceSettingsBase(ServiceSettingsBase existing)

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

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

Properties

CallSettings

public CallSettings CallSettings { get; set; }

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.

Property Value
Type	Description
`CallSettings`

Clock

public IClock Clock { get; set; }

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

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

public Interceptor Interceptor { get; set; }

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.

Property Value
Type	Description
`Interceptor`

Scheduler

public IScheduler Scheduler { get; set; }

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

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

public VersionHeaderBuilder VersionHeaderBuilder { get; }

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.

Property Value
Type	Description
`VersionHeaderBuilder`