Interface VersionOrBuilder (2.74.0)

publicinterface VersionOrBuilderextendsMessageOrBuilder

Implements

MessageOrBuilder

Methods

containsBetaSettings(String key)

publicabstractbooleancontainsBetaSettings(Stringkey)

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

map<string, string> beta_settings = 13;

Parameter
Name Description
key String
Returns
Type Description
boolean

containsBuildEnvVariables(String key)

publicabstractbooleancontainsBuildEnvVariables(Stringkey)

Environment variables available to the build environment.

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

map<string, string> build_env_variables = 125;

Parameter
Name Description
key String
Returns
Type Description
boolean

containsEnvVariables(String key)

publicabstractbooleancontainsEnvVariables(Stringkey)

Environment variables available to the application.

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

map<string, string> env_variables = 104;

Parameter
Name Description
key String
Returns
Type Description
boolean

getApiConfig()

publicabstractApiConfigHandlergetApiConfig()

Serving configuration for Google Cloud Endpoints.

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

.google.appengine.v1.ApiConfigHandler api_config = 103;

Returns
Type Description
ApiConfigHandler

The apiConfig.

getApiConfigOrBuilder()

publicabstractApiConfigHandlerOrBuildergetApiConfigOrBuilder()

Serving configuration for Google Cloud Endpoints.

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

.google.appengine.v1.ApiConfigHandler api_config = 103;

Returns
Type Description
ApiConfigHandlerOrBuilder

getAppEngineApis()

publicabstractbooleangetAppEngineApis()

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

bool app_engine_apis = 128;

Returns
Type Description
boolean

The appEngineApis.

getAutomaticScaling()

publicabstractAutomaticScalinggetAutomaticScaling()

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.

.google.appengine.v1.AutomaticScaling automatic_scaling = 3;

Returns
Type Description
AutomaticScaling

The automaticScaling.

getAutomaticScalingOrBuilder()

publicabstractAutomaticScalingOrBuildergetAutomaticScalingOrBuilder()

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.

.google.appengine.v1.AutomaticScaling automatic_scaling = 3;

Returns
Type Description
AutomaticScalingOrBuilder

getBasicScaling()

publicabstractBasicScalinggetBasicScaling()

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.

.google.appengine.v1.BasicScaling basic_scaling = 4;

Returns
Type Description
BasicScaling

The basicScaling.

getBasicScalingOrBuilder()

publicabstractBasicScalingOrBuildergetBasicScalingOrBuilder()

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.

.google.appengine.v1.BasicScaling basic_scaling = 4;

Returns
Type Description
BasicScalingOrBuilder

getBetaSettings() (deprecated)

publicabstractMap<String,String>getBetaSettings()

Use #getBetaSettingsMap() instead.

Returns
Type Description
Map<String,String>

getBetaSettingsCount()

publicabstractintgetBetaSettingsCount()

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

map<string, string> beta_settings = 13;

Returns
Type Description
int

getBetaSettingsMap()

publicabstractMap<String,String>getBetaSettingsMap()

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

map<string, string> beta_settings = 13;

Returns
Type Description
Map<String,String>

getBetaSettingsOrDefault(String key, String defaultValue)

publicabstractStringgetBetaSettingsOrDefault(Stringkey,StringdefaultValue)

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

map<string, string> beta_settings = 13;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getBetaSettingsOrThrow(String key)

publicabstractStringgetBetaSettingsOrThrow(Stringkey)

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

map<string, string> beta_settings = 13;

Parameter
Name Description
key String
Returns
Type Description
String

getBuildEnvVariables() (deprecated)

publicabstractMap<String,String>getBuildEnvVariables()
Returns
Type Description
Map<String,String>

getBuildEnvVariablesCount()

publicabstractintgetBuildEnvVariablesCount()

Environment variables available to the build environment.

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

map<string, string> build_env_variables = 125;

Returns
Type Description
int

getBuildEnvVariablesMap()

publicabstractMap<String,String>getBuildEnvVariablesMap()

Environment variables available to the build environment.

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

map<string, string> build_env_variables = 125;

Returns
Type Description
Map<String,String>

getBuildEnvVariablesOrDefault(String key, String defaultValue)

