Class ClientContext (2.7.1) 

public abstract class ClientContext

Encapsulates client state, including executor, credentials, and transport channel.

Unlike ClientSettings which allows users to configure the client, ClientContext is intended to be used in generated code. Most users will not need to use it.

Inheritance

java.lang.Object > ClientContext

Constructors

ClientContext()

public ClientContext()

Methods

create(ClientSettings settings)

public static ClientContext create(ClientSettings settings)

Instantiates the executor, credentials, and transport context based on the given client settings.

Parameter
NameDescription
settingsClientSettings
Returns
TypeDescription
ClientContext
Exceptions
TypeDescription
IOException

create(StubSettings settings)

public static ClientContext create(StubSettings settings)

Instantiates the executor, credentials, and transport context based on the given client settings.

Parameter
NameDescription
settingsStubSettings
Returns
TypeDescription
ClientContext
Exceptions
TypeDescription
IOException

getBackgroundResources()

public abstract List<BackgroundResource> getBackgroundResources()

The objects that need to be closed in order to clean up the resources created in the process of creating this ClientContext. This will include the closeables from the transport context.

Returns
TypeDescription
List<BackgroundResource>

getClock()

public abstract ApiClock getClock()
Returns
TypeDescription
com.google.api.core.ApiClock

getCredentials()

public abstract Credentials getCredentials()
Returns
TypeDescription
com.google.auth.Credentials

getDefaultCallContext()

public abstract ApiCallContext getDefaultCallContext()
Returns
TypeDescription
ApiCallContext

getEndpoint()

public abstract String getEndpoint()
Returns
TypeDescription
String

getExecutor()

public abstract ScheduledExecutorService getExecutor()

Gets the executor to use for running scheduled API call logic (such as retries and long-running operations).

Returns
TypeDescription
ScheduledExecutorService

getHeaders()

public abstract Map<String,String> getHeaders()
Returns
TypeDescription
Map<String,String>

getInternalHeaders()

protected abstract Map<String,String> getInternalHeaders()
Returns
TypeDescription
Map<String,String>

getQuotaProjectId()

public abstract String getQuotaProjectId()
Returns
TypeDescription
String

getStreamWatchdog()

public abstract Watchdog getStreamWatchdog()
Returns
TypeDescription
Watchdog

getStreamWatchdogCheckInterval()

public abstract Duration getStreamWatchdogCheckInterval()
Returns
TypeDescription
org.threeten.bp.Duration

getTracerFactory()

public abstract ApiTracerFactory getTracerFactory()

Gets the ApiTracerFactory that will be used to generate traces for operations.

Returns
TypeDescription
ApiTracerFactory

getTransportChannel()

public abstract TransportChannel getTransportChannel()
Returns
TypeDescription
TransportChannel

newBuilder()

public static ClientContext.Builder newBuilder()
Returns
TypeDescription
ClientContext.Builder

toBuilder()

public abstract ClientContext.Builder toBuilder()
Returns
TypeDescription
ClientContext.Builder