google.appengine.api.appinfo module

Returns the result of merging two AdminConsole objects.

Merges the non-referential state of the provided AppInclude.

That is, builtins and includes directives are not preserved, but any static objects are copied into an aggregate AppInclude object that preserves the directives of both provided AppInclude objects.

appinclude_one is updated to be the merged result in this process.

• appinclude_one – First AppInclude to merge.

• appinclude_two – Second AppInclude to merge.

AppInclude object that is the result of merging the static directives of appinclude_one and appinclude_two. An updated version of appinclude_one is returned.

Merges an app.yaml file with referenced builtins/includes.

• appyaml – The app.yaml file that you want to update with appinclude.

• appinclude – The includes that you want to merge into appyaml.

An updated app.yaml file that includes the directives you specified in appinclude.

Takes the greater of <manual_scaling.instances> from the arguments.

appinclude_one is mutated to be the merged result in this process.

Also, this function must be updated if ManualScaling gets additional fields.

• appinclude_one – The first object to merge. The object must have a manual_scaling field that contains a ManualScaling().

• appinclude_two – The second object to merge. The object must have a manual_scaling field that contains a ManualScaling().

An object that is the result of merging appinclude_one.manual_scaling.instances and appinclude_two.manual_scaling.instances; this is returned as a revised appinclude_one object after the mutations are complete.

Merges two skip_files directives.

• skip_files_one – The first skip_files element that you want to merge.

• skip_files_two – The second skip_files element that you want to merge.

A list of regular expressions that are merged.

Unique identifier for application.

Application’s major version.

Runtime used by application.

Which version of APIs to use.

Optional specification of the source language. For example, you could specify php-quercus if this is a Java app that was generated from PHP source using Quercus.

List of URL handlers.

Default time delta to use for cache expiration for all static files, unless they have their own specific expiration set. See the documentation for the URLMap.expiration field for more information.

A regular expression object. Files that match this regular expression will not be uploaded by appcfg.py. For example:

skip_files:|.svn.*|#.*#

A regular expression object. Files that match this regular expression will not be built into the app. This directive is valid for Go only.

URL root and script or servlet path for enhanced API serving.

Applies settings from the indicated backend to the AppInfoExternal.

Backend entries can contain directives that modify other parts of the app.yaml file, such as the start directive, which adds a handler for the start request. This method performs those modifications.

backend_name – The name of a backend that is defined in the backends directive.

• BackendNotFound – If the indicated backend was not listed in the backends directive.

• DuplicateBackend – If the backend is found more than once in the backends directive.

Performs non-regular expression-based validation.

The following are verified:

• At least one URL mapping is provided in the URL mappers.

• The number of URL mappers doesn’t exceed MAX_URL_MAPS.

• The major version does not contain the string -dot-.

• If api_endpoints are defined, an api_config stanza must be defined.

• If the runtime is python27 and threadsafe is set, then no CGI handlers can be used.

• The version name doesn’t start with BUILTIN_NAME_PREFIX.

• If redirect_http_response_code exists, it is in the list of valid 300s.

• Module and service aren’t both set. Services were formerly known as modules.

• DuplicateLibrary – If library_name is specified more than once.

• MissingURLMapping – If no URLMap object is present in the object.

• TooManyURLMappings – If there are too many URLMap entries.

• MissingApiConfig – If api_endpoints exists without an api_config.

• MissingThreadsafe – If threadsafe is not set but the runtime requires it.

• ThreadsafeWithCgiHandler – If the runtime is python27, threadsafe is set and CGI handlers are specified.

• TooManyScalingSettingsError – If more than one scaling settings block is present.

• RuntimeDoesNotSupportLibraries – If the libraries clause is used for a runtime that does not support it, such as python25.

Returns a list of all Library instances active for this configuration.

The list of active Library instances for this configuration. This includes directly-specified libraries as well as any required dependencies.

Returns the app’s runtime, resolving VMs to the underlying vm_runtime.

The value of beta/vm_settings.vm_runtime if runtime is vm, or runtime otherwise.

The effective runtime

Returns a list of normalized Library instances for this configuration.

The list of active Library instances for this configuration. This includes directly-specified libraries, their required dependencies, and any libraries enabled by default. Any libraries with latest as their version will be replaced with the latest available version.

Normalizes VM settings.

Sets the runtime while respecting vm runtimes rules for runtime settings.

runtime – The runtime to use.

Merges two BetaSettings instances.

• beta_settings_one – The first BetaSettings instance, or None.

• beta_settings_two – The second BetaSettings instance, or None.

The merged BetaSettings instance, or None if both input instances are None or empty.

Bases: dict

Provides a dictionary object that will always claim to have a key.

This dictionary returns a fixed value for any get operation. The fixed value that you pass in as a constructor parameter should be a validation.Validated object.

Finds if a builtin is defined in a given list of builtin handler objects.

• builtins_list – A list of BuiltinHandler objects, typically yaml.builtins.

• builtin_name – The name of the built-in that you want to determine whether it is defined.

True if builtin_name is defined by a member of builtins_list; all other results return False.

Converts a list of BuiltinHandler objects.

builtins_list – A list of BuildinHandler objects to convert to tuples.

A list of (name, status) that is derived from the BuiltinHandler objects.

Converts a BuiltinHander object to a dictionary.

on/off}` form

A dictionary in `{builtin_handler_name

Verifies that all BuiltinHandler objects are valid and not repeated.

• builtins_list – A list of BuiltinHandler objects to validate.

• runtime – If you specify this argument, warnings are generated for built-ins that have been deprecated in the given runtime.

• InvalidBuiltinFormat – If the name of a BuiltinHandler object cannot be determined.

• DuplicateBuiltinsSpecified – If a BuiltinHandler name is used more than once in the list.

Determines if the CustomMetric is not valid.

• appinfo_errors.TooManyAutoscalingUtilizationTargetsError – If too many

• scaling targets are set.

• appinfo_errors.NotEnoughAutoscalingUtilizationTargetsError – If no scaling

• targets are set.

Determines if the Endpoints API Service is not valid.

• appinfo_errors.MissingEndpointsConfigId – If the config id is missing when the rollout strategy is unspecified or set to “fixed”.

• appinfo_errors.UnexpectedEndpointsConfigId – If the config id is set when the rollout strategy is “managed”.

Merges two EnvironmentVariables instances.

If a variable is specified by both instances, the value from env_variables_two is used.

• env_variables_one – The first EnvironmentVariables instance or None.

• env_variables_two – The second EnvironmentVariables instance or None.

The merged EnvironmentVariables instance, or None if both input instances are None or empty.

alias of str

Gets a header value.

header_name – HTTP header name to look for.

A header value that corresponds to header_name. If more than one such value is in self, one of the values is selected arbitrarily and returned. The selection is not deterministic.

Bases: google.appengine.api.validation.Validator

Ensures that keys in HttpHeadersDict are valid.

HttpHeadersDict contains a list of headers. An instance is used as HttpHeadersDict’s KEY_VALIDATOR.

Bases: google.appengine.api.validation.Validator

Ensures that values in HttpHeadersDict are valid.

An instance is used as HttpHeadersDict’s VALUE_VALIDATOR.

Determines if the library configuration is not valid.

• appinfo_errors.InvalidLibraryName – If the specified library is not supported.

• appinfo_errors.InvalidLibraryVersion – If the specified library version is not supported.

alias of str

Specifies whether a user should be logged in to access a URL. The default value of this argument is optional.

Sets the restriction on the protocol that can be used to serve this URL or handler. This value can be set to HTTP, HTTPS or either.

Specifies a regular expression that is used to fully match against the request URLs path. See the “Special cases” section of this document to learn more.

Specifies the handler ID attribute that maps url to the appropriate file. You can specify regular expression backreferences to the string matched to url.

Specifies the regular expression that is used by the application configuration program to determine which files are uploaded as blobs. Because it is difficult to determine this information using just the url and static_files arguments, this attribute must be included. This attribute is required when you define a static_files mapping. A matching file name must fully match against the upload regular expression, similar to how url is matched against the request path. Do not begin the upload argument with the ^ character or end it with the $ character.

Specifies the handler ID that maps the provided url to a sub-directory within the application directory. See “Special cases.”

When used with static_files and static_dir, this argument specifies that the MIME type of the files that are served from those directories must be overridden with this value.

Specifies the handler ID that maps URLs to a script handler within the application directory that will run using CGI.

Used in AppInclude objects to specify whether a handler should be inserted at the beginning of the primary handler list or at the end. If tail is specified, the handler is inserted at the end; otherwise, the handler is inserted at the beginning. This behavior implies that head is the effective default.

When used with static files and directories, this argument specifies the time delta to use for cache expiration. This argument should use the following format: 4d 5h 30m 15s, where each letter signifies days, hours, minutes, and seconds, respectively. The s for “seconds” can be omitted. Only one amount must be specified, though combining multiple amounts is optional. The following list contains examples of values that are acceptable: 10, 1d 6h, 1h 30m, 7d 7d 7d, 5m 30.

Specifies the handler ID that identifies an endpoint as an API endpoint. Calls that terminate here will be handled by the API serving framework.

Makes sure that self.http_headers is consistent with self.mime_type.

This method assumes that self is a static handler, either self.static_dir or self.static_files. You cannot specify None.

appinfo_errors.ContentTypeSpecifiedMultipleTimes – If self.http_headers

contains a Content-Type header, and self.mime_type is set. For example, the following configuration would be rejected:

handlers:-url:/staticstatic_dir:staticmime_type:text/htmlhttp_headers:content-type:text/html

As this example shows, a configuration will be rejected when http_headers and mime_type specify a content type, even when they specify the same content type.

Adds additional checking to make sure a handler has correct fields.

In addition to normal ValidatedCheck, this method calls GetHandlerType, which validates whether all of the handler fields are configured properly.

• UnknownHandlerType – If none of the handler ID attributes are set.

• UnexpectedHandlerAttribute – If an unexpected attribute is set for the discovered handler type.

• HandlerTypeMissingAttribute – If the handler is missing a required attribute for its handler type.

• ContentTypeSpecifiedMultipleTimes – If mime_type is inconsistent with http_headers.

Raises an error if position is specified outside of AppInclude objects.

PositionUsedInAppYamlHandler – If the position attribute is specified for an app.yaml file instead of an include.yaml file.

Forces omitted secure handler fields to be set to ‘secure: optional’.

The effect is that handler.secure is never equal to the nominal default.

Gets the handler for a mapping.

The value of the handler, as determined by the handler ID attribute.

Gets the handler type of a mapping.

The handler type as determined by which handler ID attribute is set.

• UnknownHandlerType – If none of the handler ID attributes are set.

• UnexpectedHandlerAttribute – If an unexpected attribute is set for the discovered handler type.

• HandlerTypeMissingAttribute – If the handler is missing a required attribute for its handler type.

• MissingHandlerAttribute – If a URL handler is missing an attribute.

Generates a warning for reserved URLs.

See the version element documentation to learn which URLs are reserved.

Merges two VmSettings instances.

If a variable is specified by both instances, the value from vm_settings_one is used.

• vm_settings_one – The first VmSettings instance, or None.

• vm_settings_two – The second VmSettings instance, or None.

The merged VmSettings instance, or None if both input instances are None or empty.

alias of str