publicabstractStringgetBuildEnvVariablesOrDefault(Stringkey,StringdefaultValue)

Environment variables available to the build environment.

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

map<string, string> build_env_variables = 125;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getBuildEnvVariablesOrThrow(String key)

publicabstractStringgetBuildEnvVariablesOrThrow(Stringkey)

Environment variables available to the build environment.

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

map<string, string> build_env_variables = 125;

Parameter
Name Description
key String
Returns
Type Description
String

getCreateTime()

publicabstractTimestampgetCreateTime()

Time that this version was created.

@OutputOnly

.google.protobuf.Timestamp create_time = 17;

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

publicabstractTimestampOrBuildergetCreateTimeOrBuilder()

Time that this version was created.

@OutputOnly

.google.protobuf.Timestamp create_time = 17;

Returns
Type Description
TimestampOrBuilder

getCreatedBy()

publicabstractStringgetCreatedBy()

Email address of the user who created this version.

@OutputOnly

string created_by = 16;

Returns
Type Description
String

The createdBy.

getCreatedByBytes()

publicabstractByteStringgetCreatedByBytes()

Email address of the user who created this version.

@OutputOnly

string created_by = 16;

Returns
Type Description
ByteString

The bytes for createdBy.

getDefaultExpiration()

publicabstractDurationgetDefaultExpiration()

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.

.google.protobuf.Duration default_expiration = 105;

Returns
Type Description
Duration

The defaultExpiration.

getDefaultExpirationOrBuilder()

publicabstractDurationOrBuildergetDefaultExpirationOrBuilder()

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.

.google.protobuf.Duration default_expiration = 105;

Returns
Type Description
DurationOrBuilder

getDeployment()

publicabstractDeploymentgetDeployment()

Code and application artifacts that make up this version.

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

.google.appengine.v1.Deployment deployment = 108;

Returns
Type Description
Deployment

The deployment.

getDeploymentOrBuilder()

publicabstractDeploymentOrBuildergetDeploymentOrBuilder()

Code and application artifacts that make up this version.

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

.google.appengine.v1.Deployment deployment = 108;

Returns
Type Description
DeploymentOrBuilder

getDiskUsageBytes()

publicabstractlonggetDiskUsageBytes()

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

@OutputOnly

int64 disk_usage_bytes = 18;

Returns
Type Description
long

The diskUsageBytes.

getEndpointsApiService()

publicabstractEndpointsApiServicegetEndpointsApiService()

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.

.google.appengine.v1.EndpointsApiService endpoints_api_service = 110;

Returns
Type Description
EndpointsApiService

The endpointsApiService.

getEndpointsApiServiceOrBuilder()

publicabstractEndpointsApiServiceOrBuildergetEndpointsApiServiceOrBuilder()

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.

.google.appengine.v1.EndpointsApiService endpoints_api_service = 110;

Returns
Type Description
EndpointsApiServiceOrBuilder

getEntrypoint()

publicabstractEntrypointgetEntrypoint()

The entrypoint for the application.

.google.appengine.v1.Entrypoint entrypoint = 122;

Returns
Type Description
Entrypoint

The entrypoint.

getEntrypointOrBuilder()

publicabstractEntrypointOrBuildergetEntrypointOrBuilder()

The entrypoint for the application.

.google.appengine.v1.Entrypoint entrypoint = 122;

Returns
Type Description
EntrypointOrBuilder

getEnv()

publicabstractStringgetEnv()

App Engine execution environment for this version.

Defaults to standard.

string env = 14;

Returns
Type Description
String

The env.

getEnvBytes()

publicabstractByteStringgetEnvBytes()

App Engine execution environment for this version.

Defaults to standard.

string env = 14;

Returns
Type Description
ByteString

The bytes for env.

getEnvVariables() (deprecated)

publicabstractMap<String,String>getEnvVariables()

Use #getEnvVariablesMap() instead.

Returns
Type Description
Map<String,String>

getEnvVariablesCount()

publicabstractintgetEnvVariablesCount()

Environment variables available to the application.

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

map<string, string> env_variables = 104;

Returns
Type Description
int

getEnvVariablesMap()

publicabstractMap<String,String>getEnvVariablesMap()

