public sealed class GrafeasClientBuilder : ClientBuilderBase<GrafeasClient>Reference documentation and code samples for the Grafeas v1 API class GrafeasClientBuilder.
Builder class for GrafeasClient to provide simple configuration of credentials, endpoint etc.
Namespace
Grafeas.V1Assembly
Grafeas.V1.dll
Constructors
GrafeasClientBuilder()
public GrafeasClientBuilder()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 |
|
Settings
public GrafeasSettings Settings { get; set; }The settings to use for RPCs, or null for the default settings.
| Property Value | |
|---|---|
| Type | Description |
GrafeasSettings |
|
Methods
Build()
public override GrafeasClient Build()Builds the resulting client.
| Returns | |
|---|---|
| Type | Description |
GrafeasClient |
|
BuildAsync(CancellationToken)
public override Task<GrafeasClient> BuildAsync(CancellationToken cancellationToken = default)Builds the resulting client asynchronously.
| Parameter | |
|---|---|
| Name | Description |
cancellationToken |
CancellationToken |
| Returns | |
|---|---|
| Type | Description |
TaskGrafeasClient |
|
GetChannelPool()
protected override ChannelPool GetChannelPool()Returns the channel pool to use when no other options are specified. This method is not called unless CanUseChannelPool returns true, so if a channel pool is unavailable, override that property to return false and throw an exception from this method.
| Returns | |
|---|---|
| Type | Description |
ChannelPool |
|
Validate()
protected override void Validate()Validates that the builder is in a consistent state for building. For example, it's invalid to call Build() on an instance which has both JSON credentials and a credentials path specified.
| Exceptions | |
|---|---|
| Type | Description |
InvalidOperationException |
The builder is in an invalid state. |