Index (API Common 2.16.0 API)

A B C D E F G H I K L M N O P R S T U V W
All Classes All Packages

A

AbstractApiFuture<V> - Class in com.google.api.core: Abstract implementation of ApiFuture that mirrors AbstractFuture in Guava.
AbstractApiFuture() - Constructor for class com.google.api.core.AbstractApiFuture
AbstractApiService - Class in com.google.api.core: Base class for ApiService.
AbstractApiService() - Constructor for class com.google.api.core.AbstractApiService
addCallback(ApiFuture<V>, ApiFutureCallback<? super V>) - Static method in class com.google.api.core.ApiFutures: Deprecated.
Use the overload that requires an executor. For identical behavior, pass MoreExecutors.directExecutor(), but consider whether another executor would be safer.
addCallback(ApiFuture<V>, ApiFutureCallback<? super V>, Executor) - Static method in class com.google.api.core.ApiFutures: Registers a callback to be run when the ApiFuture's computation is complete or, if the computation is already complete, immediately.
addListener(ApiService.Listener, Executor) - Method in class com.google.api.core.AbstractApiService
addListener(ApiService.Listener, Executor) - Method in interface com.google.api.core.ApiService: Registers a ApiService.Listener to be executed on the given executor.
addListener(Runnable, Executor) - Method in class com.google.api.core.AbstractApiFuture
addListener(Runnable, Executor) - Method in interface com.google.api.core.ApiFuture
addListener(Runnable, Executor) - Method in class com.google.api.core.ApiFutureToListenableFuture
addListener(Runnable, Executor) - Method in class com.google.api.core.ForwardingApiFuture
allAsList(Iterable<? extends ApiFuture<? extends V>>) - Static method in class com.google.api.core.ApiFutures: Creates a new ApiFuture whose value is a list containing the values of all its input futures, if all succeed.
ApiAsyncFunction<I,O> - Interface in com.google.api.core: Transforms a value, possibly asynchronously.
ApiClock - Interface in com.google.api.core: An interface for getting the current value of a high-resolution time source, in nanoseconds.
ApiFunction<F,T> - Interface in com.google.api.core: Legacy version of Function.
ApiFuture<V> - Interface in com.google.api.core: A Future that can have a listener added.
ApiFutureCallback<V> - Interface in com.google.api.core: A callback for accepting the results of an ApiFuture.
ApiFutures - Class in com.google.api.core: Static utility methods for the ApiFuture interface.
ApiFutureToListenableFuture<V> - Class in com.google.api.core: INTERNAL USE ONLY.
ApiFutureToListenableFuture(ApiFuture<V>) - Constructor for class com.google.api.core.ApiFutureToListenableFuture
ApiService - Interface in com.google.api.core: An object with an operational state, plus asynchronous ApiService.startAsync() and ApiService.stopAsync() lifecycle methods to transition between states.
ApiService.Listener - Class in com.google.api.core: A listener for the various state changes that a ApiService goes through in its lifecycle.
ApiService.State - Enum in com.google.api.core: The lifecycle states of a service.
apply(F) - Method in interface com.google.api.core.ApiFunction
apply(I) - Method in interface com.google.api.core.ApiAsyncFunction: Returns an output Future to use in place of the given input.
awaitRunning() - Method in class com.google.api.core.AbstractApiService
awaitRunning() - Method in interface com.google.api.core.ApiService: Waits for the ApiService to reach the running state.
awaitRunning(long, TimeUnit) - Method in class com.google.api.core.AbstractApiService
awaitRunning(long, TimeUnit) - Method in interface com.google.api.core.ApiService: Waits for the ApiService to reach the running state for no more than the given time.
awaitTerminated() - Method in class com.google.api.core.AbstractApiService
awaitTerminated() - Method in interface com.google.api.core.ApiService: Waits for the ApiService to reach the terminated state.
awaitTerminated(long, TimeUnit) - Method in class com.google.api.core.AbstractApiService
awaitTerminated(long, TimeUnit) - Method in interface com.google.api.core.ApiService: Waits for the ApiService to reach a terminal state (either terminated or failed) for no more than the given time.

B

BetaApi - Annotation Type in com.google.api.core: Indicates a public API that can change at any time, and has no guarantee of API stability and backward-compatibility.

C