Environment variables available to the application.

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

map<string, string> env_variables = 104;

Returns
Type Description
Map<String,String>

getEnvVariablesOrDefault(String key, String defaultValue)

publicabstractStringgetEnvVariablesOrDefault(Stringkey,StringdefaultValue)

Environment variables available to the application.

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

map<string, string> env_variables = 104;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getEnvVariablesOrThrow(String key)

publicabstractStringgetEnvVariablesOrThrow(Stringkey)

Environment variables available to the application.

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

map<string, string> env_variables = 104;

Parameter
Name Description
key String
Returns
Type Description
String

getErrorHandlers(int index)

publicabstractErrorHandlergetErrorHandlers(intindex)

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

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

repeated .google.appengine.v1.ErrorHandler error_handlers = 101;

Parameter
Name Description
index int
Returns
Type Description
ErrorHandler

getErrorHandlersCount()

publicabstractintgetErrorHandlersCount()

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

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

repeated .google.appengine.v1.ErrorHandler error_handlers = 101;

Returns
Type Description
int

getErrorHandlersList()

publicabstractList<ErrorHandler>getErrorHandlersList()

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

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

repeated .google.appengine.v1.ErrorHandler error_handlers = 101;

Returns
Type Description
List<ErrorHandler>

getErrorHandlersOrBuilder(int index)

publicabstractErrorHandlerOrBuildergetErrorHandlersOrBuilder(intindex)

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

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

repeated .google.appengine.v1.ErrorHandler error_handlers = 101;

Parameter
Name Description
index int
Returns
Type Description
ErrorHandlerOrBuilder

getErrorHandlersOrBuilderList()

publicabstractList<?extendsErrorHandlerOrBuilder>getErrorHandlersOrBuilderList()

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

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

repeated .google.appengine.v1.ErrorHandler error_handlers = 101;

Returns
Type Description
List<? extends com.google.appengine.v1.ErrorHandlerOrBuilder>

getHandlers(int index)

publicabstractUrlMapgetHandlers(intindex)

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.

repeated .google.appengine.v1.UrlMap handlers = 100;

Parameter
Name Description
index int
Returns
Type Description
UrlMap

getHandlersCount()

publicabstractintgetHandlersCount()

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.

repeated .google.appengine.v1.UrlMap handlers = 100;

Returns
Type Description
int

getHandlersList()

publicabstractList<UrlMap>getHandlersList()

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.

repeated .google.appengine.v1.UrlMap handlers = 100;

Returns
Type Description
List<UrlMap>

getHandlersOrBuilder(int index)

publicabstractUrlMapOrBuildergetHandlersOrBuilder(intindex)

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.

repeated .google.appengine.v1.UrlMap handlers = 100;

Parameter
Name Description
index int
Returns
Type Description
UrlMapOrBuilder

getHandlersOrBuilderList()

publicabstractList<?extendsUrlMapOrBuilder>getHandlersOrBuilderList()

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.

repeated .google.appengine.v1.UrlMap handlers = 100;

Returns
Type Description
List<? extends com.google.appengine.v1.UrlMapOrBuilder>

getHealthCheck()

publicabstractHealthCheckgetHealthCheck()

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.

.google.appengine.v1.HealthCheck health_check = 106;

Returns
Type Description
HealthCheck

The healthCheck.

getHealthCheckOrBuilder()

publicabstractHealthCheckOrBuildergetHealthCheckOrBuilder()

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.

.google.appengine.v1.HealthCheck health_check = 106;

Returns
Type Description
HealthCheckOrBuilder

getId()

publicabstractStringgetId()

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

string id = 2;

Returns
Type Description
String

The id.

getIdBytes()

publicabstractByteStringgetIdBytes()

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

string id = 2;

Returns
Type Description
ByteString

The bytes for id.

getInboundServices(int index)

publicabstractInboundServiceTypegetInboundServices(intindex)

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

repeated .google.appengine.v1.InboundServiceType inbound_services = 6;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
InboundServiceType

The inboundServices at the given index.

getInboundServicesCount()

publicabstractintgetInboundServicesCount()

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

repeated .google.appengine.v1.InboundServiceType inbound_services = 6;

