Skip to main content

versions

Creates, updates, deletes, gets or lists a versions resource.

Overview

Nameversions
TypeResource
Idgoogle.appengine.versions

Fields

The following fields are returned by SELECT queries:

Successful response

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-".
namestringOutput only. Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly
apiConfigobjectServing configuration for Google Cloud Endpoints (https://cloud.google.com/endpoints).Only returned in GET requests if view=FULL is set. (id: ApiConfigHandler)
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. Instances are dynamically created and destroyed as needed in order to handle traffic. (id: AutomaticScaling)
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. (id: BasicScaling)
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.
createTimestring (google-datetime)Time that this version was created.@OutputOnly
createdBystringOutput only. Email address of the user who created this version.@OutputOnly
defaultExpirationstring (google-duration)Duration 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 that make up this version.Only returned in GET requests if view=FULL is set. (id: Deployment)
diskUsageBytesstring (int64)Output only. Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly
endpointsApiServiceobjectCloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app. (id: EndpointsApiService)
entrypointobjectThe entrypoint for the application. (id: Entrypoint)
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.
flexibleRuntimeSettingsobjectSettings for App Engine flexible runtimes. (id: FlexibleRuntimeSettings)
generatedCustomerMetadataobjectAdditional Google Generated Customer Metadata, this field won't be provided by default and can be requested by setting the IncludeExtraData field in GetVersionRequest
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.
healthCheckobjectConfigures health checking for instances. Unhealthy instances are stopped and replaced with new instances. Only applicable in the App Engine flexible environment. (id: HealthCheck)
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.
livenessCheckobjectConfigures liveness health checking for instances. Unhealthy instances are stopped and replaced with new instances (id: LivenessCheck)
manualScalingobjectA service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. Manually scaled versions are sometimes referred to as "backends". (id: ManualScaling)
networkobjectExtra network settings. Only applicable in the App Engine flexible environment. (id: Network)
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.
readinessCheckobjectConfigures readiness health checking for instances. Unhealthy instances are not put into the backend traffic rotation. (id: ReadinessCheck)
resourcesobjectMachine resources for this version. Only applicable in the App Engine flexible environment. (id: Resources)
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.
versionUrlstringOutput only. Serving 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.
vpcAccessConnectorobjectEnables VPC connectivity for standard apps. (id: VpcAccessConnector)
zonesarrayThe Google Compute Engine zones that are supported by this version in the App Engine flexible environment. Deprecated.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectappsId, servicesId, versionsIdviewGets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.
listselectappsId, servicesIdview, pageSize, pageTokenLists the versions of a service.
createinsertappsId, servicesIdDeploys code and resource files to a new version.
patchupdateprojectsId, locationsId, applicationsId, servicesId, versionsIdupdateMaskUpdates 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)
deletedeleteprojectsId, locationsId, applicationsId, servicesId, versionsIdDeletes an existing Version resource.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
applicationsIdstring
appsIdstring
locationsIdstring
projectsIdstring
servicesIdstring
versionsIdstring
pageSizeinteger (int32)
pageTokenstring
updateMaskstring (google-fieldmask)
viewstring

SELECT examples

Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.

SELECT
id,
name,
apiConfig,
appEngineApis,
automaticScaling,
basicScaling,
betaSettings,
buildEnvVariables,
createTime,
createdBy,
defaultExpiration,
deployment,
diskUsageBytes,
endpointsApiService,
entrypoint,
env,
envVariables,
errorHandlers,
flexibleRuntimeSettings,
generatedCustomerMetadata,
handlers,
healthCheck,
inboundServices,
instanceClass,
libraries,
livenessCheck,
manualScaling,
network,
nobuildFilesRegex,
readinessCheck,
resources,
runtime,
runtimeApiVersion,
runtimeChannel,
runtimeMainExecutablePath,
serviceAccount,
servingStatus,
threadsafe,
versionUrl,
vm,
vpcAccessConnector,
zones
FROM google.appengine.versions
WHERE appsId = '{{ appsId }}' -- required
AND servicesId = '{{ servicesId }}' -- required
AND versionsId = '{{ versionsId }}' -- required
AND view = '{{ view }}';

INSERT examples

Deploys code and resource files to a new version.