cancel(boolean) - Method in class com.google.api.core.AbstractApiFuture
cancel(boolean) - Method in class com.google.api.core.ApiFutureToListenableFuture
cancel(boolean) - Method in class com.google.api.core.ForwardingApiFuture
catching(ApiFuture<? extends V>, Class<X>, ApiFunction<? super X, ? extends V>) - Static method in class com.google.api.core.ApiFutures: Deprecated.
Use the overload that requires an executor. For identical behavior, pass MoreExecutors.directExecutor(), but consider whether another executor would be safer.
catching(ApiFuture<? extends V>, Class<X>, ApiFunction<? super X, ? extends V>, Executor) - Static method in class com.google.api.core.ApiFutures: Returns an ApiFuture whose result is taken from the given primary input or, if the primary input fails with the given exceptionType, from the result provided by the callback.
catchingAsync(ApiFuture<V>, Class<X>, ApiAsyncFunction<? super X, V>, Executor) - Static method in class com.google.api.core.ApiFutures: Returns a ApiFuture whose result is taken from the given primary input or, if the primary input fails with the given exceptionType, from the result provided by the callback.
clear() - Method in class com.google.api.pathtemplate.TemplatedResourceName: Deprecated.
com.google.api.core - package com.google.api.core
com.google.api.pathtemplate - package com.google.api.pathtemplate
com.google.api.resourcenames - package com.google.api.resourcenames
containsKey(Object) - Method in class com.google.api.pathtemplate.TemplatedResourceName
containsValue(Object) - Method in class com.google.api.pathtemplate.TemplatedResourceName
create() - Static method in class com.google.api.core.SettableApiFuture
create(PathTemplate, String) - Static method in class com.google.api.pathtemplate.TemplatedResourceName: Creates a new resource name based on given template and path.
create(PathTemplate, Map<String, String>) - Static method in class com.google.api.pathtemplate.TemplatedResourceName: Creates a new resource name from a template and a value assignment for variables.
create(String) - Static method in class com.google.api.pathtemplate.PathTemplate: Creates a path template from a string.
createFromFullName(PathTemplate, String) - Static method in class com.google.api.pathtemplate.TemplatedResourceName: Creates a new resource name based on given template and path, where the path contains an endpoint.
createWithoutUrlEncoding(String) - Static method in class com.google.api.pathtemplate.PathTemplate: Creates a path template from a string.
CurrentMillisClock - Class in com.google.api.core: Implementation of the ApiClock interface, which uses System.currentTimeMillis() as time source.

D

decode(String) - Method in class com.google.api.pathtemplate.PathTemplate: Matches the template into a list of positional values.
doStart() - Method in class com.google.api.core.AbstractApiService
doStop() - Method in class com.google.api.core.AbstractApiService

E

encode(String...) - Method in class com.google.api.pathtemplate.PathTemplate: Instantiates the template from the given positional parameters.
endpoint() - Method in class com.google.api.pathtemplate.TemplatedResourceName: Returns the endpoint of this resource name, or null if none is defined.
endsWithCustomVerb() - Method in class com.google.api.pathtemplate.PathTemplate: Returns true of this template ends with a custom verb.
endsWithLiteral() - Method in class com.google.api.pathtemplate.PathTemplate: Returns true of this template ends with a literal.
entrySet() - Method in class com.google.api.pathtemplate.TemplatedResourceName
equals(Object) - Method in class com.google.api.pathtemplate.PathTemplate
equals(Object) - Method in class com.google.api.pathtemplate.TemplatedResourceName
equals(Object) - Method in class com.google.api.resourcenames.UntypedResourceName

F

failed(ApiService.State, Throwable) - Method in class com.google.api.core.ApiService.Listener: Called when the service transitions to the FAILED state.
FAILED - com.google.api.core.ApiService.State: A service in this state has encountered a problem and may not be operational.
failureCause() - Method in class com.google.api.core.AbstractApiService
failureCause() - Method in interface com.google.api.core.ApiService: Returns the Throwable that caused this service to fail.
ForwardingApiFuture<T> - Class in com.google.api.core
ForwardingApiFuture(ApiFuture<T>) - Constructor for class com.google.api.core.ForwardingApiFuture

G

get() - Method in class com.google.api.core.AbstractApiFuture
get() - Method in class com.google.api.core.ApiFutureToListenableFuture
get() - Method in class com.google.api.core.ForwardingApiFuture
get() - Method in interface com.google.api.pathtemplate.ValidationException.Supplier
get(long, TimeUnit) - Method in class com.google.api.core.AbstractApiFuture
get(long, TimeUnit) - Method in class com.google.api.core.ApiFutureToListenableFuture
get(long, TimeUnit) - Method in class com.google.api.core.ForwardingApiFuture
get(Object) - Method in class com.google.api.pathtemplate.TemplatedResourceName
getDefaultClock() - Static method in class com.google.api.core.CurrentMillisClock
getDefaultClock() - Static method in class com.google.api.core.NanoClock
getFieldValue(String) - Method in interface com.google.api.resourcenames.ResourceName: Return the String value of the field with name fieldName.
getFieldValue(String) - Method in class com.google.api.resourcenames.UntypedResourceName
getFieldValuesMap() - Method in interface com.google.api.resourcenames.ResourceName: Return the map of each field name to its value.
getFieldValuesMap() - Method in class com.google.api.resourcenames.UntypedResourceName

