Class ClientContext (2.16.0)

Version 2.16.0

• 2.59.0 (latest)
• 2.58.0
• 2.57.0
• 2.55.0
• 2.54.1
• 2.53.0
• 2.52.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.1
• 2.47.0
• 2.46.1
• 2.45.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.1
• 2.33.0
• 2.32.1
• 2.31.1
• 2.30.1
• 2.24.0
• 2.23.3
• 2.22.0
• 2.21.0
• 2.20.1
• 2.19.6
• 2.18.7
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.2
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.1
• 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

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create(ClientSettings settings)

public static ClientContext create(ClientSettings settings)

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

Parameter

Name	Description
settings	ClientSettings

Returns

Type	Description
ClientContext

Exceptions

Type	Description
IOException

create(StubSettings settings)

public static ClientContext create(StubSettings settings)

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

Parameter

Name	Description
settings	StubSettings

Returns

Type	Description
ClientContext

Exceptions

Type	Description
IOException

newBuilder()

public static ClientContext.Builder newBuilder()

Returns

Type	Description
ClientContext.Builder

Constructors

ClientContext()

public ClientContext()

Methods

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

Type	Description
List<BackgroundResource>

getClock()

public abstract ApiClock getClock()

Returns

Type	Description
com.google.api.core.ApiClock

getCredentials()

public abstract Credentials getCredentials()

Returns

Type	Description
com.google.auth.Credentials

getDefaultCallContext()

public abstract ApiCallContext getDefaultCallContext()

Returns

Type	Description
ApiCallContext

getEndpoint()

public abstract String getEndpoint()

Returns

Type	Description
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

Type	Description
ScheduledExecutorService

getHeaders()

public abstract Map<String,String> getHeaders()

Returns

Type	Description
Map<String,String>

getInternalHeaders()

protected abstract Map<String,String> getInternalHeaders()

Returns

Type	Description
Map<String,String>

getQuotaProjectId()

public abstract String getQuotaProjectId()

Returns

Type	Description
String

getStreamWatchdog()

public abstract Watchdog getStreamWatchdog()

Returns

Type	Description
Watchdog

getStreamWatchdogCheckInterval()

public abstract Duration getStreamWatchdogCheckInterval()

Returns

Type	Description
org.threeten.bp.Duration

getTracerFactory()

public abstract ApiTracerFactory getTracerFactory()

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

Returns

Type	Description
ApiTracerFactory

getTransportChannel()

public abstract TransportChannel getTransportChannel()

Returns

Type	Description
TransportChannel

toBuilder()

public abstract ClientContext.Builder toBuilder()

Returns

Type	Description
ClientContext.Builder