App Engine Admin V1 API - Class Google::Cloud::AppEngine::V1::Version (v0.5.0)

Reference documentation and code samples for the App Engine Admin V1 API class Google::Cloud::AppEngine::V1::Version.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#api_config

def api_config() -> ::Google::Cloud::AppEngine::V1::ApiConfigHandler
Returns

#api_config=

def api_config=(value) -> ::Google::Cloud::AppEngine::V1::ApiConfigHandler
Parameter
Returns

#app_engine_apis

def app_engine_apis() -> ::Boolean
Returns
  • (::Boolean) — Allows App Engine second generation runtimes to access the legacy bundled services.

#app_engine_apis=

def app_engine_apis=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Allows App Engine second generation runtimes to access the legacy bundled services.
Returns
  • (::Boolean) — Allows App Engine second generation runtimes to access the legacy bundled services.

#automatic_scaling

def automatic_scaling() -> ::Google::Cloud::AppEngine::V1::AutomaticScaling
Returns

#automatic_scaling=

def automatic_scaling=(value) -> ::Google::Cloud::AppEngine::V1::AutomaticScaling
Parameter
  • value (::Google::Cloud::AppEngine::V1::AutomaticScaling) — 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.
Returns

#basic_scaling

def basic_scaling() -> ::Google::Cloud::AppEngine::V1::BasicScaling
Returns
  • (::Google::Cloud::AppEngine::V1::BasicScaling) — 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.

#basic_scaling=

def basic_scaling=(value) -> ::Google::Cloud::AppEngine::V1::BasicScaling
Parameter
  • value (::Google::Cloud::AppEngine::V1::BasicScaling) — 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.
Returns
  • (::Google::Cloud::AppEngine::V1::BasicScaling) — 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.

#beta_settings

def beta_settings() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Metadata settings that are supplied to this version to enable beta runtime features.

#beta_settings=

def beta_settings=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Metadata settings that are supplied to this version to enable beta runtime features.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Metadata settings that are supplied to this version to enable beta runtime features.

#build_env_variables

def build_env_variables() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Environment variables available to the build environment.

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

#build_env_variables=

def build_env_variables=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Environment variables available to the build environment.

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

Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Environment variables available to the build environment.

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

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#create_time=

def create_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
Returns

#created_by

def created_by() -> ::String
Returns
  • (::String) — Email address of the user who created this version.

#created_by=

def created_by=(value) -> ::String
Parameter
  • value (::String) — Email address of the user who created this version.
Returns
  • (::String) — Email address of the user who created this version.

#default_expiration

def default_expiration() -> ::Google::Protobuf::Duration
Returns
  • (::Google::Protobuf::Duration) — 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.

#default_expiration=

def default_expiration=(value) -> ::Google::Protobuf::Duration
Parameter
  • value (::Google::Protobuf::Duration) — 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.

Returns
  • (::Google::Protobuf::Duration) — 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.

#deployment

def deployment() -> ::Google::Cloud::AppEngine::V1::Deployment
Returns

#deployment=

def deployment=(value) -> ::Google::Cloud::AppEngine::V1::Deployment
Parameter
Returns

#disk_usage_bytes

def disk_usage_bytes() -> ::Integer
Returns
  • (::Integer) — Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.

#disk_usage_bytes=

def disk_usage_bytes=(value) -> ::Integer
Parameter
  • value (::Integer) — Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.
Returns
  • (::Integer) — Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.

#endpoints_api_service

def endpoints_api_service() -> ::Google::Cloud::AppEngine::V1::EndpointsApiService
Returns

#endpoints_api_service=

def endpoints_api_service=(value) -> ::Google::Cloud::AppEngine::V1::EndpointsApiService
Parameter
Returns

#entrypoint

def entrypoint() -> ::Google::Cloud::AppEngine::V1::Entrypoint
Returns

#entrypoint=

def entrypoint=(value) -> ::Google::Cloud::AppEngine::V1::Entrypoint
Parameter
Returns

#env

def env() -> ::String
Returns
  • (::String) — App Engine execution environment for this version.

    Defaults to standard.

#env=

def env=(value) -> ::String
Parameter
  • value (::String) — App Engine execution environment for this version.

    Defaults to standard.