H

hasEndpoint() - Method in class com.google.api.pathtemplate.TemplatedResourceName: Checks whether the resource name has an endpoint.
hashCode() - Method in class com.google.api.pathtemplate.PathTemplate
hashCode() - Method in class com.google.api.pathtemplate.TemplatedResourceName
hashCode() - Method in class com.google.api.resourcenames.UntypedResourceName
HOSTNAME_VAR - Static variable in class com.google.api.pathtemplate.PathTemplate: A constant identifying the special variable used for endpoint bindings in the result of matchFromFullName(String).

I

immediateCancelledFuture() - Static method in class com.google.api.core.ApiFutures: Creates a ApiFuture which is cancelled immediately upon construction, so that isCancelled() always returns true.
immediateFailedFuture(Throwable) - Static method in class com.google.api.core.ApiFutures: Returns a ApiFuture which has an exception set immediately upon construction.
immediateFuture(V) - Static method in class com.google.api.core.ApiFutures: Creates a ApiFuture which has its value set immediately upon construction.
instantiate(String...) - Method in class com.google.api.pathtemplate.PathTemplate: Shortcut for instantiate(Map) with a vararg parameter for keys and values.
instantiate(Map<String, String>) - Method in class com.google.api.pathtemplate.PathTemplate: Instantiate the template based on the given variable assignment.
instantiatePartial(Map<String, String>) - Method in class com.google.api.pathtemplate.PathTemplate: Same like instantiate(Map) but allows for unbound variables, which are substituted using their original syntax.
InternalApi - Annotation Type in com.google.api.core: 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.
InternalExtensionOnly - Annotation Type in com.google.api.core: Indicates a public API that is stable for callers to use, but has no guarantee of stability for extension.
interruptTask() - Method in class com.google.api.core.AbstractApiFuture
isCancelled() - Method in class com.google.api.core.AbstractApiFuture
isCancelled() - Method in class com.google.api.core.ApiFutureToListenableFuture
isCancelled() - Method in class com.google.api.core.ForwardingApiFuture
isDone() - Method in class com.google.api.core.AbstractApiFuture
isDone() - Method in class com.google.api.core.ApiFutureToListenableFuture
isDone() - Method in class com.google.api.core.ForwardingApiFuture
isEmpty() - Method in class com.google.api.pathtemplate.TemplatedResourceName
isParsableFrom(String) - Static method in class com.google.api.resourcenames.UntypedResourceName
isRunning() - Method in class com.google.api.core.AbstractApiService
isRunning() - Method in interface com.google.api.core.ApiService: Returns true if this service is running.

K

keySet() - Method in class com.google.api.pathtemplate.TemplatedResourceName

L

ListenableFutureToApiFuture<V> - Class in com.google.api.core: INTERNAL USE ONLY.
ListenableFutureToApiFuture(ListenableFuture<V>) - Constructor for class com.google.api.core.ListenableFutureToApiFuture
Listener() - Constructor for class com.google.api.core.ApiService.Listener

M

match(String) - Method in class com.google.api.pathtemplate.PathTemplate: Matches the path, returning a map from variable names to matched values.
matches(String) - Method in class com.google.api.pathtemplate.PathTemplate: Returns true if the template matches the path.
matchFromFullName(String) - Method in class com.google.api.pathtemplate.PathTemplate: Matches the path, where the first segment is interpreted as the host name regardless of whether it starts with '//' or not.
millisTime() - Method in interface com.google.api.core.ApiClock: Returns the current value of this clock's high-resolution time source, in milliseconds.
millisTime() - Method in class com.google.api.core.CurrentMillisClock
millisTime() - Method in class com.google.api.core.NanoClock

N