INSERT INTO google.appengine.versions (
data__id,
data__automaticScaling,
data__basicScaling,
data__manualScaling,
data__inboundServices,
data__instanceClass,
data__network,
data__zones,
data__resources,
data__runtime,
data__runtimeChannel,
data__threadsafe,
data__vm,
data__flexibleRuntimeSettings,
data__appEngineApis,
data__betaSettings,
data__env,
data__servingStatus,
data__createTime,
data__runtimeApiVersion,
data__runtimeMainExecutablePath,
data__serviceAccount,
data__handlers,
data__errorHandlers,
data__libraries,
data__apiConfig,
data__envVariables,
data__buildEnvVariables,
data__defaultExpiration,
data__healthCheck,
data__readinessCheck,
data__livenessCheck,
data__nobuildFilesRegex,
data__deployment,
data__endpointsApiService,
data__entrypoint,
data__vpcAccessConnector,
data__generatedCustomerMetadata,
appsId,
servicesId
)
SELECT
'{{ id }}',
'{{ automaticScaling }}',
'{{ basicScaling }}',
'{{ manualScaling }}',
'{{ inboundServices }}',
'{{ instanceClass }}',
'{{ network }}',
'{{ zones }}',
'{{ resources }}',
'{{ runtime }}',
'{{ runtimeChannel }}',
{{ threadsafe }},
{{ vm }},
'{{ flexibleRuntimeSettings }}',
{{ appEngineApis }},
'{{ betaSettings }}',
'{{ env }}',
'{{ servingStatus }}',
'{{ createTime }}',
'{{ runtimeApiVersion }}',
'{{ runtimeMainExecutablePath }}',
'{{ serviceAccount }}',
'{{ handlers }}',
'{{ errorHandlers }}',
'{{ libraries }}',
'{{ apiConfig }}',
'{{ envVariables }}',
'{{ buildEnvVariables }}',
'{{ defaultExpiration }}',
'{{ healthCheck }}',
'{{ readinessCheck }}',
'{{ livenessCheck }}',
'{{ nobuildFilesRegex }}',
'{{ deployment }}',
'{{ endpointsApiService }}',
'{{ entrypoint }}',
'{{ vpcAccessConnector }}',
'{{ generatedCustomerMetadata }}',
'{{ appsId }}',
'{{ servicesId }}'
RETURNING
name,
done,
error,
metadata,
response
;

UPDATE examples

Updates 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)

UPDATE google.appengine.versions
SET
data__id = '{{ id }}',
data__automaticScaling = '{{ automaticScaling }}',
data__basicScaling = '{{ basicScaling }}',
data__manualScaling = '{{ manualScaling }}',
data__inboundServices = '{{ inboundServices }}',
data__instanceClass = '{{ instanceClass }}',
data__network = '{{ network }}',
data__zones = '{{ zones }}',
data__resources = '{{ resources }}',
data__runtime = '{{ runtime }}',
data__runtimeChannel = '{{ runtimeChannel }}',
data__threadsafe = {{ threadsafe }},
data__vm = {{ vm }},
data__flexibleRuntimeSettings = '{{ flexibleRuntimeSettings }}',
data__appEngineApis = {{ appEngineApis }},
data__betaSettings = '{{ betaSettings }}',
data__env = '{{ env }}',
data__servingStatus = '{{ servingStatus }}',
data__createTime = '{{ createTime }}',
data__runtimeApiVersion = '{{ runtimeApiVersion }}',
data__runtimeMainExecutablePath = '{{ runtimeMainExecutablePath }}',
data__serviceAccount = '{{ serviceAccount }}',
data__handlers = '{{ handlers }}',
data__errorHandlers = '{{ errorHandlers }}',
data__libraries = '{{ libraries }}',
data__apiConfig = '{{ apiConfig }}',
data__envVariables = '{{ envVariables }}',
data__buildEnvVariables = '{{ buildEnvVariables }}',
data__defaultExpiration = '{{ defaultExpiration }}',
data__healthCheck = '{{ healthCheck }}',
data__readinessCheck = '{{ readinessCheck }}',
data__livenessCheck = '{{ livenessCheck }}',
data__nobuildFilesRegex = '{{ nobuildFilesRegex }}',
data__deployment = '{{ deployment }}',
data__endpointsApiService = '{{ endpointsApiService }}',
data__entrypoint = '{{ entrypoint }}',
data__vpcAccessConnector = '{{ vpcAccessConnector }}',
data__generatedCustomerMetadata = '{{ generatedCustomerMetadata }}'
WHERE
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND applicationsId = '{{ applicationsId }}' --required
AND servicesId = '{{ servicesId }}' --required
AND versionsId = '{{ versionsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

Deletes an existing Version resource.

DELETE FROM google.appengine.versions
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND applicationsId = '{{ applicationsId }}' --required
AND servicesId = '{{ servicesId }}' --required
AND versionsId = '{{ versionsId }}' --required;