App Engine v1 API - Class Version (2.3.0)

public sealed class Version : IMessage<Version>, IEquatable<Version>, IDeepCloneable<Version>, IBufferMessage, IMessage

Reference documentation and code samples for the App Engine v1 API class Version.

A Version resource is a specific set of source code and configuration files that are deployed into a service.

Inheritance

object > Version

Namespace

Google.Cloud.AppEngine.V1

Assembly

Google.Cloud.AppEngine.V1.dll

Constructors

Version()

public Version()

Version(Version)

public Version(Version other)
Parameter
NameDescription
otherVersion

Properties

ApiConfig

public ApiConfigHandler ApiConfig { get; set; }

Serving configuration for Google Cloud Endpoints.

Only returned in GET requests if view=FULL is set.

Property Value
TypeDescription
ApiConfigHandler

AppEngineApis

public bool AppEngineApis { get; set; }

Allows App Engine second generation runtimes to access the legacy bundled services.

Property Value
TypeDescription
bool

AutomaticScaling

public AutomaticScaling AutomaticScaling { get; set; }

Automatic 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.

Property Value
TypeDescription
AutomaticScaling

BasicScaling

public BasicScaling BasicScaling { get; set; }

A 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.

Property Value
TypeDescription
BasicScaling

BetaSettings

public MapField<string, string> BetaSettings { get; }

Metadata settings that are supplied to this version to enable beta runtime features.

Property Value
TypeDescription
MapFieldstringstring

BuildEnvVariables

public MapField<string, string> BuildEnvVariables { get; }

Environment variables available to the build environment.

Only returned in GET requests if view=FULL is set.

Property Value
TypeDescription
MapFieldstringstring

CreateTime

public Timestamp CreateTime { get; set; }

Time that this version was created.

@OutputOnly

Property Value
TypeDescription
Timestamp

CreatedBy

public string CreatedBy { get; set; }

Email address of the user who created this version.

@OutputOnly

Property Value
TypeDescription
string

DefaultExpiration

public Duration DefaultExpiration { get; set; }

Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler does not specify its own expiration time.

Only returned in GET requests if view=FULL is set.

Property Value
TypeDescription
Duration

Deployment

public Deployment Deployment { get; set; }

Code and application artifacts that make up this version.

Only returned in GET requests if view=FULL is set.

Property Value
TypeDescription
Deployment

DiskUsageBytes

public long DiskUsageBytes { get; set; }

Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.

@OutputOnly

Property Value
TypeDescription
long

EndpointsApiService

public EndpointsApiService EndpointsApiService { get; set; }

Cloud 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.

Property Value
TypeDescription
EndpointsApiService

Entrypoint

public Entrypoint Entrypoint { get; set; }

The entrypoint for the application.

Property Value
TypeDescription
Entrypoint

Env

public string Env { get; set; }

App Engine execution environment for this version.

Defaults to standard.

Property Value
TypeDescription
string

EnvVariables

public MapField<string, string> EnvVariables { get; }

Environment variables available to the application.

Only returned in GET requests if view=FULL is set.

Property Value
TypeDescription
MapFieldstringstring

ErrorHandlers

public RepeatedField<ErrorHandler> ErrorHandlers { get; }

Custom static error pages. Limited to 10KB per page.

Only returned in GET requests if view=FULL is set.

Property Value
TypeDescription
RepeatedFieldErrorHandler

Handlers

public RepeatedField<UrlMap> Handlers { get; }

An 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.

Property Value
TypeDescription
RepeatedFieldUrlMap

HealthCheck

public HealthCheck HealthCheck { get; set; }

Configures health checking for instances. Unhealthy instances are stopped and replaced with new instances. Only applicable in the App Engine flexible environment.

Only returned in GET requests if view=FULL is set.

Property Value
TypeDescription
HealthCheck

Id

public string Id { get; set; }

Relative 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-".

Property Value
TypeDescription
string

InboundServices

public RepeatedField<InboundServiceType> InboundServices { get; }

Before an application can receive email or XMPP messages, the application must be configured to enable the service.

Property Value
TypeDescription
RepeatedFieldInboundServiceType

InstanceClass

public string InstanceClass { get; set; }

Instance 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_1G

Defaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.

Property Value
TypeDescription
string

Libraries

public RepeatedField<Library> Libraries { get; }

Configuration for third-party Python runtime libraries that are required by the application.

Only returned in GET requests if view=FULL is set.

Property Value
TypeDescription
RepeatedFieldLibrary

LivenessCheck

public LivenessCheck LivenessCheck { get; set; }

Configures liveness health checking for instances. Unhealthy instances are stopped and replaced with new instances

Only returned in GET requests if view=FULL is set.

Property Value
TypeDescription
LivenessCheck

ManualScaling

public ManualScaling ManualScaling { get; set; }

A 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".

Property Value
TypeDescription
ManualScaling

Name

public string Name { get; set; }

Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.

@OutputOnly

Property Value
TypeDescription
string

Network

public Network Network { get; set; }

Extra network settings. Only applicable in the App Engine flexible environment.

Property Value
TypeDescription
Network

NobuildFilesRegex

public string NobuildFilesRegex { get; set; }

Files 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.

Property Value
TypeDescription
string

ReadinessCheck

public ReadinessCheck ReadinessCheck { get; set; }

Configures readiness health checking for instances. Unhealthy instances are not put into the backend traffic rotation.

Only returned in GET requests if view=FULL is set.

Property Value
TypeDescription
ReadinessCheck

Resources

public Resources Resources { get; set; }

Machine resources for this version. Only applicable in the App Engine flexible environment.

Property Value
TypeDescription
Resources

Runtime

public string Runtime { get; set; }

Desired runtime. Example: python27.

Property Value
TypeDescription
string

RuntimeApiVersion

public string RuntimeApiVersion { get; set; }

The 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/<language>/config/appref

Property Value
TypeDescription
string

RuntimeChannel

public string RuntimeChannel { get; set; }

The channel of the runtime to use. Only available for some runtimes. Defaults to the default channel.

Property Value
TypeDescription
string

RuntimeMainExecutablePath

public string RuntimeMainExecutablePath { get; set; }

The path or name of the app's main executable.

Property Value
TypeDescription
string

ScalingCase

public Version.ScalingOneofCase ScalingCase { get; }
Property Value
TypeDescription
VersionScalingOneofCase

ServiceAccount

public string ServiceAccount { get; set; }

The 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.

Property Value
TypeDescription
string

ServingStatus

public ServingStatus ServingStatus { get; set; }

Current 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.

Property Value
TypeDescription
ServingStatus

Threadsafe

public bool Threadsafe { get; set; }

Whether multiple requests can be dispatched to this version at once.

Property Value
TypeDescription
bool

VersionUrl

public string VersionUrl { get; set; }

Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"

@OutputOnly

Property Value
TypeDescription
string

Vm

public bool Vm { get; set; }

Whether to deploy this version in a container on a virtual machine.

Property Value
TypeDescription
bool

VpcAccessConnector

public VpcAccessConnector VpcAccessConnector { get; set; }

Enables VPC connectivity for standard apps.

Property Value
TypeDescription
VpcAccessConnector

Zones

public RepeatedField<string> Zones { get; }

The Google Compute Engine zones that are supported by this version in the App Engine flexible environment. Deprecated.

Property Value
TypeDescription
RepeatedFieldstring