Cloud Pub/Sub v1 API - Class PublisherServiceApiClientBuilder (3.19.0)

public sealed class PublisherServiceApiClientBuilder : ClientBuilderBase<PublisherServiceApiClient>

Reference documentation and code samples for the Cloud Pub/Sub v1 API class PublisherServiceApiClientBuilder.

Builder class for PublisherServiceApiClient to provide simple configuration of credentials, endpoint etc.

Inheritance

object > ClientBuilderBasePublisherServiceApiClient > PublisherServiceApiClientBuilder

Namespace

Google.Cloud.PubSub.V1

Assembly

Google.Cloud.PubSub.V1.dll

Constructors

PublisherServiceApiClientBuilder()

public PublisherServiceApiClientBuilder()

Creates a new builder with default settings.

Properties

CanUseChannelPool

protected override bool CanUseChannelPool { get; }

Returns whether or not a channel pool can be used if a channel is required. The default behavior is to return true if and only if no quota project, scopes, credentials or token access method have been specified and if UseJwtAccessWithScopes flag matches the flag in ChannelPool. Derived classes should override this property if there are other reasons why the channel pool should not be used.

Property Value
Type Description
bool
Overrides
Google.Api.Gax.Grpc.ClientBuilderBase<Google.Cloud.PubSub.V1.PublisherServiceApiClient>.CanUseChannelPool

EmulatorDetection

public EmulatorDetection EmulatorDetection { get; set; }

Specifies how the builder responds to the presence of emulator environment variables.

Property Value
Type Description
EmulatorDetection
Remarks

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

Settings

public PublisherServiceApiSettings Settings { get; set; }

The settings to use for RPCs, or null for the default settings.

Property Value
Type Description
PublisherServiceApiSettings

Methods

Build()

public override PublisherServiceApiClient Build()

Builds the resulting client.

Returns
Type Description
PublisherServiceApiClient
Overrides
Google.Api.Gax.Grpc.ClientBuilderBase<Google.Cloud.PubSub.V1.PublisherServiceApiClient>.Build()

BuildAsync(CancellationToken)

public override Task<PublisherServiceApiClient> BuildAsync(CancellationToken cancellationToken = default)

Builds the resulting client asynchronously.

Parameter
Name Description
cancellationToken CancellationToken
Returns
Type Description
TaskPublisherServiceApiClient
Overrides
Google.Api.Gax.Grpc.ClientBuilderBase<Google.Cloud.PubSub.V1.PublisherServiceApiClient>.BuildAsync(System.Threading.CancellationToken)

GetChannelOptions()

protected override GrpcChannelOptions GetChannelOptions()

Returns the options to use when creating a channel, taking GrpcChannelOptions into account.

Returns
Type Description
GrpcChannelOptions

The options to use when creating a channel.

Overrides
Google.Api.Gax.Grpc.ClientBuilderBase<Google.Cloud.PubSub.V1.PublisherServiceApiClient>.GetChannelOptions()

GetChannelPool()

protected override ChannelPool GetChannelPool()

Returns the channel pool to use when no other options are specified.

Returns
Type Description
ChannelPool
Overrides
Google.Api.Gax.Grpc.ClientBuilderBase<Google.Cloud.PubSub.V1.PublisherServiceApiClient>.GetChannelPool()