com.google.api.gax.rpc

Class ClientContext

java.lang.Object

com.google.api.gax.rpc.ClientContext

@BetaApi
public abstract class ClientContext
extends Object

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

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClientContext.Builder

Constructor Summary

Constructors

Constructor and Description
ClientContext()

Method Summary

Modifier and Type	Method and Description
static ClientContext	create(ClientSettings settings) Instantiates the executor, credentials, and transport context based on the given client settings.
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.
abstract com.google.api.core.ApiClock	getClock()
abstract com.google.auth.Credentials	getCredentials()
abstract ScheduledExecutorService	getExecutor()
abstract Transport	getTransportContext()
static ClientContext.Builder	newBuilder()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClientContext

public ClientContext()

Method Detail

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.

getExecutor

public abstract ScheduledExecutorService getExecutor()

getCredentials

@Nullable
public abstract com.google.auth.Credentials getCredentials()

getTransportContext

public abstract Transport getTransportContext()

getClock

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

newBuilder

public static ClientContext.Builder newBuilder()

create

public static ClientContext create(ClientSettings settings)
                            throws IOException

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

Throws:

IOException