Returns
Type Description
int

The count of inboundServices.

getInboundServicesList()

publicabstractList<InboundServiceType>getInboundServicesList()

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

repeated .google.appengine.v1.InboundServiceType inbound_services = 6;

Returns
Type Description
List<InboundServiceType>

A list containing the inboundServices.

getInboundServicesValue(int index)

publicabstractintgetInboundServicesValue(intindex)

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

repeated .google.appengine.v1.InboundServiceType inbound_services = 6;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
int

The enum numeric value on the wire of inboundServices at the given index.

getInboundServicesValueList()

publicabstractList<Integer>getInboundServicesValueList()

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

repeated .google.appengine.v1.InboundServiceType inbound_services = 6;

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for inboundServices.

getInstanceClass()

publicabstractStringgetInstanceClass()

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.

string instance_class = 7;

Returns
Type Description
String

The instanceClass.

getInstanceClassBytes()

publicabstractByteStringgetInstanceClassBytes()

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.

string instance_class = 7;

Returns
Type Description
ByteString

The bytes for instanceClass.

getLibraries(int index)

publicabstractLibrarygetLibraries(intindex)

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

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

repeated .google.appengine.v1.Library libraries = 102;

Parameter
Name Description
index int
Returns
Type Description
Library

getLibrariesCount()

publicabstractintgetLibrariesCount()

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

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

repeated .google.appengine.v1.Library libraries = 102;

Returns
Type Description
int

getLibrariesList()

publicabstractList<Library>getLibrariesList()

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

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

repeated .google.appengine.v1.Library libraries = 102;

Returns
Type Description
List<Library>

getLibrariesOrBuilder(int index)

publicabstractLibraryOrBuildergetLibrariesOrBuilder(intindex)

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

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

repeated .google.appengine.v1.Library libraries = 102;

Parameter
Name Description
index int
Returns
Type Description
LibraryOrBuilder

getLibrariesOrBuilderList()

publicabstractList<?extendsLibraryOrBuilder>getLibrariesOrBuilderList()

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

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

repeated .google.appengine.v1.Library libraries = 102;

Returns
Type Description
List<? extends com.google.appengine.v1.LibraryOrBuilder>

getLivenessCheck()

publicabstractLivenessCheckgetLivenessCheck()

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.

.google.appengine.v1.LivenessCheck liveness_check = 113;

Returns
Type Description
LivenessCheck

The livenessCheck.

getLivenessCheckOrBuilder()

publicabstractLivenessCheckOrBuildergetLivenessCheckOrBuilder()

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.

.google.appengine.v1.LivenessCheck liveness_check = 113;

Returns
Type Description
LivenessCheckOrBuilder

getManualScaling()

publicabstractManualScalinggetManualScaling()

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

.google.appengine.v1.ManualScaling manual_scaling = 5;

Returns
Type Description
ManualScaling

The manualScaling.

getManualScalingOrBuilder()

publicabstractManualScalingOrBuildergetManualScalingOrBuilder()

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

.google.appengine.v1.ManualScaling manual_scaling = 5;

Returns
Type Description
ManualScalingOrBuilder

getName()

publicabstractStringgetName()

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

@OutputOnly

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

publicabstractByteStringgetNameBytes()

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

@OutputOnly

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getNetwork()

publicabstractNetworkgetNetwork()

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

.google.appengine.v1.Network network = 8;

Returns
Type Description
Network

The network.

getNetworkOrBuilder()

publicabstractNetworkOrBuildergetNetworkOrBuilder()

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

.google.appengine.v1.Network network = 8;

Returns
Type Description
NetworkOrBuilder

getNobuildFilesRegex()

publicabstractStringgetNobuildFilesRegex()

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.

string nobuild_files_regex = 107;

Returns
Type Description
String

The nobuildFilesRegex.

getNobuildFilesRegexBytes()

publicabstractByteStringgetNobuildFilesRegexBytes()

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.

string nobuild_files_regex = 107;

Returns
Type Description
ByteString

The bytes for nobuildFilesRegex.

getReadinessCheck()

publicabstractReadinessCheckgetReadinessCheck()

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.

.google.appengine.v1.ReadinessCheck readiness_check = 112;

