ModulesService (Google App Engine API for Java)

com.google.appengine.api.modules

Interface ModulesService



  • public interface ModulesService
    ModulesService allows the application to fetch information about its own module and version information. Additionally, the service has the ability to start, stop and change the number of instances associated with a module version.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      java.lang.String getCurrentInstanceId()
      Get the id of the current instance.
      java.lang.String getCurrentModule()
      Get the name of the current module.
      java.lang.String getCurrentVersion()
      Get the name of the current version.
      java.lang.String getDefaultVersion(java.lang.String module)
      Returns the name of the default version for the module.
      java.lang.String getInstanceHostname(java.lang.String module, java.lang.String version, java.lang.String instance)
      Returns a host name to use for the given module, version and instance.
      java.util.Set<java.lang.String> getModules()
      Get the set of modules that are available to the application.
      int getNumInstances(java.lang.String module, java.lang.String version)
      Returns the number of instances that are available to the given manual scaling module version.
      java.lang.String getVersionHostname(java.lang.String module, java.lang.String version)
      Returns a host name to use for the given module and version.
      java.util.Set<java.lang.String> getVersions(java.lang.String module)
      Returns the set of versions that are available to the given module.
      void setNumInstances(java.lang.String module, java.lang.String version, long instances)
      Set the number of instances that are available to the given manual scaling module version.
      java.util.concurrent.Future<java.lang.Void> setNumInstancesAsync(java.lang.String module, java.lang.String version, long instances)
      Starts an asynchronous call to setNumInstances(java.lang.String, java.lang.String, long) and returns a Future to obtain its eventual result.
      void startVersion(java.lang.String module, java.lang.String version)
      Starts the given manual scaling or basic scaling module version.
      java.util.concurrent.Future<java.lang.Void> startVersionAsync(java.lang.String module, java.lang.String version)
      Starts an asynchronous call to startVersion(java.lang.String, java.lang.String) and returns a Future to obtain its eventual result.
      void stopVersion(java.lang.String module, java.lang.String version)
      Stops the given manual scaling or basic scaling module version.
      java.util.concurrent.Future<java.lang.Void> stopVersionAsync(java.lang.String module, java.lang.String version)
      Starts an asynchronous call to stopVersion(java.lang.String, java.lang.String) and returns a Future to obtain its eventual result.
    • Method Detail

      • getCurrentModule

        java.lang.String getCurrentModule()
        Get the name of the current module. ("default" if modules are not enabled for this app)
        Returns:
        the name of the module
      • getCurrentVersion

        java.lang.String getCurrentVersion()
        Get the name of the current version.
        Returns:
        the name of the version
      • getCurrentInstanceId

        java.lang.String getCurrentInstanceId()
        Get the id of the current instance.
        Returns:
        current instance id
      • getModules

        java.util.Set<java.lang.String> getModules()
        Get the set of modules that are available to the application.
        Returns:
        Set of modules available to the application
        Throws:
        ModulesException - when ModulesService fails to perform the requested operation.
      • getVersions

        java.util.Set<java.lang.String> getVersions(java.lang.String module)
        Returns the set of versions that are available to the given module.
        Parameters:
        module - the name of the module or null for the current module
        Throws:
        ModulesException - when ModulesService fails to perform the requested operation.
      • getDefaultVersion

        java.lang.String getDefaultVersion(java.lang.String module)
        Returns the name of the default version for the module.
        Parameters:
        module - the name of the module or null for the current module
        Throws:
        ModulesException - when ModulesService fails to perform the requested operation.
      • getNumInstances

        int getNumInstances(java.lang.String module,
                            java.lang.String version)
        Returns the number of instances that are available to the given manual scaling module version.
        Parameters:
        module - the name of the module or null for the current module
        version - the name of the version or null for the current version
        Throws:
        ModulesException - when ModulesService fails to perform the requested operation.
      • setNumInstances

        void setNumInstances(java.lang.String module,
                             java.lang.String version,
                             long instances)
        Set the number of instances that are available to the given manual scaling module version. Changing the number of instances is an asynchronous process so this may return before added instances begin serving or removed instances stop serving.
        Parameters:
        module - the name of the module or null for the current module
        version - the name of the version or null for the current version
        instances - the number of instances to set
        Throws:
        ModulesException - when the requested number of instances is not supported or ModulesService fails to perform the requested operation for some other reason.
      • setNumInstancesAsync

        java.util.concurrent.Future<java.lang.Void> setNumInstancesAsync(java.lang.String module,
                                                                         java.lang.String version,
                                                                         long instances)
        Starts an asynchronous call to setNumInstances(java.lang.String, java.lang.String, long) and returns a Future to obtain its eventual result. When the returned Future yields a successful result ModulesService will have successfully initiated the process of setting the number of instances. There may be some delay before added instances start serving or removed instances stop serving.
      • startVersion

        void startVersion(java.lang.String module,
                          java.lang.String version)
        Starts the given manual scaling or basic scaling module version. Starting a version is an asynchronous process so this may return before the started version is serving. If the requested module version is already started this returns without error.
        Parameters:
        module - the name of the module
        version - the name of the version
        Throws:
        ModulesException - when ModulesService fails to perform the requested operation.
      • startVersionAsync

        java.util.concurrent.Future<java.lang.Void> startVersionAsync(java.lang.String module,
                                                                      java.lang.String version)
        Starts an asynchronous call to startVersion(java.lang.String, java.lang.String) and returns a Future to obtain its eventual result. When the returned Future yields a successful result ModulesService will have successfully initiated the process of starting the requested version. There may be some delay before the version starts serving.
      • stopVersion

        void stopVersion(java.lang.String module,
                         java.lang.String version)
        Stops the given manual scaling or basic scaling module version. Stopping a version is an asynchronous process so this may return before the stopped version stops serving. If the requested module version is already stopped this returns without error.
        Parameters:
        module - the name of the module or null for the current module
        version - the name of the version or null for the current version
        Throws:
        ModulesException - when ModulesService fails to perform the requested operation.
      • stopVersionAsync

        java.util.concurrent.Future<java.lang.Void> stopVersionAsync(java.lang.String module,
                                                                     java.lang.String version)
        Starts an asynchronous call to stopVersion(java.lang.String, java.lang.String) and returns a Future to obtain its eventual result. When the returned Future yields a successful result ModulesService will have successfully initiated the process of stopping the requested version. There may be some delay before the version stops serving.
      • getVersionHostname

        java.lang.String getVersionHostname(java.lang.String module,
                                            java.lang.String version)
        Returns a host name to use for the given module and version.
        Parameters:
        module - the name of the module or null to indicate the current module
        version - the name of the version or null to indicate the current version
        Throws:
        ModulesException - when ModulesService fails to perform the requested operation.
      • getInstanceHostname

        java.lang.String getInstanceHostname(java.lang.String module,
                                             java.lang.String version,
                                             java.lang.String instance)
        Returns a host name to use for the given module, version and instance.
        Parameters:
        module - the name of the module or null to indicate the current module
        version - the name of the version or null to indicate the current version
        instance - the id of a particular instance to address
        Returns:
        the hostname of the given instance
        Throws:
        ModulesException - when ModulesService fails to perform the requested operation.

Monitor your resources on the go

Get the Google Cloud Console app to help you manage your projects.

Send feedback about...

App Engine standard environment for Java