Class SubscriberClient.ClientCreationSettings (3.2.0)

Stay organized with collections Save and categorize content based on your preferences.
[Obsolete("Use PublisherClientBuilder to customize client settings.")]
public sealed class ClientCreationSettings

Settings for creating SubscriberServiceApiClients. This type is now obsolete; please use SubscriberClientBuilder which provides an API surface consistent with other clients (as well as additional Pub/Sub-specific properties such as ClientCount).

Inheritance

Object > SubscriberClient.ClientCreationSettings

Namespace

Google.Cloud.PubSub.V1

Assembly

Google.Cloud.PubSub.V1.dll

Constructors

ClientCreationSettings(Nullable<Int32>, SubscriberServiceApiSettings, ChannelCredentials, String)

public ClientCreationSettings(int? clientCount = null, SubscriberServiceApiSettings subscriberServiceApiSettings = null, ChannelCredentials credentials = null, string serviceEndpoint = null)

Instantiate with the specified settings.

Parameters
NameDescription
clientCountNullable<Int32>

Optional. The number of SubscriberServiceApiClients to create and use within a SubscriberClient instance.

subscriberServiceApiSettingsSubscriberServiceApiSettings

Optional. The settings to use when creating SubscriberServiceApiClient instances.

credentialsChannelCredentials

Optional. Credentials to use when creating SubscriberServiceApiClient instances.

serviceEndpointString

Optional. The ServiceEndpoint to use when creating SubscriberServiceApiClient instances.

Properties

ClientCount

public int? ClientCount { get; }

The number of SubscriberServiceApiClients to create and use within a SubscriberClient instance. If set, must be in the range 1 to 256 (inclusive). If null, defaults to the CPU count on the machine this is being executed on.

Property Value
TypeDescription
Nullable<Int32>

Credentials

public ChannelCredentials Credentials { get; }

Credentials to use when creating SubscriberServiceApiClient instances. If null, defaults to using the default credentials.

Property Value
TypeDescription
ChannelCredentials

EmulatorDetection

public EmulatorDetection EmulatorDetection { get; }

Specifies how to respond to the presence of emulator environment variables.

Property Value
TypeDescription
EmulatorDetection
Remarks

This property defaults to None, meaning that environment variables are ignored.

ServiceEndpoint

public string ServiceEndpoint { get; }

The endpoint to use when creating SubscriberServiceApiClient instances. If null, defaults to DefaultEndpoint.

Property Value
TypeDescription
String

SubscriberServiceApiSettings

public SubscriberServiceApiSettings SubscriberServiceApiSettings { get; }

The settings to use when creating SubscriberServiceApiClient instances. If null, defaults to GetDefault().

Property Value
TypeDescription
SubscriberServiceApiSettings

Methods

WithEmulatorDetection(EmulatorDetection)

public SubscriberClient.ClientCreationSettings WithEmulatorDetection(EmulatorDetection emulatorDetection)

Creates a new instance of this type with the specified emulator detection value.

Parameter
NameDescription
emulatorDetectionEmulatorDetection

Determines how and whether to detect the emulator.

Returns
TypeDescription
SubscriberClient.ClientCreationSettings

The new instance