Returns
Type Description
ReadinessCheck

The readinessCheck.

getReadinessCheckOrBuilder()

publicabstractReadinessCheckOrBuildergetReadinessCheckOrBuilder()

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.

.google.appengine.v1.ReadinessCheck readiness_check = 112;

Returns
Type Description
ReadinessCheckOrBuilder

getResources()

publicabstractResourcesgetResources()

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

.google.appengine.v1.Resources resources = 9;

Returns
Type Description
Resources

The resources.

getResourcesOrBuilder()

publicabstractResourcesOrBuildergetResourcesOrBuilder()

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

.google.appengine.v1.Resources resources = 9;

Returns
Type Description
ResourcesOrBuilder

getRuntime()

publicabstractStringgetRuntime()

Desired runtime. Example: python27.

string runtime = 10;

Returns
Type Description
String

The runtime.

getRuntimeApiVersion()

publicabstractStringgetRuntimeApiVersion()

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

string runtime_api_version = 21;

Returns
Type Description
String

The runtimeApiVersion.

getRuntimeApiVersionBytes()

publicabstractByteStringgetRuntimeApiVersionBytes()

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

string runtime_api_version = 21;

Returns
Type Description
ByteString

The bytes for runtimeApiVersion.

getRuntimeBytes()

publicabstractByteStringgetRuntimeBytes()

Desired runtime. Example: python27.

string runtime = 10;

Returns
Type Description
ByteString

The bytes for runtime.

getRuntimeChannel()

publicabstractStringgetRuntimeChannel()

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

string runtime_channel = 117;

Returns
Type Description
String

The runtimeChannel.

getRuntimeChannelBytes()

publicabstractByteStringgetRuntimeChannelBytes()

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

string runtime_channel = 117;

Returns
Type Description
ByteString

The bytes for runtimeChannel.

getRuntimeMainExecutablePath()

publicabstractStringgetRuntimeMainExecutablePath()

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

string runtime_main_executable_path = 22;

Returns
Type Description
String

The runtimeMainExecutablePath.

getRuntimeMainExecutablePathBytes()

publicabstractByteStringgetRuntimeMainExecutablePathBytes()

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

string runtime_main_executable_path = 22;

Returns
Type Description
ByteString

The bytes for runtimeMainExecutablePath.

getScalingCase()

publicabstractVersion.ScalingCasegetScalingCase()
Returns
Type Description
Version.ScalingCase

getServiceAccount()

publicabstractStringgetServiceAccount()

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.

string service_account = 127;

Returns
Type Description
String

The serviceAccount.

getServiceAccountBytes()

publicabstractByteStringgetServiceAccountBytes()

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.

string service_account = 127;

Returns
Type Description
ByteString

The bytes for serviceAccount.

getServingStatus()

publicabstractServingStatusgetServingStatus()

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.

.google.appengine.v1.ServingStatus serving_status = 15;

Returns
Type Description
ServingStatus

The servingStatus.

getServingStatusValue()

publicabstractintgetServingStatusValue()

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.

.google.appengine.v1.ServingStatus serving_status = 15;

Returns
Type Description
int

The enum numeric value on the wire for servingStatus.

getThreadsafe()

publicabstractbooleangetThreadsafe()

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

bool threadsafe = 11;

Returns
Type Description
boolean

The threadsafe.

getVersionUrl()

publicabstractStringgetVersionUrl()

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

@OutputOnly

string version_url = 109;

Returns
Type Description
String

The versionUrl.

getVersionUrlBytes()

publicabstractByteStringgetVersionUrlBytes()

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

@OutputOnly

string version_url = 109;

Returns
Type Description
ByteString

The bytes for versionUrl.

getVm()

publicabstractbooleangetVm()

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

bool vm = 12;

Returns
Type Description
boolean

The vm.

getVpcAccessConnector()

publicabstractVpcAccessConnectorgetVpcAccessConnector()

Enables VPC connectivity for standard apps.

.google.appengine.v1.VpcAccessConnector vpc_access_connector = 121;

Returns
Type Description
VpcAccessConnector

The vpcAccessConnector.

getVpcAccessConnectorOrBuilder()

