/java-docs-samples

Java and Kotlin Code samples used on cloud.google.com

Primary LanguageJavaApache License 2.0Apache-2.0

Google Cloud Platform Java Samples

Build Status Build Status Build Status

Open in Cloud Shell

This repository holds sample code written in Java that demonstrates the Google Cloud Platform.

Some samples have accompanying guides on <cloud.google.com>. See respective README files for details.

Google Cloud Samples

To browse ready to use code samples check Google Cloud Samples.

Set Up

  1. Set up your Java Development Environment

  2. Clone this repository:

     git clone https://github.com/GoogleCloudPlatform/java-docs-samples.git

  3. Obtain authentication credentials.

    Create local credentials by running the following command and following the oauth2 flow (read more about the command here):

     gcloud auth application-default login

    Or manually set the GOOGLE_APPLICATION_CREDENTIALS environment variable to point to a service account key JSON file path.

    Learn more at Setting Up Authentication for Server to Server Production Applications.

    Note: Application Default Credentials is able to implicitly find the credentials as long as the application is running on Compute Engine, Kubernetes Engine, App Engine, or Cloud Functions.

Contributing

Licensing

Supported Java runtimes

Every submitted change has to pass all checks that run on the testing environments with Java 11 and Java 17 runtimes before merging the change to the main branch. We run periodic checks on the environments with Java 8 and Java 21 runtimes but we don't enforce passing these tests at the moment. Because Java 8 is a supported Java runtime in Google Cloud, please configure to build your code sample with Java 8. In exceptional cases, configure to build your code sample using Java 11.

Source Code Headers

Every file containing source code must include copyright and license information. This includes any JS/CSS files that you might be serving out to browsers. (This is to help well-intentioned people avoid accidental copying that doesn't comply with the license.)

Apache header:

Copyright 2022 Google LLC

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Java is a registered trademark of Oracle and/or its affiliates.