Tarefas e propriedades do plug-in Gradle do App Engine

Depois que o plug-in do Gradle para App Engine for adicionado ao projeto, você poderá usar as seguintes tarefas do Gradle específicas do App Engine no Java 8 aplicativo:
Tarefa Descrição
tasks Exibe informações de ajuda sobre as tarefas instaladas.
appengineStage Gera um diretório do aplicativo para implantação.
appengineDeploy Testa e implanta um aplicativo no App Engine.
appengineDeployCron Implanta um arquivo de configuração cron.yaml no App Engine.
appengineDeployDispatch Implanta um arquivo de configuração dispatch.yaml no App Engine.
appengineDeployDos Implanta um arquivo de configuração dos.yaml no App Engine.
appengineDeployIndex Implanta um arquivo de configuração index.yaml no App Engine.
appengineDeployQueue Implanta um arquivo de configuração queue.yaml no App Engine.
jettyRun Executa o servidor de desenvolvimento usando as configurações padrão do Jetty. Para saber mais sobre o plug-in do Gretty, consulte Configuração do Gretty e Tarefas do Gretty (links em inglês)

Para ver uma lista de todas as tarefas:

gradle tasks

Para mais informações sobre como configurar e usar o Gradle, consulte Como usar o Gradle do App Engine e o repositório app-gradle-plugin no GitHub.

Propriedades de tarefa

O conteúdo do arquivo gradle.build é um conjunto de regras para descrever sua versão. Ele é escrito em linguagem específica do domínio para descrever versões com base na linguagem Groovy.

Cada tarefa tem propriedades associadas que podem ser usadas. Especifique essas propriedades no arquivo gradle.build usando uma tarefa de fechamento de configuração (em inglês) e propriedades.

O exemplo a seguir demonstra como especificar tarefas do Gradle para Java 8. Para o Java versão 11 e mais recentes, consulte Java Runtime para mais informações sobre como usar versões mais recentes.

Neste exemplo:

  • O fechamento de configuração do plug-in é appengine.
  • A tarefa é deploy.
  • As propriedades, stopPreviousVersion e promote, são definidas como true.
appengine {
  deploy {   // deploy configuration
    stopPreviousVersion = true  // default - stop the current version
    promote = true              // default - & make this the current version
  }
}
Se você só tem uma tarefa para especificar algumas propriedades, pode defini-las em uma única linha:

  appengine.deploy.stopPreviousVersion = true

Nas seções a seguir, veja uma lista das propriedades disponíveis para cada tarefa.

appengineStage

task(stage)

Gera um diretório do aplicativo para implantação. Usado pelas tarefas appengineDeploy e jettyRun.

Use as seguintes propriedades:

Propriedade Descrição
artifact Artefato criado que contém todas as classes, recursos e manifestos. O padrão é build/libs/[YOUR_SERVLET].war.
appEngineDirectory Local do arquivo app.yaml. O padrão é src/main/appengine.
dockerDirectory Localização de Dockerfile. O padrão é src/main/docker.
stagingDirectory Obrigatório. Diretório onde o aplicativo será testado. O padrão é build/staged-app.

appengineDeploy

task(deploy)

Testa e implanta um aplicativo no App Engine.

Cada tarefa tem propriedades associadas que podem ser usadas. Especifique essas propriedades no arquivo gradle.build usando uma tarefa de fechamento de configuração (em inglês) e propriedades.

No exemplo a seguir:

  • O fechamento de configuração do plug-in é appengine.
  • A tarefa é run.
  • A propriedade, port, está definida como 8080.
appengine {  // App Engine tasks configuration
  run {      // local (dev_appserver) configuration (standard environments only)
    port = 8080                 // default
  }

  deploy {   // deploy configuration
    stopPreviousVersion = true  // default - stop the current version
    promote = true              // default - & make this the current version
  }
}

Se você só tem uma tarefa para especificar algumas propriedades, pode defini-las em uma única linha:

  appengine.run.port = 8888
Propriedade Descrição
appEngineDirectory Local dos arquivos de configuração .yaml (cron, index etc.) de onde as implementações específicas de configuração (appengineDeployCron etc.) serão implantadas. Para aplicativos flexíveis, o padrão é src/main/appengine.
bucket bucket do Cloud Storage usado para testar arquivos associados à implantação. Se esse argumento não for especificado, será usado o bucket padrão do aplicativo.
deployables Arquivos YAML dos serviços ou configurações que você quer implantar. O padrão é o arquivo app.yaml no diretório de preparo. Se ele não for encontrado, tentará gerar automaticamente os arquivos de configuração necessários (como app.yaml) no diretório de preparo.
imageUrl Implanta com uma imagem Docker específica. O URL do Docker precisa ser de um dos nomes de host válidos do Artifact Registry.
project Nome do projeto do Google Cloud Platform para uso nesta invocação. O padrão é o projeto atual selecionado no momento da inicialização da ferramenta gcloud. Para verificar, use gcloud config list project.
promote Promote the deployed version to receive all traffic. O padrão é True.
server Servidor do App Engine ao qual conectar-se. Normalmente, você não precisa alterar esse valor.
stopPreviousVersion Interromper a versão anteriormente em execução ao implantar uma versão nova que recebe todo o tráfego.
version Versão do app que será criada ou substituída por esta implantação. Se você não especificar uma versão, será gerado um número de versão automaticamente.

Propriedades globais

PropriedadeDescrição
tools.cloudSdkHome Propriedade opcional para configurar o local da Google Cloud CLI. Normalmente, o plug-in encontra essa propriedade no CLI gcloud quando é instalado com gcloud components install app-engine-java.