Módulo google.appengine.api.modules.modules

Resumo

Exposição de métodos para o controle de serviços (módulos) e versões de um aplicativo.

Os serviços eram conhecidos anteriormente como módulos e os métodos da API ainda refletem essa nomenclatura. Para mais informações e exemplos de código, acesse Como usar a API Modules.

Índice

exception google.appengine.api.modules.modules.Errorsource

Bases: exceptions.Exception

Classe base para erros neste módulo.

exception google.appengine.api.modules.modules.InvalidModuleErrorsource

Bases: google.appengine.api.modules.modules.Error

O módulo não é conhecido pelo sistema.

exception google.appengine.api.modules.modules.InvalidVersionErrorsource

Bases: google.appengine.api.modules.modules.Error

A versão do módulo não é conhecida pelo sistema.

exception google.appengine.api.modules.modules.InvalidInstancesErrorsource

Bases: google.appengine.api.modules.modules.Error

O valor das instâncias não é válido.

exception google.appengine.api.modules.modules.UnexpectedStateErrorsource

Bases: google.appengine.api.modules.modules.Error

Um estado atual inesperado foi encontrado na inicialização/interrupção de um módulo.

exception google.appengine.api.modules.modules.TransientErrorsource

Bases: google.appengine.api.modules.modules.Error

Um erro transitório foi encontrado. Repita a operação.

google.appengine.api.modules.modules.get_current_module_name()source

O nome do módulo da instância atual é retornado.

Se essa for a versão “v1” do módulo “module5” do aplicativo “my-app”, o valor “module5” será retornado.

google.appengine.api.modules.modules.get_current_version_name()source

A versão da instância atual é retornada.

Se essa for a versão “v1” do módulo “module5” para o aplicativo “my-app”, o valor "v1" será retornado.

google.appengine.api.modules.modules.get_current_instance_id()source

O código da instância atual é retornado.

Se essa for a instância 2 da versão “v1” do módulo “module5” para o aplicativo “my-app”, o valor "2" será retornado.

Válido apenas para módulos escalonados automaticamente. Caso contrário, o valor None será retornado.

Retorna

String com o código da instância ou None, se o módulo não for escalonado automaticamente.

google.appengine.api.modules.modules.get_modules()source

Uma lista de todos os módulos do aplicativo é retornada.

Retorna

Lista de strings com os nomes dos módulos associados a este

aplicativo. O módulo 'default' será incluído se existir, assim como o nome do módulo associado à instância em que essa função é chamada.

google.appengine.api.modules.modules.get_versions(module=None)source

Uma lista de versões para um determinado módulo é retornada.

Parâmetros

module – módulo que tem a versão a ser recuperada. Se None, o módulo atual será usado.

Retorna

Lista de strings com os nomes das versões associadas ao módulo. A versão atual também é incluída nesta lista.

Gera

• InvalidModuleError se o módulo não for válido. TransientError se houver

• um problema na busca pelas informações.

google.appengine.api.modules.modules.get_default_version(module=None)source

O nome da versão padrão do módulo é retornada.

Parâmetros

module – módulo que tem a versão padrão a ser recuperada. Se None, o módulo atual será usado.

Retorna

String com o nome da versão padrão do módulo.

Gera

• InvalidModuleError se o módulo não for válido. InvalidVersionError se

• nenhuma versão padrão for encontrada.

google.appengine.api.modules.modules.get_num_instances(module=None, version=None)source

O número de instâncias configuradas para a versão do módulo em questão é retornado.

Válido apenas para módulos fixos. Um erro será exibido para módulos escalonados automaticamente. Esses módulos podem ser compatíveis no futuro.

Parâmetros

• module – string que tem o nome do módulo em que esta informação deve ser buscada. Se None, o módulo da instância atual será usado.

• version – string que tem o nome da versão em que esta informação deve ser buscada. Se None, a versão da instância atual será usada. Se essa versão não existir no outro módulo, será gerado um InvalidVersionError.

Retorna

O número de instâncias configuradas para a versão do módulo.

Gera

InvalidVersionError em caso de entrada inválida.

google.appengine.api.modules.modules.set_num_instances(instances, module=None, version=None)source

Definição do número de instâncias no módulo e na versão.

Parâmetros

• instances – o número de instâncias a serem configuradas.

• module – o módulo que tem o número de instâncias a serem configuradas. Se None, o módulo atual será usado.

• version – a versão que tem o número de instâncias a serem configuradas. Se None, a versão atual será usada.

Gera

• InvalidVersionError se a versão do módulo não for válida, TransientError

• se houver um problema persistindo na alteração.

• TypeError se o tipo de instância especificado for inválido.

google.appengine.api.modules.modules.set_num_instances_async(instances, module=None, version=None)source

Um UserRPC é retornado para definição do número de instâncias na versão do módulo.

Parâmetros

• instances – o número de instâncias a serem configuradas.

• module – o módulo que tem o número de instâncias a serem configuradas. Se None, o módulo atual será usado.

• version – a versão que tem o número de instâncias a serem configuradas. Se None, a versão atual será usada.

Retorna

Um UserRPC para definição do número de instâncias na versão do módulo.

google.appengine.api.modules.modules.start_version(module, version)source

Todas as instâncias da versão do módulo são iniciadas.

Parâmetros

• module – string que tem o nome do módulo a ser afetado.

• version – string que tem o nome da versão do módulo a ser inicializada.

Gera

• InvalidVersionError se a versão do módulo for inválida.

• TransientError se houver um problema persistindo na alteração.

google.appengine.api.modules.modules.start_version_async(module, version)source

Um UserRPC é retornado para a inicialização de todas as instâncias da versão do módulo em questão.

Parâmetros

• module – string que tem o nome do módulo a ser afetado.

• version – string que tem o nome da versão do módulo a ser inicializada.

Retorna

Um UserRPC para a inicialização de todas as instâncias da versão do módulo.

google.appengine.api.modules.modules.stop_version(module=None, version=None)source

Todas as instâncias da versão do módulo são interrompidas.

Parâmetros

• module – o módulo a ser afetado. Se None, o módulo atual será usado.

• version – a versão do módulo a ser afetada. Se None, a versão atual será usada.

Gera

• InvalidVersionError se a versão do módulo for inválida.

• TransientError se houver um problema persistindo na alteração.

google.appengine.api.modules.modules.stop_version_async(module=None, version=None)source

Um UserRPC é retornado para a interrupção de todas as instâncias da versão do módulo.

Parâmetros

• module – o módulo a ser afetado. Se None, o módulo atual será usado.

• version – a versão do módulo a ser afetada. Se None, a versão atual será usada.

Retorna

Um UserRPC para a interrupção de todas as instâncias da versão do módulo em questão.

google.appengine.api.modules.modules.get_hostname(module=None, version=None, instance=None)source

O nome do host a ser usado para entrar em contato com o módulo é retornado.

Parâmetros

• module – o nome do módulo. Se None, o módulo da instância atual será usado.

• version – o nome da versão. Se for None, a versão da instância atual será usada, se essa versão existir para o módulo de destino. Caso contrário, a versão padrão do módulo de destino será usada.

• instance – instância para a criação do nome do host. Se for None, um nome de host com balanceamento de carga para o módulo será retornado. Se o módulo de destino não for fixo, a instância não será considerada válida.

Retorna

Um nome de host canônico válido que pode ser usado para se comunicar com o módulo/versão/instância. Por exemplo: 0.v1.module5.myapp.appspot.com

Gera

• InvalidModuleError – se a versão do módulo for inválida.

• InvalidInstancesError – se o valor da instância especificada for inválido.

• TypeError – se o tipo de instância for inválido.