Class: Google::Apis::AppengineV1::Version
- Inherits:
-
Object
- Object
- Google::Apis::AppengineV1::Version
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/appengine_v1/classes.rb,
generated/google/apis/appengine_v1/representations.rb,
generated/google/apis/appengine_v1/representations.rb
Overview
A Version resource is a specific set of source code and configuration files that are deployed into a service.
Instance Attribute Summary collapse
-
#api_config ⇒ Google::Apis::AppengineV1::ApiConfigHandler
Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/ endpoints/) configuration for API handlers.
-
#automatic_scaling ⇒ Google::Apis::AppengineV1::AutomaticScaling
Automatic scaling is based on request rate, response latencies, and other application metrics.
-
#basic_scaling ⇒ Google::Apis::AppengineV1::BasicScaling
A service with basic scaling will create an instance when the application receives a request.
-
#beta_settings ⇒ Hash<String,String>
Metadata settings that are supplied to this version to enable beta runtime features.
-
#create_time ⇒ String
Time that this version was created.@OutputOnly Corresponds to the JSON property
createTime
. -
#created_by ⇒ String
Email address of the user who created this version.@OutputOnly Corresponds to the JSON property
createdBy
. -
#default_expiration ⇒ String
Duration that static files should be cached by web proxies and browsers.
-
#deployment ⇒ Google::Apis::AppengineV1::Deployment
Code and application artifacts used to deploy a version to App Engine.
-
#disk_usage_bytes ⇒ Fixnum
Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly Corresponds to the JSON property
diskUsageBytes
. -
#endpoints_api_service ⇒ Google::Apis::AppengineV1::EndpointsApiService
Cloud Endpoints (https://cloud.google.com/endpoints) configuration.
-
#entrypoint ⇒ Google::Apis::AppengineV1::Entrypoint
The entrypoint for the application.
-
#env ⇒ String
App Engine execution environment for this version.Defaults to standard.
-
#env_variables ⇒ Hash<String,String>
Environment variables available to the application.Only returned in GET requests if view=FULL is set.
-
#error_handlers ⇒ Array<Google::Apis::AppengineV1::ErrorHandler>
Custom static error pages.
-
#handlers ⇒ Array<Google::Apis::AppengineV1::UrlMap>
An ordered list of URL-matching patterns that should be applied to incoming requests.
-
#health_check ⇒ Google::Apis::AppengineV1::HealthCheck
Health checking configuration for VM instances.
-
#id ⇒ String
Relative name of the version within the service.
-
#inbound_services ⇒ Array<String>
Before an application can receive email or XMPP messages, the application must be configured to enable the service.
-
#instance_class ⇒ String
Instance class that is used to run this version.
-
#libraries ⇒ Array<Google::Apis::AppengineV1::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 ⇒ Google::Apis::AppengineV1::LivenessCheck
Health checking configuration for VM instances.
-
#manual_scaling ⇒ Google::Apis::AppengineV1::ManualScaling
A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.
-
#name ⇒ String
Full path to the Version resource in the API.
-
#network ⇒ Google::Apis::AppengineV1::Network
Extra network settings.
-
#nobuild_files_regex ⇒ String
Files that match this pattern will not be built into this version.
-
#readiness_check ⇒ Google::Apis::AppengineV1::ReadinessCheck
Readiness checking configuration for VM instances.
-
#resources ⇒ Google::Apis::AppengineV1::Resources
Machine resources for a version.
-
#runtime ⇒ String
Desired runtime.
-
#runtime_api_version ⇒ String
The version of the API in the given runtime environment.
-
#runtime_channel ⇒ String
The channel of the runtime to use.
-
#runtime_main_executable_path ⇒ String
The path or name of the app's main executable.
-
#serving_status ⇒ String
Current serving status of this version.
-
#threadsafe ⇒ Boolean
(also: #threadsafe?)
Whether multiple requests can be dispatched to this version at once.
-
#version_url ⇒ String
Serving URL for this version.
-
#vm ⇒ Boolean
(also: #vm?)
Whether to deploy this version in a container on a virtual machine.
-
#vpc_access_connector ⇒ Google::Apis::AppengineV1::VpcAccessConnector
VPC access connector specification.
-
#zones ⇒ Array<String>
The Google Compute Engine zones that are supported by this version in the App Engine flexible environment.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Version
constructor
A new instance of Version.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ Version
Returns a new instance of Version.
2830 2831 2832 |
# File 'generated/google/apis/appengine_v1/classes.rb', line 2830 def initialize(**args) update!(**args) end |
Instance Attribute Details
#api_config ⇒ Google::Apis::AppengineV1::ApiConfigHandler
Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/
endpoints/) configuration for API handlers.
Corresponds to the JSON property apiConfig
2606 2607 2608 |
# File 'generated/google/apis/appengine_v1/classes.rb', line 2606 def api_config @api_config end |
#automatic_scaling ⇒ Google::Apis::AppengineV1::AutomaticScaling
Automatic scaling is based on request rate, response latencies, and other
application metrics.
Corresponds to the JSON property automaticScaling
2612 2613 2614 |
# File 'generated/google/apis/appengine_v1/classes.rb', line 2612 def automatic_scaling @automatic_scaling end |
#basic_scaling ⇒ Google::Apis::AppengineV1::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.
Corresponds to the JSON property basicScaling
2620 2621 2622 |
# File 'generated/google/apis/appengine_v1/classes.rb', line 2620 def basic_scaling @basic_scaling end |
#beta_settings ⇒ Hash<String,String>
Metadata settings that are supplied to this version to enable beta runtime
features.
Corresponds to the JSON property betaSettings
2626 2627 2628 |
# File 'generated/google/apis/appengine_v1/classes.rb', line 2626 def beta_settings @beta_settings end |
#create_time ⇒ String
Time that this version was created.@OutputOnly
Corresponds to the JSON property createTime
2631 2632 2633 |
# File 'generated/google/apis/appengine_v1/classes.rb', line 2631 def create_time @create_time end |
#created_by ⇒ String
Email address of the user who created this version.@OutputOnly
Corresponds to the JSON property createdBy
2636 2637 2638 |
# File 'generated/google/apis/appengine_v1/classes.rb', line 2636 def created_by @created_by end |
#default_expiration ⇒ String
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.
Corresponds to the JSON property defaultExpiration
2645 2646 2647 |
# File 'generated/google/apis/appengine_v1/classes.rb', line 2645 def default_expiration @default_expiration end |
#deployment ⇒ Google::Apis::AppengineV1::Deployment
Code and application artifacts used to deploy a version to App Engine.
Corresponds to the JSON property deployment
2650 2651 2652 |
# File 'generated/google/apis/appengine_v1/classes.rb', line 2650 def deployment @deployment end |
#disk_usage_bytes ⇒ Fixnum
Total size in bytes of all the files that are included in this version and
currently hosted on the App Engine disk.@OutputOnly
Corresponds to the JSON property diskUsageBytes
2656 2657 2658 |
# File 'generated/google/apis/appengine_v1/classes.rb', line 2656 def disk_usage_bytes @disk_usage_bytes end |
#endpoints_api_service ⇒ Google::Apis::AppengineV1::EndpointsApiService
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).
Corresponds to the JSON property endpointsApiService
2666 2667 2668 |
# File 'generated/google/apis/appengine_v1/classes.rb', line 2666 def endpoints_api_service @endpoints_api_service end |
#entrypoint ⇒ Google::Apis::AppengineV1::Entrypoint
The entrypoint for the application.
Corresponds to the JSON property entrypoint
2671 2672 2673 |
# File 'generated/google/apis/appengine_v1/classes.rb', line 2671 def entrypoint @entrypoint end |
#env ⇒ String
App Engine execution environment for this version.Defaults to standard.
Corresponds to the JSON property env
2676 2677 2678 |
# File 'generated/google/apis/appengine_v1/classes.rb', line 2676 def env @env end |
#env_variables ⇒ Hash<String,String>
Environment variables available to the application.Only returned in GET
requests if view=FULL is set.
Corresponds to the JSON property envVariables
2682 2683 2684 |
# File 'generated/google/apis/appengine_v1/classes.rb', line 2682 def env_variables @env_variables end |
#error_handlers ⇒ Array<Google::Apis::AppengineV1::ErrorHandler>
Custom static error pages. Limited to 10KB per page.Only returned in GET
requests if view=FULL is set.
Corresponds to the JSON property errorHandlers
2688 2689 2690 |
# File 'generated/google/apis/appengine_v1/classes.rb', line 2688 def error_handlers @error_handlers end |
#handlers ⇒ Array<Google::Apis::AppengineV1::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.
Corresponds to the JSON property handlers
2695 2696 2697 |
# File 'generated/google/apis/appengine_v1/classes.rb', line 2695 def handlers @handlers end |
#health_check ⇒ Google::Apis::AppengineV1::HealthCheck
Health checking configuration for VM instances. Unhealthy instances are killed
and replaced with new instances. Only applicable for instances in App Engine
flexible environment.
Corresponds to the JSON property healthCheck
2702 2703 2704 |
# File 'generated/google/apis/appengine_v1/classes.rb', line 2702 def health_check @health_check end |
#id ⇒ 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-".
Corresponds to the JSON property id
2709 2710 2711 |
# File 'generated/google/apis/appengine_v1/classes.rb', line 2709 def id @id end |
#inbound_services ⇒ Array<String>
Before an application can receive email or XMPP messages, the application must
be configured to enable the service.
Corresponds to the JSON property inboundServices
2715 2716 2717 |
# File 'generated/google/apis/appengine_v1/classes.rb', line 2715 def inbound_services @inbound_services end |
#instance_class ⇒ 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_1GDefaults to F1 for
AutomaticScaling and B1 for ManualScaling or BasicScaling.
Corresponds to the JSON property instanceClass
2723 2724 2725 |
# File 'generated/google/apis/appengine_v1/classes.rb', line 2723 def instance_class @instance_class end |
#libraries ⇒ Array<Google::Apis::AppengineV1::Library>
Configuration for third-party Python runtime libraries that are required by
the application.Only returned in GET requests if view=FULL is set.
Corresponds to the JSON property libraries
2729 2730 2731 |
# File 'generated/google/apis/appengine_v1/classes.rb', line 2729 def libraries @libraries end |
#liveness_check ⇒ Google::Apis::AppengineV1::LivenessCheck
Health checking configuration for VM instances. Unhealthy instances are killed
and replaced with new instances.
Corresponds to the JSON property livenessCheck
2735 2736 2737 |
# File 'generated/google/apis/appengine_v1/classes.rb', line 2735 def liveness_check @liveness_check end |
#manual_scaling ⇒ Google::Apis::AppengineV1::ManualScaling
A service with manual scaling runs continuously, allowing you to perform
complex initialization and rely on the state of its memory over time.
Corresponds to the JSON property manualScaling
2741 2742 2743 |
# File 'generated/google/apis/appengine_v1/classes.rb', line 2741 def manual_scaling @manual_scaling end |
#name ⇒ String
Full path to the Version resource in the API. Example: apps/myapp/services/
default/versions/v1.@OutputOnly
Corresponds to the JSON property name
2747 2748 2749 |
# File 'generated/google/apis/appengine_v1/classes.rb', line 2747 def name @name end |
#network ⇒ Google::Apis::AppengineV1::Network
Extra network settings. Only applicable in the App Engine flexible environment.
Corresponds to the JSON property network
2752 2753 2754 |
# File 'generated/google/apis/appengine_v1/classes.rb', line 2752 def network @network end |
#nobuild_files_regex ⇒ 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.
Corresponds to the JSON property nobuildFilesRegex
2758 2759 2760 |
# File 'generated/google/apis/appengine_v1/classes.rb', line 2758 def nobuild_files_regex @nobuild_files_regex end |
#readiness_check ⇒ Google::Apis::AppengineV1::ReadinessCheck
Readiness checking configuration for VM instances. Unhealthy instances are
removed from traffic rotation.
Corresponds to the JSON property readinessCheck
2764 2765 2766 |
# File 'generated/google/apis/appengine_v1/classes.rb', line 2764 def readiness_check @readiness_check end |
#resources ⇒ Google::Apis::AppengineV1::Resources
Machine resources for a version.
Corresponds to the JSON property resources
2769 2770 2771 |
# File 'generated/google/apis/appengine_v1/classes.rb', line 2769 def resources @resources end |
#runtime ⇒ String
Desired runtime. Example: python27.
Corresponds to the JSON property runtime
2774 2775 2776 |
# File 'generated/google/apis/appengine_v1/classes.rb', line 2774 def runtime @runtime end |
#runtime_api_version ⇒ 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/runtimeApiVersion
2781 2782 2783 |
# File 'generated/google/apis/appengine_v1/classes.rb', line 2781 def runtime_api_version @runtime_api_version end |
#runtime_channel ⇒ String
The channel of the runtime to use. Only available for some runtimes. Defaults
to the default channel.
Corresponds to the JSON property runtimeChannel
2787 2788 2789 |
# File 'generated/google/apis/appengine_v1/classes.rb', line 2787 def runtime_channel @runtime_channel end |
#runtime_main_executable_path ⇒ String
The path or name of the app's main executable.
Corresponds to the JSON property runtimeMainExecutablePath
2792 2793 2794 |
# File 'generated/google/apis/appengine_v1/classes.rb', line 2792 def runtime_main_executable_path @runtime_main_executable_path end |
#serving_status ⇒ String
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.
Corresponds to the JSON property servingStatus
2799 2800 2801 |
# File 'generated/google/apis/appengine_v1/classes.rb', line 2799 def serving_status @serving_status end |
#threadsafe ⇒ Boolean Also known as: threadsafe?
Whether multiple requests can be dispatched to this version at once.
Corresponds to the JSON property threadsafe
2804 2805 2806 |
# File 'generated/google/apis/appengine_v1/classes.rb', line 2804 def threadsafe @threadsafe end |
#version_url ⇒ String
Serving URL for this version. Example: "https://myversion-dot-myservice-dot-
myapp.appspot.com"@OutputOnly
Corresponds to the JSON property versionUrl
2811 2812 2813 |
# File 'generated/google/apis/appengine_v1/classes.rb', line 2811 def version_url @version_url end |
#vm ⇒ Boolean Also known as: vm?
Whether to deploy this version in a container on a virtual machine.
Corresponds to the JSON property vm
2816 2817 2818 |
# File 'generated/google/apis/appengine_v1/classes.rb', line 2816 def vm @vm end |
#vpc_access_connector ⇒ Google::Apis::AppengineV1::VpcAccessConnector
VPC access connector specification.
Corresponds to the JSON property vpcAccessConnector
2822 2823 2824 |
# File 'generated/google/apis/appengine_v1/classes.rb', line 2822 def vpc_access_connector @vpc_access_connector end |
#zones ⇒ Array<String>
The Google Compute Engine zones that are supported by this version in the App
Engine flexible environment. Deprecated.
Corresponds to the JSON property zones
2828 2829 2830 |
# File 'generated/google/apis/appengine_v1/classes.rb', line 2828 def zones @zones end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 |
# File 'generated/google/apis/appengine_v1/classes.rb', line 2835 def update!(**args) @api_config = args[:api_config] if args.key?(:api_config) @automatic_scaling = args[:automatic_scaling] if args.key?(:automatic_scaling) @basic_scaling = args[:basic_scaling] if args.key?(:basic_scaling) @beta_settings = args[:beta_settings] if args.key?(:beta_settings) @create_time = args[:create_time] if args.key?(:create_time) @created_by = args[:created_by] if args.key?(:created_by) @default_expiration = args[:default_expiration] if args.key?(:default_expiration) @deployment = args[:deployment] if args.key?(:deployment) @disk_usage_bytes = args[:disk_usage_bytes] if args.key?(:disk_usage_bytes) @endpoints_api_service = args[:endpoints_api_service] if args.key?(:endpoints_api_service) @entrypoint = args[:entrypoint] if args.key?(:entrypoint) @env = args[:env] if args.key?(:env) @env_variables = args[:env_variables] if args.key?(:env_variables) @error_handlers = args[:error_handlers] if args.key?(:error_handlers) @handlers = args[:handlers] if args.key?(:handlers) @health_check = args[:health_check] if args.key?(:health_check) @id = args[:id] if args.key?(:id) @inbound_services = args[:inbound_services] if args.key?(:inbound_services) @instance_class = args[:instance_class] if args.key?(:instance_class) @libraries = args[:libraries] if args.key?(:libraries) @liveness_check = args[:liveness_check] if args.key?(:liveness_check) @manual_scaling = args[:manual_scaling] if args.key?(:manual_scaling) @name = args[:name] if args.key?(:name) @network = args[:network] if args.key?(:network) @nobuild_files_regex = args[:nobuild_files_regex] if args.key?(:nobuild_files_regex) @readiness_check = args[:readiness_check] if args.key?(:readiness_check) @resources = args[:resources] if args.key?(:resources) @runtime = args[:runtime] if args.key?(:runtime) @runtime_api_version = args[:runtime_api_version] if args.key?(:runtime_api_version) @runtime_channel = args[:runtime_channel] if args.key?(:runtime_channel) @runtime_main_executable_path = args[:runtime_main_executable_path] if args.key?(:runtime_main_executable_path) @serving_status = args[:serving_status] if args.key?(:serving_status) @threadsafe = args[:threadsafe] if args.key?(:threadsafe) @version_url = args[:version_url] if args.key?(:version_url) @vm = args[:vm] if args.key?(:vm) @vpc_access_connector = args[:vpc_access_connector] if args.key?(:vpc_access_connector) @zones = args[:zones] if args.key?(:zones) end |