How-to Guides

Installing the App Engine SDK for Java

• Installing the App Engine SDK for Java

  Download and install the App Engine SDK to build Java applications.

Developing Java Apps on App Engine

• Using the Local Development Server

  Run the development server locally to simulate your application running in production.

• Local Unit Testing Overview

  Run tests inside your own development environment without involving remote components.

• Local Unit Testing Javadoc

  Learn about the packages that provide support for local unit testing.

• Monitoring Latency with Cloud Trace

  Collect latency data from your application and view it in the Google Cloud Platform Console.

• Detecting Outages and Downtime with the Capabilities API

  Reduce downtime in your application by detecting when a capability is unavailable and then bypassing it.

• Configuring Dashboards and Alerts with Cloud Monitoring

  Collect metrics, events, and metadata from Google Cloud Platform to generate insights via dashboards, charts, and alerts.

• Downloading Logs

  Download log data to perform more detailed analysis of your application.

• Integrating with Google Analytics

  Measure user interactions with your business across various devices and environments.

Managing and Configuring Your App

• Deploying Your App

  Use the appconfig command to deploy your app.

• Splitting Traffic

  Distribute traffic across two or more versions of a module to control roll out of features or conduct A/B testing.

• Migrating Traffic

  Gradually move traffic from an old version of a service to a new version of the service.

• Creating a Project and Managing Billing

  Create a Google Cloud Platform project and set up billing.

• Granting Project Access

  Provide role-based access to your Google Cloud Platform project and its resources.

• Using Custom Domains and SSL

  Add a custom domain for your application and optional set up SSL for the custom domain.

• Managing App Resources

  Understand your application's performance and manage the resources your application is using.

• Configuring Your App With appengine-web.xml

  Configure your application's settings.

• Configuring Your Deployments with web.xml

  Create a deployment descriptor file for your application.

• Using the Admin API

  Provision and manage your application using the Admin API.

• Using the Modules API

  Programmatically retrieve information about the current operating environment, modules (now called "services"), or instances.

• Downloading Your Application

  Download your compiled application.

• Index Config

  Create and manage the indexes used in your application.

• Scheduled Tasks

  Configure regularly scheduled tasks to run in your application.

• Task Queue Config

  Define task queues in a configuration file.

Storing Data

• Choosing a Storage Option

  Decide which storage option to use in your app.

• Datastore Overview

  Understand Datastore.

• Creating, Retrieving, Updating, and Deleting Entities

  Store, delete and retrieve entities in Datastore.

• Retrieving Query Results

  Run queries.

• Manage Datastore from the Console

  Manage Datastore from the Console.

• Configuring Datastore Indexes

  Create and manage the indexes used in your application.

• Using Cloud SQL for MySQL

  Store application data from your App Engine app in Cloud SQL for MySQL.

• Using Cloud SQL for Postgres

  Store application data from your App Engine app in Cloud SQL for PostgreSQL.

• Using Cloud SQL for Postgres

  Set up Cloud Storage for your application's use.

• Using Cloud SQL for Postgres

  Store and retrieve data using Cloud Storage in your app.

Superseded Storage Options

• Blobstore Overview

  Understand the Blobstore API.

• JDO 2.3 Overview

  Understand JDO 2.3.

• JDO 3.0 Overview

  Understand JDO 3.0.

• Defining Data Classes with JDO

  Create data classes using JDO.

• Creating, Getting, and Deleting Data in JDO

  Store, retrieve and delete data.

• Entity Relationships in JDO

  Understand entity relationships.

• Queries in JDO

  Run queries.

• JPA 1.0 Overview

  Understand JPA 1.0.

• JPA 2.0 Overview

  Understand JPA 2.0.

Authenticating Users

• User Authentication Options

  Understand the different ways to authenticate users of your application.

• Authenticating Google Accounts

  Learn about the Users API.

Caching Application Data

• Memcache Overview

  Learn about the memcache service.

• Using Memcache

  Set and retrieve cached values.

Connecting to and from Your App

• Issuing HTTP(S) Requests

  Use the URL Fetch service to issue HTTP(S) requests.

• Connecting to a VPC network

  Learn how to use Serverless VPC Access to connect your App Engine standard environment app directly to your VPC.

• Connecting to a Shared VPC network

  Learn how to use Serverless VPC Access to connect your App Engine standard environment app directly to your Shared VPC.

• Outbound IP Addresses

  Learn about the outbound IP addresses App Engine uses.

• Identifying Your App to APIs and Services

  Discover and assert your application's project ID.

Manipulating Images

• Manipulating Images

  Learn about the Images API.

Namespace-enabled Apps

• Namespaces API Overview

  Learn about the Namespaces API.

• Multitenancy with Namespaces

  Enable multitenancy in your application.

Sending Email

• Mail API Overview

  Learn about the Mail API.

• Sending Mail

  Send email from your application.

• Receiving Mail

  Process incoming email.

• Receiving Bounce Notification

  Receive and handle email bounce notifications.

• Mail with Headers or Attachments

  Include attachments or headers in email sent from your application.

Scheduling Work Outside of User Requests

• Scheduling Jobs with cron.xml

  Configure regularly scheduled tasks to run in your application.

• Task Queue API Overview

  Learn about the Task Queue API.

• Configuring Task Queues with queue.xml

  Define task queues in a configuration file.

• Using Push Queues

  Learn about push queues.

• Using Pull Queues

  Learn about pull queues.

• Task Queue REST API Overview

  Learn about the Task Queue REST API.

Searchable Document Indexes

• Documents and Indexes

  Learn about documents and indexes in the Search API.

• Query Strings

  Learn about query strings in the Search API.

• Query and Sorting Options

  Change how results are returned and sorted.

• Handling Search Results

  Handle query results and any exceptions returned by the Search API.

• Faceted Search

  Attach categorical information to your documents.

• Best Practices

  Learn about best practices for using the Search API.

• Using the Java Development Server

  Run the development server locally to emulate the Search API.

Reading and Writing Logs

• Reading and Writing Logs

  Learn how to read request logs and read and write application logs.