Returns
  • (::String) — App Engine execution environment for this version.

    Defaults to standard.

#env_variables

def env_variables() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Environment variables available to the application.

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

#env_variables=

def env_variables=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Environment variables available to the application.

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

Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Environment variables available to the application.

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

#error_handlers

def error_handlers() -> ::Array<::Google::Cloud::AppEngine::V1::ErrorHandler>
Returns

#error_handlers=

def error_handlers=(value) -> ::Array<::Google::Cloud::AppEngine::V1::ErrorHandler>
Parameter
Returns

#handlers

def handlers() -> ::Array<::Google::Cloud::AppEngine::V1::UrlMap>
Returns
  • (::Array<::Google::Cloud::AppEngine::V1::UrlMap>) — 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.

#handlers=

def handlers=(value) -> ::Array<::Google::Cloud::AppEngine::V1::UrlMap>
Parameter
  • value (::Array<::Google::Cloud::AppEngine::V1::UrlMap>) — 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.

Returns
  • (::Array<::Google::Cloud::AppEngine::V1::UrlMap>) — 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.

#health_check

def health_check() -> ::Google::Cloud::AppEngine::V1::HealthCheck
Returns
  • (::Google::Cloud::AppEngine::V1::HealthCheck) — 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.

#health_check=

def health_check=(value) -> ::Google::Cloud::AppEngine::V1::HealthCheck
Parameter
  • value (::Google::Cloud::AppEngine::V1::HealthCheck) — 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.

Returns
  • (::Google::Cloud::AppEngine::V1::HealthCheck) — 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.

#id

def id() -> ::String
Returns
  • (::String) — 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-".

#id=

def id=(value) -> ::String
Parameter
  • value (::String) — 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-".
Returns
  • (::String) — 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-".

#inbound_services

def inbound_services() -> ::Array<::Google::Cloud::AppEngine::V1::InboundServiceType>
Returns

#inbound_services=

def inbound_services=(value) -> ::Array<::Google::Cloud::AppEngine::V1::InboundServiceType>
Parameter
Returns

#instance_class

def instance_class() -> ::String
Returns
  • (::String) — 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.

#instance_class=

def instance_class=(value) -> ::String
Parameter
  • value (::String) — 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.

Returns
  • (::String) — 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.

#libraries

def libraries() -> ::Array<::Google::Cloud::AppEngine::V1::Library>
Returns
  • (::Array<::Google::Cloud::AppEngine::V1::Library>) — Configuration for third-party Python runtime libraries that are required by the application.

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

#libraries=

def libraries=(value) -> ::Array<::Google::Cloud::AppEngine::V1::Library>
Parameter
  • value (::Array<::Google::Cloud::AppEngine::V1::Library>) — Configuration for third-party Python runtime libraries that are required by the application.

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

Returns
  • (::Array<::Google::Cloud::AppEngine::V1::Library>) — Configuration for third-party Python runtime libraries that are required by the application.

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

#liveness_check

def liveness_check() -> ::Google::Cloud::AppEngine::V1::LivenessCheck
Returns

#liveness_check=

def liveness_check=(value) -> ::Google::Cloud::AppEngine::V1::LivenessCheck
Parameter
  • value (::Google::Cloud::AppEngine::V1::LivenessCheck) — 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.

Returns

#manual_scaling

def manual_scaling() -> ::Google::Cloud::AppEngine::V1::ManualScaling
Returns
  • (::Google::Cloud::AppEngine::V1::ManualScaling) — 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".

#manual_scaling=

def manual_scaling=(value) -> ::Google::Cloud::AppEngine::V1::ManualScaling
Parameter
  • value (::Google::Cloud::AppEngine::V1::ManualScaling) — 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".
Returns
  • (::Google::Cloud::AppEngine::V1::ManualScaling) — 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".

#name

def name() -> ::String
Returns
  • (::String) — Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.
Returns
  • (::String) — Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.

#network

def network() -> ::Google::Cloud::AppEngine::V1::Network
Returns

#network=

def network=(value) -> ::Google::Cloud::AppEngine::V1::Network
Parameter
Returns

#nobuild_files_regex

def nobuild_files_regex() -> ::String
Returns
  • (::String) — 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.

#nobuild_files_regex=

def nobuild_files_regex=(value) -> ::String
Parameter
  • value (::String) — 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.