publicabstractVpcAccessConnectorOrBuildergetVpcAccessConnectorOrBuilder()

Enables VPC connectivity for standard apps.

.google.appengine.v1.VpcAccessConnector vpc_access_connector = 121;

Returns
Type Description
VpcAccessConnectorOrBuilder

getZones(int index)

publicabstractStringgetZones(intindex)

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

repeated string zones = 118;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The zones at the given index.

getZonesBytes(int index)

publicabstractByteStringgetZonesBytes(intindex)

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

repeated string zones = 118;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the zones at the given index.

getZonesCount()

publicabstractintgetZonesCount()

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

repeated string zones = 118;

Returns
Type Description
int

The count of zones.

getZonesList()

publicabstractList<String>getZonesList()

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

repeated string zones = 118;

Returns
Type Description
List<String>

A list containing the zones.

hasApiConfig()

publicabstractbooleanhasApiConfig()

Serving configuration for Google Cloud Endpoints.

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

.google.appengine.v1.ApiConfigHandler api_config = 103;

Returns
Type Description
boolean

Whether the apiConfig field is set.

hasAutomaticScaling()

publicabstractbooleanhasAutomaticScaling()

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.

.google.appengine.v1.AutomaticScaling automatic_scaling = 3;

Returns
Type Description
boolean

Whether the automaticScaling field is set.

hasBasicScaling()

publicabstractbooleanhasBasicScaling()

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.

.google.appengine.v1.BasicScaling basic_scaling = 4;

Returns
Type Description
boolean

Whether the basicScaling field is set.

hasCreateTime()

publicabstractbooleanhasCreateTime()

Time that this version was created.

@OutputOnly

.google.protobuf.Timestamp create_time = 17;

Returns
Type Description
boolean

Whether the createTime field is set.

hasDefaultExpiration()

publicabstractbooleanhasDefaultExpiration()

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.

.google.protobuf.Duration default_expiration = 105;

Returns
Type Description
boolean

Whether the defaultExpiration field is set.

hasDeployment()

publicabstractbooleanhasDeployment()

Code and application artifacts that make up this version.

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

.google.appengine.v1.Deployment deployment = 108;

Returns
Type Description
boolean

Whether the deployment field is set.

hasEndpointsApiService()

publicabstractbooleanhasEndpointsApiService()

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.

.google.appengine.v1.EndpointsApiService endpoints_api_service = 110;

Returns
Type Description
boolean

Whether the endpointsApiService field is set.

hasEntrypoint()

publicabstractbooleanhasEntrypoint()

The entrypoint for the application.

.google.appengine.v1.Entrypoint entrypoint = 122;

Returns
Type Description
boolean

Whether the entrypoint field is set.

hasHealthCheck()

publicabstractbooleanhasHealthCheck()

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.

.google.appengine.v1.HealthCheck health_check = 106;

Returns
Type Description
boolean

Whether the healthCheck field is set.

hasLivenessCheck()

publicabstractbooleanhasLivenessCheck()

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.

.google.appengine.v1.LivenessCheck liveness_check = 113;

Returns
Type Description
boolean

Whether the livenessCheck field is set.

hasManualScaling()

publicabstractbooleanhasManualScaling()

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

.google.appengine.v1.ManualScaling manual_scaling = 5;

Returns
Type Description
boolean

Whether the manualScaling field is set.

hasNetwork()

publicabstractbooleanhasNetwork()

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

.google.appengine.v1.Network network = 8;

Returns
Type Description
boolean

Whether the network field is set.

hasReadinessCheck()

publicabstractbooleanhasReadinessCheck()

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.

.google.appengine.v1.ReadinessCheck readiness_check = 112;

Returns
Type Description
boolean

Whether the readinessCheck field is set.

hasResources()

publicabstractbooleanhasResources()

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

.google.appengine.v1.Resources resources = 9;

Returns
Type Description
boolean

Whether the resources field is set.

hasVpcAccessConnector()

publicabstractbooleanhasVpcAccessConnector()

Enables VPC connectivity for standard apps.

.google.appengine.v1.VpcAccessConnector vpc_access_connector = 121;

Returns
Type Description
boolean

Whether the vpcAccessConnector field is set.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.