GoogleCloudPlatform/appengine-plugins-core

Name: appengine-plugins-core

Owner: Google Cloud Platform

Description: A client Java library to manage App Engine Java applications for any project that performs App Engine Java application management. For example, the Maven, Gradle and Eclipse App Engine plugins, custom user tools, etc.

Created: 2016-03-17 13:42:30.0

Updated: 2018-05-22 18:08:34.0

Pushed: 2018-05-24 12:29:37.0

Homepage:

Size: 1219

Language: Java

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

Google App Engine Plugins Core Library

IMPORTANT: This library is used by Google internal plugin development teams to share App Engine related code. Its use for any other purpose is highly discouraged and unsupported. Visit our App Engine documentation for more information on Google supported clients for App Engine administration.

Requirements

This library requires Java 1.8 or higher to run. This library requires Maven and Java 1.8 or higher to build.

You must also install the Cloud SDK command line interface (CLI), if it isn't installed yet, following the instructions.

You must also install the app-engine-java component:

gcloud components install app-engine-java

Supported operations

The library implements the following operations:

• Deploy an application to standard or flexible environment
• Stage an application for deployment
• Run an application on the local server synchronously or asynchronously

How to use

Build the library using the “mvn clean install” command at the repository root directory, where the pom.xml file is located. This produces the appengine-plugins-core-version-SNAPSHOT.jar file in the “target” directory that you can add to your application's class path.

To deploy a new version, a client calls the library in the following way:

ll operations require the cloud SDK
dSdk cloudSdk = new CloudSdk.Builder().sdkPath(some-path).javaHome(some-java-home).build();


perations that use gcloud command line are initiated by the Gcloud object.
ud gcloud = Gcloud.builder(sdk).setMetricsEnvironment("asdf","12").setCredentialFile(some-file).build()

imilarly for AppCfg and the DevAppServer
fg appcfg = AppCfg.builder(sdk).build()
lRun localRun = LocalRun.builder(sdk).build()

perations are started as processes, access to these processes is handled
y implementations of ProcessHandler. To continue to interface with processes
s before, use LegacyProcessHandler.
essHandler handler = LegacyProcessHandler.builder()...configureHandler...build();
ud.newDeployment(handler).deploy(myDeployConfiguration);

SDK Manager

This library provides a mechanism for installing, adding components and updating the Cloud SDK. The operations are intended to run asynchronously, either on an executor or through mechanisms provided by an IDE.

reate a new Managed SDK instance
gedCloudSdk sdk = ManagedCloudSdk.newManagedSdk("123.123.123") // SDK fixed at version.
gedCloudSdk sdk = ManagedCloudSdk.newManagedSdk() // 'LATEST' sdk, can be updated.

mplement the listener interface to listen to operation output
ageListener listener = new MessageListener() {...};

lways check if operations are needed before running them
!sdk.isInstalled()) {
k.newInstaller().install(listener);


se SdkComponent to reference a Cloud Sdk component
!sdk.hasComponent(SdkComponent.APP_ENGINE_JAVA)) {
k.newComponentInstaller().installComponent(SdkComponent.APP_ENGINE_JAVA, listener);


pdates will only occur on 'LATEST' sdks
!sdk.isUpToDate) {
k.newUpdater().update(listener);


ou can then create an SDK from a managed SDK instance
CloudSdk.Builder().sdkPath(sdk.getSdkHome())...;