REGION_ID is an abbreviated code that Google assigns
based on the region you select when you create your app. The code does not
correspond to a country or province, even though some region IDs may appear
similar to commonly used country and province codes. Including
REGION_ID.r in App Engine URLs is optional for
existing apps and will soon be required for all new apps.
To ensure a smooth transition, we are slowly updating App Engine to use region IDs. If we haven't updated your Google Cloud project yet, you won't see a region ID for your app. Since the ID is optional for existing apps, you don't need to update URLs or make other changes once the region ID is available for your existing apps.
Learn more about region IDs.
This quickstart shows how to deploy a sample app on App Engine. If you want to learn about coding an app for App Engine, see Building an app.
There are no costs associated with running this guide. Running this sample app alone does not exceed your free quota.
Before you beginThis quickstart assumes that you have installed the Java SE 11 Development Kit (JDK).
Before running and deploying this quickstart, install the Cloud SDK and then set up a Cloud project for App Engine:
Download and install Cloud SDK:
gcloud components update
Create a new project:
gcloud projects create [YOUR_PROJECT_ID] --set-as-default
[YOUR_PROJECT_ID]with a string of characters that uniquely identifies your project. For example,
Verify the project was created:
gcloud projects describe [YOUR_PROJECT_ID]
You see project details that might look like the following:
createTime: year-month-hour lifecycleState: ACTIVE name: project-name parent: id: '433637338589' type: organization projectId: project-name-id projectNumber: 499227785679
Initialize your App Engine app with your project and choose its region:
gcloud app create --project=[YOUR_PROJECT_ID]
When prompted, select the region where you want your App Engine application located.
Make sure billing is enabled for your project. A billing account needs to be linked to your project in order for the application to be deployed to App Engine.
Install the following prerequisites:
App Engine locations
App Engine is regional, which means the infrastructure that runs your apps is located in a specific region, and Google manages it so that it is available redundantly across all of the zones within that region.
Meeting your latency, availability, or durability requirements are primary factors for selecting the region where your apps are run. You can generally select the region nearest to your app's users, but you should consider the locations where App Engine is available as well as the locations of the other Google Cloud products and services that your app uses. Using services across multiple locations can affect your app's latency as well as its pricing.
You cannot change an app's region after you set it.
If you already created an App Engine application, you can view its region by doing one of the following:
gcloud app describecommand.
Open the App Engine Dashboard in the Cloud Console. The region appears near the top of the page.
Download the Hello World app
We've created a simple Hello World app for Java 11 so you can quickly get a feel for deploying an app to the Google Cloud.
Clone the Hello World sample app repository to your local machine.
git clone https://github.com/GoogleCloudPlatform/java-docs-samples
Alternatively, you can download the sample as a zip file and extract it.
Change to the directory that contains the sample code.
Run Hello World on your local machine
To run the Hello World app on your local computer:
- Start a local web server using the Spring Boot Maven plugin.
In your web browser, enter the following address:http://localhost:8080
The Hello World message from the sample app displays on the page. In your terminal window, press Ctrl+C to exit the web server.
Deploy and run Hello World on App EngineTo deploy your app to the App Engine standard environment:
Deploy the Hello World app by running the following command from the
gcloud app deploy
Learn about the optional flags.
--versionflag to specify an ID that uniquely identifies that version of your app, otherwise one is generated for you. Example:
--projectflag to specify an alternate Cloud project ID to what you initialized as the default in the
gcloud app deploy --version pre-prod-5 --project my-sample-app
- Include the
Launch your browser to view the app at
gcloud app browsewhere
PROJECT_IDrepresents your Google Cloud project ID.
This time, the page that displays the Hello World message is delivered by a web server running on an App Engine instance.
Congratulations! You've deployed your first Java 11 app to App Engine standard environment!
See the following sections for information about cleaning up as well as links to possible next steps that you can take.
To avoid incurring charges, you can delete your Cloud project to stop billing for all the resources used within that project.
- In the Cloud Console, go to the Manage resources page.
- In the project list, select the project that you want to delete and then click Delete delete.
- In the dialog, type the project ID and then click Shut down to delete the project.
Learn the whole platform
Now that you know what it's like to develop and deploy App Engine apps, you can explore the rest of Google Cloud. You already have the Cloud SDK installed which gives you the tools to interact with products like Cloud SQL, Cloud Storage, Firestore, and more.
Learn about the App Engine standard environment
Here are some topics to help continue your learning about App Engine: