Skip to main content

versions

Overview

Nameversions
TypeResource
Idgoogle.appengine.versions

Fields

NameDatatypeDescription
idstringRelative name of the version within the service. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-".
namestringFull path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly
apiConfigobjectGoogle Cloud Endpoints (https://cloud.google.com/endpoints) configuration for API handlers.
appEngineApisbooleanAllows App Engine second generation runtimes to access the legacy bundled services.
automaticScalingobjectAutomatic scaling is based on request rate, response latencies, and other application metrics.
basicScalingobjectA service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.
betaSettingsobjectMetadata settings that are supplied to this version to enable beta runtime features.
buildEnvVariablesobjectEnvironment variables available to the build environment.Only returned in GET requests if view=FULL is set.
createTimestringTime that this version was created.@OutputOnly
createdBystringEmail address of the user who created this version.@OutputOnly
defaultExpirationstringDuration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StaticFilesHandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.
deploymentobjectCode and application artifacts used to deploy a version to App Engine.
diskUsageBytesstringTotal size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly
endpointsApiServiceobjectGoogle Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy. Only valid for App Engine Flexible environment deployments.The fields here refer to the name and configuration ID of a "service" resource in the Service Management API (https://cloud.google.com/service-management/overview).
entrypointobjectThe entrypoint for the application.
envstringApp Engine execution environment for this version.Defaults to standard.
envVariablesobjectEnvironment variables available to the application.Only returned in GET requests if view=FULL is set.
errorHandlersarrayCustom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.
flexibleRuntimeSettingsobjectRuntime settings for the App Engine flexible environment.
handlersarrayAn ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted.Only returned in GET requests if view=FULL is set.
healthCheckobjectHealth checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.
inboundServicesarrayBefore an application can receive email or XMPP messages, the application must be configured to enable the service.
instanceClassstringInstance class that is used to run this version. Valid values are: AutomaticScaling: F1, F2, F4, F4_1G ManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.
librariesarrayConfiguration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set.
livenessCheckobjectHealth checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances.
manualScalingobjectA service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.
networkobjectExtra network settings. Only applicable in the App Engine flexible environment.
nobuildFilesRegexstringFiles that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.
readinessCheckobjectReadiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation.
resourcesobjectMachine resources for a version.
runtimestringDesired runtime. Example: python27.
runtimeApiVersionstringThe version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud.google.com/appengine/docs/standard//config/appref
runtimeChannelstringThe channel of the runtime to use. Only available for some runtimes. Defaults to the default channel.
runtimeMainExecutablePathstringThe path or name of the app's main executable.
serviceAccountstringThe identity that the deployed version will run as. Admin API will use the App Engine Appspot service account as default if this field is neither provided in app.yaml file nor through CLI flag.
servingStatusstringCurrent serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING.
threadsafebooleanWhether multiple requests can be dispatched to this version at once.
versionUrlstringServing URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly
vmbooleanWhether to deploy this version in a container on a virtual machine.
vpcAccessConnectorobjectVPC access connector specification.
zonesarrayThe Google Compute Engine zones that are supported by this version in the App Engine flexible environment. Deprecated.

Methods

NameAccessible byRequired ParamsDescription
getSELECTappsId, servicesId, versionsIdGets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.
listSELECTappsId, servicesIdLists the versions of a service.
createINSERTappsId, servicesIdDeploys code and resource files to a new version.
deleteDELETEappsId, servicesId, versionsIdDeletes an existing Version resource.
_listEXECappsId, servicesIdLists the versions of a service.
patchEXECappsId, servicesId, versionsIdUpdates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:Standard environment instance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.instance_class)automatic scaling in the standard environment: automatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automaticScaling.standard_scheduler_settings.max_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.min_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_cpu_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_throughput_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings)basic scaling or manual scaling in the standard environment: serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status) manual_scaling.instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#manualscaling)Flexible environment serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status)automatic scaling in the flexible environment: automatic_scaling.min_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cool_down_period_sec (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling)manual scaling in the flexible environment: manual_scaling.instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#manualscaling)