NanoClock - Class in com.google.api.core: Default implementation of the ApiClock interface, using call to System.nanoTime().
nanoTime() - Method in interface com.google.api.core.ApiClock: Returns the current value of this clock's high-resolution time source, in nanoseconds.
nanoTime() - Method in class com.google.api.core.CurrentMillisClock
nanoTime() - Method in class com.google.api.core.NanoClock
NEW - com.google.api.core.ApiService.State: A service in this state is inactive.
notifyFailed(Throwable) - Method in class com.google.api.core.AbstractApiService
notifyStarted() - Method in class com.google.api.core.AbstractApiService
notifyStopped() - Method in class com.google.api.core.AbstractApiService

O

ObsoleteApi - Annotation Type in com.google.api.core: Indicates a public API is obsolete, and will be deprecated in a future version.
of(ResourceName) - Static method in class com.google.api.resourcenames.UntypedResourceName
onFailure(Throwable) - Method in interface com.google.api.core.ApiFutureCallback
onSuccess(V) - Method in interface com.google.api.core.ApiFutureCallback

P

parentName() - Method in class com.google.api.pathtemplate.TemplatedResourceName: Returns the parent resource name.
parentTemplate() - Method in class com.google.api.pathtemplate.PathTemplate: Returns a template for the parent of this template.
parse(String) - Method in class com.google.api.pathtemplate.PathTemplate: Creates a resource name from this template and a path.
parse(String) - Method in interface com.google.api.resourcenames.ResourceNameFactory
parse(String) - Static method in class com.google.api.resourcenames.UntypedResourceName
PathTemplate - Class in com.google.api.pathtemplate: Represents a path template.
popCurrentThreadValidationContext() - Static method in exception com.google.api.pathtemplate.ValidationException: Clears the validation context.
pushCurrentThreadValidationContext(ValidationException.Supplier<String>) - Static method in exception com.google.api.pathtemplate.ValidationException: Sets the validation context description.
pushCurrentThreadValidationContext(String) - Static method in exception com.google.api.pathtemplate.ValidationException
put(String, String) - Method in class com.google.api.pathtemplate.TemplatedResourceName: Deprecated.
putAll(Map<? extends String, ? extends String>) - Method in class com.google.api.pathtemplate.TemplatedResourceName: Deprecated.

R

registerResourceNameResolver(TemplatedResourceName.Resolver) - Static method in class com.google.api.pathtemplate.TemplatedResourceName: Sets the resource name resolver which is used by the TemplatedResourceName.resolve(Class, String) method.
remove(Object) - Method in class com.google.api.pathtemplate.TemplatedResourceName: Deprecated.
resolve(Class<T>, TemplatedResourceName, String) - Method in interface com.google.api.pathtemplate.TemplatedResourceName.Resolver: Resolves the resource name into a resource by calling the underlying API.
resolve(Class<T>, String) - Method in class com.google.api.pathtemplate.TemplatedResourceName: Attempts to resolve a resource name into a resource, by calling the associated API.
ResourceName - Interface in com.google.api.resourcenames: An interface that generated resource name types must implement.
ResourceNameFactory<T extends ResourceName> - Interface in com.google.api.resourcenames
running() - Method in class com.google.api.core.ApiService.Listener: Called when the service transitions from STARTING to RUNNING.
RUNNING - com.google.api.core.ApiService.State: A service in this state is operational.

S

set(V) - Method in class com.google.api.core.AbstractApiFuture
set(V) - Method in class com.google.api.core.SettableApiFuture
setException(Throwable) - Method in class com.google.api.core.AbstractApiFuture
setException(Throwable) - Method in class com.google.api.core.SettableApiFuture
SettableApiFuture<V> - Class in com.google.api.core: An ApiFuture whose result can be set.
singleVar() - Method in class com.google.api.pathtemplate.PathTemplate: Returns the name of a singleton variable used by this template.
size() - Method in class com.google.api.pathtemplate.TemplatedResourceName
startAsync() - Method in class com.google.api.core.AbstractApiService
startAsync() - Method in interface com.google.api.core.ApiService: If the service state is ApiService.State.NEW, this initiates service startup and returns immediately.
starting() - Method in class com.google.api.core.ApiService.Listener: Called when the service transitions from NEW to STARTING.
STARTING - com.google.api.core.ApiService.State: A service in this state is transitioning to ApiService.State.RUNNING.
startsWith(TemplatedResourceName) - Method in class com.google.api.pathtemplate.TemplatedResourceName: Returns true of the resource name starts with the parent resource name, i.e.
state() - Method in class com.google.api.core.AbstractApiService
state() - Method in interface com.google.api.core.ApiService: Returns the lifecycle state of the service.
stopAsync() - Method in class com.google.api.core.AbstractApiService
stopAsync() - Method in interface com.google.api.core.ApiService: If the service is starting or running, this initiates service shutdown and returns immediately.
stopping(ApiService.State) - Method in class com.google.api.core.ApiService.Listener: Called when the service transitions to the STOPPING state.
STOPPING - com.google.api.core.ApiService.State: A service in this state is transitioning to ApiService.State.TERMINATED.
subTemplate(String) - Method in class com.google.api.pathtemplate.PathTemplate: Returns a path template for the sub-path of the given variable.
successfulAsList(Iterable<? extends ApiFuture<? extends V>>) - Static method in class com.google.api.core.ApiFutures: Creates a new ApiFuture whose value is a list containing the values of all its successful input futures.

