All Classes and Interfaces
Class
Description
AbstractIntervalTimer is common base class for Timer implementations that base measure the change in some value
between the point where the timer is started and the point where
the timer is stopped.An AsyncDatastoreService implementation that is pinned to a specific appId and namesapce.
Builds
SearchService instances that are pinned to a specific application and namespace
regardless of the "current" appId provided by ApiProxy.getCurrentEnvironment().getAppId()
and the "current" namespace provided by NamespaceManager.get().Delegates AppEngine API calls to a local http API proxy.
Implements the ApiProxy environment.
Annotation that marks a package or class as internal to App Engine.
The
AppIdentityService allows you to sign an arbitrary byte array using a per app private
key maintained by App Engine, and to retrieve a list of public certificates which can be used to
verify the signature.GetAccessTokenResult is returned by getAccessToken.Class holding the results of parsing a full application id into its constituent parts.
SigningResult is returned by signForApp, which contains signing key name and signature.Creates new instances of the App Identity service.
AppIdentityServiceFailureException is thrown when any unknown error occurs while
communicating with the App Identity service.An AppLogLine contains all the information for a single application
log.
An asynchronous version of
DatastoreService.An asynchronous version of
MemcacheService.Deprecated.
Factory for getting the Backends API implementation for the current
environment.
Methods that are common between
DatastoreService and AsyncDatastoreService.Methods that are common between
MemcacheService and
AsyncMemcacheService.Blob contains an array of bytes.BlobInfo contains metadata about a blob.BlobInfoFactory provides a trivial interface for retrieving
BlobInfo metadata.BlobKey contains the string identifier of a large (possibly
larger than 1MB) blob of binary data that was uploaded in a
previous request and can be streamed directly to users.BlobstoreFailureException is an unchecked exception that is thrown
for any unexpected error that occurs while communicating with the
blobstore.BlobstoreInputStream provides an InputStream view of a blob in
Blobstore.
A subclass of
IOException that indicates that there was a problem
interacting with Blobstore.A subclass of
IOException that indicates operations on a stream after
it is closed.BlobstoreService allows you to manage the creation and
serving of large, immutable blobs to users.Deprecated.
BlobstoreService allows you to manage the creation and
serving of large, immutable blobs to users.Creates
BlobstoreService implementations.Deprecated.
as of version 3.0, use
BlobstoreServiceFactory instead.Creates
BlobstoreService implementations for java EE 10.The
BounceNotification object represents an incoming bounce
notification.The
BounceNotification.Details class describes either the original
message that caused a bounce, or the notification message describing the
bounce.The
BounceNotificationParser parses an incoming HTTP request into
a description of a bounce notification.Deprecated.
as of version 3.0, use
BounceNotificationParser instead.The
BounceNotificationParser parses an incoming HTTP request into
a description of a bounce notification.A byte range as parsed from a request Range header.
Describes the context in which a callback runs.
Allows applications to identify API outages.
Factory for creating a
CapabilitiesService.A capability represents a particular feature or set of features
available on the App Engine platform.
Represents the state of a
Capability.Represents the status of a
Capability.A tag, ie a descriptive word or phrase.
User-configurable global properties of Cloud Datastore.
An App Engine application ID.
Locations for App Engine applications.
Builder for
CloudDatastoreRemoteServiceConfig.CommittedButStillApplyingException is thrown when the write or transaction was committed,
but some entities or index rows may not have been fully updated.A
Composite represents a composition of an image onto a canvas.Valid anchoring positions for a compositing operation.
Composite index management operations needed by the datastore api.
Static utilities for working with composite indexes.
A transform that represents zero or more transforms executed in series.
A marker interface to indicate that all
MemcacheServiceException exceptions should be
handled by ErrorHandler.handleServiceError(MemcacheServiceException).Similar to the deprecated
LogAndContinueErrorHandler but consistently
handles all back-end related errors.A cursor that represents a position in a query.
A builder which constructs Cursor objects.
Checks values of
Cursor.Helper methods and constants shared by classes that implement the Java api on top of the
datastore.
Attributes of a datastore.
Indicates the type of datastore being used.
Deprecated.
Use
DatastoreServiceConfig instead.DatastoreFailureException is thrown when any unknown error occurs while communicating
with the data store.DatastoreNeedIndexException is thrown when no matching index was found for a query
requiring an index.The
DatastoreService provides synchronous access to a schema-less data storage system.Indicates the state of a
KeyRange.User-configurable properties of the datastore.
Contains static creation methods for
DatastoreServiceConfig.Creates DatastoreService implementations.
DatastoreTimeoutException is thrown when a datastore operation times out.DataTypeTranslator is a utility class for converting between the data store's
Property protocol buffers and the user-facing classes (String, User, etc.).A wrapper for a
byte[] that implements Comparable.DataTypeUtils presents a simpler interface that allows user-code to determine what
Classes can safely be stored as properties in the data store.A utility class that centralizes processing of dates.
Interface for deferred tasks.
Resources for managing
DeferredTask.Deprecated.
as of version 3.0, use
DeferredTaskContext instead.Resources for managing
.
invalid reference
DeferredTaskIndicates a failure to create a task payload.
Implementation of
HttpServlet to dispatch tasks with a DeferredTask payload; see
TaskOptions.payload(DeferredTask).Deprecated.
as of version 3.0, use
DeferredTaskServlet instead.Implementation of
HttpServlet to dispatch tasks with a DeferredTask payload; see
TaskOptions.payload(DeferredTask).Concrete
CallbackContext implementation that is specific to delete() callbacks.Thrown to indicate that a search service failure occurred while deleting
objects.
Represents a user generated document.
A builder of documents.
Checks values of a
Document.Deprecated.
as of version 3.0.0, use
JakartaRemoteApiServlet instead.An e-mail address datatype.
A property value containing embedded entity properties (and optionally a
Key).Utility functions and constants for entities.
Entity is the fundamental unit of data storage.EntityNotFoundException is thrown when no Entity with the specified Key
could be found.Utilities for comparing
OnestoreEntity.EntityProto.A comparator for
OnestoreEntity.EntityProto objects with
the same ordering as EntityComparator.EntityTranslator contains the logic to translate an Entity into the protocol
buffers that are used to pass it to the implementation of the API.Handles errors raised by the
MemcacheService, registered with
BaseMemcacheService.setErrorHandler(ErrorHandler).Static utility for getting built-in
ErrorHandlers.Expiration specifications on
MemcacheService.putAll(Map, Expiration)
and MemcacheService.put(Object, Object, Expiration) operations.A generator of AST representation of an expression.
Internal class that provides utility methods for extendable entity objects.
A
Facet can be used to categorize a Document.Provides checks for Facet names and values: atom or number.
A
FacetOptions represents facet options such as the number of facets to discover
(discoveryLimit), the number of values to be included in each discovered
facet (discoveryValueLimit), and the depth of the results to check (depth).Builder for
FacetOptions.Provides checks for faceted search related query options.
A FacetRange is a range with a start (inclusive) and an end (exclusive).
A Facet Refinement to filter out search results based on a facet value.
A facet request representing parameters for requesting specific facets to be returned with a
query result.
A facet request builder.
Represents a facet result computed from an extended search result set.
A builder of facet result.
Represents a single facet result value.
A base class for service factory creation that can be registered with the ProviderRegistry.
Describes the limit, offset, and chunk size to be applied when executing a
PreparedQuery.Allows users to customize the behavior of
URLFetchService
operations.Contains static creation methods for
FetchOptions.Contains static creation methods for
FetchOptions.Represents a field of a
Document, which is a name, an optional locale, and at most one
value: text, HTML, atom, date, GeoPoint, untokenizedPrefix, tokenizedPrefix or vector.A field builder.
The type of the field value.
Provides checks for Field names, language code, and values: text, HTML, atom
or date.
Represents an expression bound to a returned Field with the given
name.
A field expression builder.
FileInfo contains metadata about an uploaded file.Provides limited access to unlaunched (package-private) methods and classes from outside this
package.
Utilities for working with
Futures in the synchronous datastore api.Represents a point on the Earth's surface, in latitude and longitude
coordinates.
Provides checks for
GeoPoint.A geographical point, specified by float latitude and longitude coordinates.
Thrown to indicate that a search service failure occurred while performing
a request to get requested objects.
A request to get a range of indexes.
The builder of
GetIndexesRequests.Checks values of
GetIndexesRequest.A request to list objects in an index.
The builder of
GetRequests.Checks values of
GetRequest.Represents a result of executing a
GetRequest.Implementation of the 'Google Message Transport' which really just
connects to the exposed MailService and uses it to deliver a message.
HTTPHeader can represent either an HTTP request header, or
an HTTP response header.HTTPMethod is an enumeration of HTTP methods that can be
sent to a remote server via the URLFetchService.HTTPRequest encapsulates a single HTTP request that is made
via the URLFetchService.HttpRequestParser encapsulates helper methods used to parse incoming
multipart/form-data HTTP requests.HttpRequestParser encapsulates helper methods used to parse incoming
multipart/form-data HTTP requests.HttpRequestParser encapsulates helper methods used to parse incoming
multipart/form-data HTTP requests.HTTPResponse encapsulates the results of a
HTTPRequest made via the URLFetchService.Creates new instances of the App Identity service.
Factory provider for
IAppIdentityServiceFactory.Factory for getting the Backends API implementation for the current
environment.
Factory provider for
IBackendServiceFactory.Creates
BlobstoreService implementations.Factory provider for
IBlobstoreServiceFactory.Factory for creating a
CapabilitiesService.Factory provider for
ICapabilitiesServiceFactory.This interface should be implemented by providers of the
DatastoreService and registered
with ServiceFactoryFactory.Creates
IDatastoreServiceFactory implementations.Factory provider for
IImagesServiceFactory.Creates
LogService implementations.Factory provider for
ILogServiceFactory.Image represents an image that can be manipulated by the
ImagesService.Image formats usable by the images api.
The images service provides methods to apply transformations to images.
Valid output encoding formats usable for image transforms.
ImagesServiceFailureException is thrown when any unknown
error occurs while communicating with the images service.Factory for creating a
MailService.Factory provider for
IMailServiceFactory.The factory by which users acquire a handle to the MemcacheService.
Factory provider for
IMemcacheServiceFactory.An instant messaging handle.
Supported IM schemes.
Makes immutable copies of collections using only standard Java classes.
Factory interface for use by providers of
ModulesService for
registration with ServiceFactoryFactory.Google App Engine's
FactoryProvider for IModulesServiceFactory.Describes the various policies the datastore can follow for implicit transaction management.
A Datastore
Index definition.Indicates the state of the
Index.An indexed property.
Checks values of
Indexes.Represents information about an index.
A builder of IndexSpec.
Helper class to translate between
Index to OnestoreEntity.Index.InputSettings represents the different settings to specify how
an Image is interpreted by a transform.Actions to take with respect to correcting image orientation based
on image metadata.
Internal task queue error.
InternalTransientException is thrown when
a temporary error occurs in retrieving the URL.InvalidOAuthParametersException is thrown when a request is a
malformed OAuth request (for example, it omits a required parameter or
contains an invalid signature).InvalidOAuthTokenException is thrown when a request contains an
invalid OAuth token (for example, a token that has been revoked by the user).Mismatch of task method and queue mode. e.g.
Log errors caused by an invalid request due either to an out of range option
or an unsupported combination of options.
Thrown when a cache entry has content, but it cannot be read.
Creates an OAuthService.
Factory provider for
IOAuthServiceFactory.Creates
Queue objects.Factory provider for
IQueueFactory.The factory by which users acquire a handle to the QuotaService.
Factory provider for
IQuotaServiceFactory.A factory that creates default implementation of
SearchService.Factory provider for
ISearchServiceFactory.Factory for
URLFetchServiceFactory provider for
IURLFetchServiceFactory.This interface should be implemented by providers of the
UserService and registered with
ServiceFactoryFactory.Creates
IUserServiceFactory implementations.Remote API servlet handler for Jarkata EE APIs.
Exception for unknown errors from a Python remote_api handler.
Deprecated.
as of version 3.0, use
JdbcMySqlConnectionCleanupFilter instead.Filter to cleanup any SQL connections that were opened but not closed during the
HTTP-request processing.
Filter to cleanup any SQL connections that were opened but not closed during the
HTTP-request processing.
The primary key for a datastore entity.
This class enables direct creation of
Key objects, both in the root entity group (no
parent) and as the child of a given parent.Helper class that aids in the construction of
Keys with ancestors.Represents a range of unique datastore identifiers from
getStart().getId() to
getEnd().getId() inclusive.Contains various options for lease requests following the builder pattern.
Provides static creation methods for
LeaseOptions.A
Link is a URL of limited length.The default error handler, which will cause most service errors to behave
as though there were a cache miss, not an error.
Allows users to customize the behavior of
LogService.fetch(LogQuery).Contains static creation methods for
LogQuery.Specifies a version of a module.
An object that is the result of performing a LogService.fetch() operation.
LogService allows callers to request the logs for an application
using supplied filters.Log errors apart from InvalidRequestException.
Creates
LogService implementations.The
MailService provides a way for user code to send emails
to arbitrary destinations.Messages are prepared by the caller, and then submitted to the Mail service
for sending.
Factory for creating a
MailService.Assigns a document score based on frequency of terms in TextFields and HTMLFields.
A builder that constructs
MatchScorers.Static serialization helpers used by
MemcacheServiceImpl
This class is thread-safe.Values used as flags on the MemcacheService's values.
Tuple of a serialized byte array value and associated flags to interpret
that value.
The Java API for the App Engine Memcache service.
A holder for compare and set values.
Encapsulates an Object that is returned by
MemcacheService.getIdentifiable(java.lang.Object)....
Cache replacement strategies for
MemcacheService.put(java.lang.Object, java.lang.Object, com.google.appengine.api.memcache.Expiration, com.google.appengine.api.memcache.MemcacheService.SetPolicy) operations,
indicating how to handle putting a value that already exists.An exception for backend non-availability or similar error states which
may occur, but are not necessarily indicative of a coding or usage error
by the application.
The factory by which users acquire a handle to the MemcacheService.
Exception thrown by the
ModulesService.ModulesService allows the application to fetch information about its
own module and version information.
Factory by which users get an implementation of the
ModulesService.Deprecated.
as of version 3.0, use
MultipartMimeUtils instead.MultipartMimeUtils is a collection of static utility clases
that facilitate the parsing of multipart/form-data and
multipart/mixed requests using the MimeMultipart class
provided by JavaMail.MultipartMimeUtils is a collection of static utility clases
that facilitate the parsing of multipart/form-data and
multipart/mixed requests using the MimeMultipart class
provided by JavaMail.Provides functions for manipulating the current namespace used for
App Engine APIs.
Reources for namespaces used by front end and back end.
OAuthRequestException is thrown when a request is not a valid OAuth
request.The OAuthService provides methods useful for validating OAuth requests.
Creates an OAuthService.
OAuthServiceFailureException is thrown when any unknown error occurs
while communicating with the OAuth service.The result of an operation involving the search service.
OutputSettings represents the different settings to specify how
a particular transform or composite will return an Image.Deprecated.
as of version 3.0, use
ParseBlobUploadFilter instead.ParseBlobUploadFilter is responsible for the parsing
multipart/form-data or multipart/mixed requests used to make Blob
upload callbacks, and storing a set of string-encoded blob keys as
a servlet request attribute.ParseBlobUploadFilter is responsible for the parsing
multipart/form-data or multipart/mixed requests used to make Blob
upload callbacks, and storing a set of string-encoded blob keys as
a servlet request attribute.A helper class that holds various, state-less utility
functions used by the query parser.
A human-readable phone number.
A human-readable mailing address.
Identifies a callback method to be invoked after an
Entity of any of the specified kinds
is deleted from the datastore.Identifies a callback method to be invoked after an
Entity of any of the specified kinds
is loaded from the datastore.Concrete
CallbackContext implementation that is specific to intercepted operations that
load Entities, currently get and "query".Identifies a callback method to be invoked after an
Entity of any of the specified kinds
is written to the datastore.Simple static methods to be called at the start of your own methods to verify correct arguments
and state.
Identifies a callback method to be invoked before an
Entity of any of the specified kinds
is deleted from the datastore.Identifies a callback method to be invoked before an
Entity of any of the specified kinds
is fetched from the datastore via a get() rpc.Concrete
CallbackContext implementation that is specific to intercepted get() operations.Contains methods for fetching and returning entities from a
Query.Indicates that too many results were found for
PreparedQuery.asSingleEntity().Identifies a callback method to be invoked before an
Entity of any of the specified kinds
is written to the datastore.Identifies a callback method to be invoked before a
Query for any of the specified kinds
is executed against the datastore.Concrete
CallbackContext implementation that is specific to intercepted queries.A query projection.
A mutable property container.
A property projection.
An enum for all of the Onestore property types.
PublicCertificate contains an x509 public certificate in PEM format and a string which is
used to identify this certificate.Concrete
CallbackContext implementation that is specific to put() callbacks.Thrown to indicate that a search service failure occurred while putting
objects into the index.
Represents a result of putting a list of objects (documents or queries)
into an index.
A query to search an index for documents which match,
restricting the document fields returned to those given, and
scoring and sorting the results, whilst supporting pagination.
A builder which constructs Query objects.
A
Query.Filter that combines several sub filters using a Query.CompositeFilterOperator.Operators supported by
Query.CompositeFilter.The base class for a query filter.
Operators supported by
Query.FilterPredicate.A
Query.Filter on a single property.A geographic region intended for use in a
Query.StContainsFilter.A geographical region representing all points within a fixed distance from a central point,
i.e., a circle.
A simple geographical region bounded by two latitude lines, and two longitude lines, i.e., a
"rectangle".
SortDirection controls the order of a sort.
SortPredicate is a data container that holds a single sort predicate.
A
Query.Filter representing a geo-region containment predicate.Checks values of
Query.This class performs
DocumentPb.Document validity checks for search customers that only
use the query API.Represents options which control where and what in the search results to return, from restricting
the document fields returned to those given, and scoring and sorting the results, whilst
supporting pagination.
A builder which constructs QueryOptions objects.
Checks values of
QueryOptions.A factory which produces
QueryParsers for a given
token rewrite stream.A class that produces
QueryResultIterators.A class that iterates through the results of a
QueryA list of results returned by executing a
Query.A generator of AST representation of a query.
The base class for specific query tree context used by the walker.
Enumeration of the kind of the term that has a given return
type.
Enumeration of text terms rewrite mode.
Enumeration of supported return types.
A parsing exception thrown when the tree resulting from
parsing a query is in some sense invalid.
Defines an interface of the visitor invoked by the walker.
The walking of the query tree.
Queue is used to manage a task queue.Describes various taskqueue limits.
Creates
Queue objects.Unspecified queue failure.
Queue name mismatch failure.
QueueStatistics allow observation of the rate that tasks on a given queue are being
executed.The
QuotaService provides measurement of API and CPU usage
during requests.Represents all types of data that a QuotaService might be able to provide.
The factory by which users acquire a handle to the QuotaService.
RangeFormatException is an unchecked exception that is thrown
when an invalid Range header format is provided.A user-provided integer rating for a piece of content.
A raw datastore value.
Policy for reads.
Setting the
Consistency for reads allows you to decide whether freshness or
availability is more important.Remote API servlet handler.
Exception for unknown errors from a Python remote_api handler.
Utilities for dealing with repackaged classes.
RequestLogs contain all the log information for a single request.
RequestPayloadTooLargeException is thrown when the payload of a URLFetchService
request is too large.Collection of utility methods for SearchServicePb.RequestStatus.
Thread factory creating threads with a request specific thread local environment.
Assigns a document score based on term frequency weighted on document parts.
A builder that constructs
RescoringMatchScorers.ResponseTooLargeException is thrown when the result of a
URLFetchService operation is too large.Represents a result of executing a search.
Contains various options for a task's retry strategy.
Provides static creation methods for
RetryOptions.A builder which constructs Schema objects.
Represents a document which may have been scored, possibly
some computed expression fields, and a cursor to continue
the search from.
A builder of scored documents.
Contains limits on field values, document sizes, and other properties of objects in the Search
API.
Thrown to indicate that a search service failure occurred.
Thrown to indicate that a search service failure occurred while performing
a search request.
Thrown to indicate that a search query was invalid.
The SearchService is used to get available indexes, which can be
queried about their metadata or have index/delete/search operations
performed on them.
Configuration options for Search API.
Builder for
SearchServiceConfig.Thrown to indicate that a search service failure occurred.
An factory that creates default implementation of
SearchService.This class is not intended for end users.
Specifies the precedence that
ServiceFactoryFactory gives to the annotated FactoryProvider.A helper class for reading and writing Services files.
Allow users to customize the behavior of creating a image serving URL using
the
ImagesService.Contains static creation methods for
ServingUrlOptions.Deprecated.
as of version 3.0, use
SessionCleanupServlet instead.This servlet is run to cleanup expired sessions.
This servlet is run to cleanup expired sessions.
ShortBlob contains an array of bytes no longer than DataTypeUtils.MAX_SHORT_BLOB_PROPERTY_LENGTH.Deprecated.
as of version 3.0, use
SnapshotServlet instead.Servlet invoked for
/_ah/snapshot requests.Servlet invoked for
/_ah/snapshot requests.Sorting specification for a single dimension.
A builder that constructs
SortExpressions.The direction search results are sorted by, either ascending or descending.
Checks the values of a
SortExpression.Definition of how to sort documents.
A builder that constructs
SortOptionss.Checks the values of a
SortOptions.Statistics from the cache, available via
MemcacheService.getStatistics()Status code returned by various index operations.
A strict error handler, which will throw
MemcacheServiceException
or InvalidValueException for any service error condition.Global system properties which are set by App Engine.
The current executing environment.
The set of possible values for Environment.
One or more task names already exists in the queue.
Created from
Queue.add(TaskOptions).Contains various options for a task following the builder pattern.
Provides static creation methods for
TaskOptions.Methods supported by
Queue.Text wraps around a string of unlimited size.ThreadManager exposes a ThreadFactory that allows
App Engine applications to spawn new threads.Minimal implementation of com.google.apphosting.runtime.timer.Timer using only the system clock.
Describes a logical unit of work to be performed against the datastore.
Queue operation failure caused by Datastore exception
Deprecated.
as of version 3.0, use
TransactionCleanupFilter instead.A servlet
Filter that looks for datastore transactions that are
still active when request processing is finished.A servlet
Filter that looks for datastore transactions that are
still active when request processing is finished.TransactionHelper enables the task queue API to serialize a datastore transaction without
knowing the details of how it is implemented.Describes options for transactions, passed at transaction creation time.
Contains static creation methods for
TransactionOptions.The mode of the transaction.
A transform that can be applied to an
Image.Intermittent failure.
UnsupportedRangeFormatException is an unchecked exception that is thrown
when an valid but unsupported Range header format is provided.Attempt to convert String to an unsupported charset.
Allows users to customize the behavior of a single upload to the
BlobstoreService.Contains static creation methods for
UploadOptions.The
URLFetchService provides a way for user code to execute
HTTP requests to external URLs.Factory for
URLFetchServiceAdapts the
URLFetchService to the http and https protocol
handlers for URL.User represents a specific user, represented by the
combination of an email address and a specific Google Apps domain
(which we call an authDomain).The UserService provides information useful for forcing a user to
log in or out, and retrieving information about the user who is
currently logged-in.
Creates a UserService.
UserServiceFailureException is thrown when any unknown
error occurs while communicating with the user service.Deprecated.
as of version 3.0, use
WarmupServlet instead.WarmupServlet does very little.WarmupServlet does very little.
BlobstoreServiceinstead.