Returns
  • (::String) — 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.

#readiness_check

def readiness_check() -> ::Google::Cloud::AppEngine::V1::ReadinessCheck
Returns

#readiness_check=

def readiness_check=(value) -> ::Google::Cloud::AppEngine::V1::ReadinessCheck
Parameter
  • value (::Google::Cloud::AppEngine::V1::ReadinessCheck) — 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.

Returns

#resources

def resources() -> ::Google::Cloud::AppEngine::V1::Resources
Returns

#resources=

def resources=(value) -> ::Google::Cloud::AppEngine::V1::Resources
Parameter
Returns

#runtime

def runtime() -> ::String
Returns
  • (::String) — Desired runtime. Example: python27.

#runtime=

def runtime=(value) -> ::String
Parameter
  • value (::String) — Desired runtime. Example: python27.
Returns
  • (::String) — Desired runtime. Example: python27.

#runtime_api_version

def runtime_api_version() -> ::String
Returns
  • (::String) — 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/

#runtime_api_version=

def runtime_api_version=(value) -> ::String
Parameter
  • value (::String) — 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/
Returns
  • (::String) — 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/

#runtime_channel

def runtime_channel() -> ::String
Returns
  • (::String) — The channel of the runtime to use. Only available for some runtimes. Defaults to the default channel.

#runtime_channel=

def runtime_channel=(value) -> ::String
Parameter
  • value (::String) — The channel of the runtime to use. Only available for some runtimes. Defaults to the default channel.
Returns
  • (::String) — The channel of the runtime to use. Only available for some runtimes. Defaults to the default channel.

#runtime_main_executable_path

def runtime_main_executable_path() -> ::String
Returns
  • (::String) — The path or name of the app's main executable.

#runtime_main_executable_path=

def runtime_main_executable_path=(value) -> ::String
Parameter
  • value (::String) — The path or name of the app's main executable.
Returns
  • (::String) — The path or name of the app's main executable.

#service_account

def service_account() -> ::String
Returns
  • (::String) — 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.

#service_account=

def service_account=(value) -> ::String
Parameter
  • value (::String) — 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.
Returns
  • (::String) — 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.

#serving_status

def serving_status() -> ::Google::Cloud::AppEngine::V1::ServingStatus
Returns
  • (::Google::Cloud::AppEngine::V1::ServingStatus) — 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.

#serving_status=

def serving_status=(value) -> ::Google::Cloud::AppEngine::V1::ServingStatus
Parameter
  • value (::Google::Cloud::AppEngine::V1::ServingStatus) — 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.

Returns
  • (::Google::Cloud::AppEngine::V1::ServingStatus) — 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.

#threadsafe

def threadsafe() -> ::Boolean
Returns
  • (::Boolean) — Whether multiple requests can be dispatched to this version at once.

#threadsafe=

def threadsafe=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Whether multiple requests can be dispatched to this version at once.
Returns
  • (::Boolean) — Whether multiple requests can be dispatched to this version at once.

#version_url

def version_url() -> ::String
Returns
  • (::String) — Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"

#version_url=

def version_url=(value) -> ::String
Parameter
  • value (::String) — Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"
Returns
  • (::String) — Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"

#vm

def vm() -> ::Boolean
Returns
  • (::Boolean) — Whether to deploy this version in a container on a virtual machine.

#vm=

def vm=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Whether to deploy this version in a container on a virtual machine.
Returns
  • (::Boolean) — Whether to deploy this version in a container on a virtual machine.

#vpc_access_connector

def vpc_access_connector() -> ::Google::Cloud::AppEngine::V1::VpcAccessConnector
Returns

#vpc_access_connector=

def vpc_access_connector=(value) -> ::Google::Cloud::AppEngine::V1::VpcAccessConnector
Parameter
Returns

#zones

def zones() -> ::Array<::String>
Returns
  • (::Array<::String>) — The Google Compute Engine zones that are supported by this version in the App Engine flexible environment. Deprecated.

#zones=

def zones=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — The Google Compute Engine zones that are supported by this version in the App Engine flexible environment. Deprecated.
Returns
  • (::Array<::String>) — The Google Compute Engine zones that are supported by this version in the App Engine flexible environment. Deprecated.