T

template() - Method in class com.google.api.pathtemplate.TemplatedResourceName: Gets the template associated with this resource name.
TemplatedResourceName - Class in com.google.api.pathtemplate: Class for representing and working with resource names.
TemplatedResourceName.Resolver - Interface in com.google.api.pathtemplate: Represents a resource name resolver which can be registered with this class.
terminated(ApiService.State) - Method in class com.google.api.core.ApiService.Listener: Called when the service transitions to the TERMINATED state.
TERMINATED - com.google.api.core.ApiService.State: A service in this state has completed execution normally.
toRawString() - Method in class com.google.api.pathtemplate.PathTemplate: Returns a raw version of the template as a string.
toString() - Method in class com.google.api.pathtemplate.PathTemplate: Returns a pretty version of the template as a string.
toString() - Method in class com.google.api.pathtemplate.TemplatedResourceName
toString() - Method in class com.google.api.resourcenames.UntypedResourceName
transform(ApiFuture<? extends V>, ApiFunction<? super V, ? extends X>) - Static method in class com.google.api.core.ApiFutures: Deprecated.
Use the overload that requires an executor. For identical behavior, pass MoreExecutors.directExecutor(), but consider whether another executor would be safer.
transform(ApiFuture<? extends V>, ApiFunction<? super V, ? extends X>, Executor) - Static method in class com.google.api.core.ApiFutures: Returns a new ApiFuture whose result is derived from the result of the given ApiFuture.
transformAsync(ApiFuture<I>, ApiAsyncFunction<I, O>) - Static method in class com.google.api.core.ApiFutures: Deprecated.
Use ApiFutures.transformAsync(ApiFuture, ApiAsyncFunction, Executor), the overload that requires an executor. For identical behavior, pass MoreExecutors.directExecutor(), but consider whether another executor would be safer.
transformAsync(ApiFuture<I>, ApiAsyncFunction<I, O>, Executor) - Static method in class com.google.api.core.ApiFutures: Returns a new ApiFuture whose result is asynchronously derived from the result of the given ApiFuture.

U

UntypedResourceName - Class in com.google.api.resourcenames: A class to represent a ResourceName with an unknown format.

V

validate(String, String) - Method in class com.google.api.pathtemplate.PathTemplate: Throws a ValidationException if the template doesn't match the path.
validatedMatch(String, String) - Method in class com.google.api.pathtemplate.PathTemplate: Matches the path, returning a map from variable names to matched values.
ValidationException - Exception in com.google.api.pathtemplate: Exception thrown if there is a validation problem with a path template, http config, or related framework methods.
ValidationException(String, Object...) - Constructor for exception com.google.api.pathtemplate.ValidationException: Construct validation exception with implicit context.
ValidationException.Supplier<T> - Interface in com.google.api.pathtemplate
value() - Method in annotation type com.google.api.core.BetaApi: Context information such as links to a discussion thread, tracking issue, etc.
value() - Method in annotation type com.google.api.core.InternalApi: Context information such as "internal to library", "for testing", etc.
value() - Method in annotation type com.google.api.core.InternalExtensionOnly: Context information on why the interface/class is annotated with InternalExtensionOnly.
value() - Method in annotation type com.google.api.core.ObsoleteApi: Context information such as links to a discussion thread, tracking issue, etc.
valueOf(String) - Static method in enum com.google.api.core.ApiService.State: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.google.api.core.ApiService.State: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Method in class com.google.api.pathtemplate.TemplatedResourceName
vars() - Method in class com.google.api.pathtemplate.PathTemplate: Returns the set of variable names used in the template.

W

withEndpoint(String) - Method in class com.google.api.pathtemplate.TemplatedResourceName: Returns a resource name with specified endpoint.
withoutVars() - Method in class com.google.api.pathtemplate.PathTemplate: Returns a template where all variable bindings have been replaced by wildcards, but which is equivalent regards matching to this one.

A B C D E F G H I K L M N O P R S T U V W
All Classes All Packages