Package com.google.api.core (2.31.0)

GitHub Repository

Classes

Class Description
com.google.api.core.AbstractApiFuture Abstract implementation of ApiFuture that mirrors AbstractFuture in Guava.
com.google.api.core.AbstractApiService Base class for ApiService. Similar to Guava's AbstractService but redeclared so that Guava can be shaded.
com.google.api.core.ApiFutureToListenableFuture INTERNAL USE ONLY. Adapter from ApiFuture to Guava ListenableFuture.
com.google.api.core.ApiFutures Static utility methods for the ApiFuture interface.
com.google.api.core.ApiService.Listener A listener for the various state changes that a ApiService goes through in its lifecycle.

All methods are no-ops by default, implementors should override the ones they care about.
com.google.api.core.CurrentMillisClock Implementation of the ApiClock interface, which uses System#currentTimeMillis() as time source.
com.google.api.core.ForwardingApiFuture
com.google.api.core.ListenableFutureToApiFuture INTERNAL USE ONLY. Adapter from Guava ListenableFuture to ApiFuture.
com.google.api.core.NanoClock Default implementation of the ApiClock interface, using call to System.nanoTime().
com.google.api.core.SettableApiFuture An ApiFuture whose result can be set. Similar to Guava's SettableFuture, but redeclared so that Guava could be shaded.

Interfaces

Interface Description
com.google.api.core.ApiAsyncFunction Transforms a value, possibly asynchronously.

It is similar to Guava's AsyncFunction, redeclared so that Guava can be shaded.
com.google.api.core.ApiClock An interface for getting the current value of a high-resolution time source, in nanoseconds.

Clocks other than NanoClock are typically used only for testing.

com.google.api.core.ApiFunction Legacy version of Function.

It is similar to Guava's Function, redeclared so that Guava can be shaded.
com.google.api.core.ApiFuture A Future that can have a listener added.

Similar to Guava's ListenableFuture, but redeclared so that Guava could be shaded.
com.google.api.core.ApiFutureCallback A callback for accepting the results of an ApiFuture.

It is similar to Guava's FutureCallback, redeclared so that Guava can be shaded.
com.google.api.core.ApiService An object with an operational state, plus asynchronous #startAsync() and #stopAsync() lifecycle methods to transition between states. Example services include webservers, RPC servers and timers.

The normal lifecycle of a service is:
com.google.api.core.BetaApi Indicates a public API that can change at any time, and has no guarantee of API stability and backward-compatibility.

Usage guidelines:
com.google.api.core.InternalApi Annotates a program element (class, method, package etc) which is internal to its containing library, not part of the public API, and should not be used by users of the library.

This annotation only makes sense on APIs that are not private. Its existence is necessary
com.google.api.core.InternalExtensionOnly Indicates a public API that is stable for callers to use, but has no guarantee of stability for extension. Consequently, the API should only be extended within the package containing the API.

For example:
com.google.api.core.ObsoleteApi Indicates a public API is obsolete, and will be deprecated in a future version.

Usage guidelines:

Enums

Enum Description
com.google.api.core.ApiService.State The lifecycle states of a service.

The ordering of the State enum is defined such that if there is a state transition from A -> B then A.compareTo(B) < 0. N.B. The converse is not true, i.e. if