Class: Google::Apis::AppengineV1::Version

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Version

Returns a new instance of Version



1928
1929
1930
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1928

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

Returns:



1744
1745
1746
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1744

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

Returns:



1901
1902
1903
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1901

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

Returns:



1843
1844
1845
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1843

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

Returns:

  • (Hash<String,String>) 


1883
1884
1885
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1883

def beta_settings
  @beta_settings
end

#create_time ⇒ String

Time that this version was created.@OutputOnly Corresponds to the JSON property createTime

Returns:

  • (String) 


1797
1798
1799
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1797

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

Returns:

  • (String) 


1853
1854
1855
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1853

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

Returns:

  • (String) 


1823
1824
1825
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1823

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

Returns:



1792
1793
1794
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1792

def deployment
  @deployment
end

#disk_usage_bytes ⇒ Fixnum

Total size in bytes of all the files that are included in this version and curerntly hosted on the App Engine disk.@OutputOnly Corresponds to the JSON property diskUsageBytes

Returns:

  • (Fixnum) 


1907
1908
1909
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1907

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

Returns:



1753
1754
1755
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1753

def endpoints_api_service
  @endpoints_api_service
end

#env ⇒ String

App Engine execution environment for this version.Defaults to standard. Corresponds to the JSON property env

Returns:

  • (String) 


1888
1889
1890
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1888

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

Returns:

  • (Hash<String,String>) 


1866
1867
1868
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1866

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

Returns:



1814
1815
1816
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1814

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

Returns:



1895
1896
1897
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1895

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

Returns:



1914
1915
1916
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1914

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

Returns:

  • (String) 


1860
1861
1862
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1860

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

Returns:

  • (Array<String>) 


1803
1804
1805
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1803

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

Returns:

  • (String) 


1773
1774
1775
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1773

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

Returns:



1829
1830
1831
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1829

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

Returns:



1872
1873
1874
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1872

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

Returns:



1732
1733
1734
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1732

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

Returns:

  • (String) 


1738
1739
1740
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1738

def name
  @name
end

#network ⇒ Google::Apis::AppengineV1::Network

Extra network settings. Only applicable for VM runtimes. Corresponds to the JSON property network

Returns:



1877
1878
1879
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1877

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

Returns:

  • (String) 


1835
1836
1837
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1835

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

Returns:



1926
1927
1928
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1926

def readiness_check
  @readiness_check
end

#resources ⇒ Google::Apis::AppengineV1::Resources

Machine resources for a version. Corresponds to the JSON property resources

Returns:



1808
1809
1810
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1808

def resources
  @resources
end

#runtime ⇒ String

Desired runtime. Example: python27. Corresponds to the JSON property runtime

Returns:

  • (String) 


1848
1849
1850
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1848

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//config/appref Corresponds to the JSON property runtimeApiVersion

Returns:

  • (String) 


1787
1788
1789
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1787

def runtime_api_version
  @runtime_api_version
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

Returns:

  • (String) 


1780
1781
1782
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1780

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

Returns:

  • (Boolean) 


1919
1920
1921
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1919

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

Returns:

  • (String) 


1759
1760
1761
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1759

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

Returns:

  • (Boolean) 


1764
1765
1766
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1764

def vm
  @vm
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1933

def update!(**args)
  @manual_scaling = args[:manual_scaling] if args.key?(:manual_scaling)
  @name = args[:name] if args.key?(:name)
  @api_config = args[:api_config] if args.key?(:api_config)
  @endpoints_api_service = args[:endpoints_api_service] if args.key?(:endpoints_api_service)
  @version_url = args[:version_url] if args.key?(:version_url)
  @vm = args[:vm] if args.key?(:vm)
  @instance_class = args[:instance_class] if args.key?(:instance_class)
  @serving_status = args[:serving_status] if args.key?(:serving_status)
  @runtime_api_version = args[:runtime_api_version] if args.key?(:runtime_api_version)
  @deployment = args[:deployment] if args.key?(:deployment)
  @create_time = args[:create_time] if args.key?(:create_time)
  @inbound_services = args[:inbound_services] if args.key?(:inbound_services)
  @resources = args[:resources] if args.key?(:resources)
  @error_handlers = args[:error_handlers] if args.key?(:error_handlers)
  @default_expiration = args[:default_expiration] if args.key?(:default_expiration)
  @libraries = args[:libraries] if args.key?(:libraries)
  @nobuild_files_regex = args[:nobuild_files_regex] if args.key?(:nobuild_files_regex)
  @basic_scaling = args[:basic_scaling] if args.key?(:basic_scaling)
  @runtime = args[:runtime] if args.key?(:runtime)
  @created_by = args[:created_by] if args.key?(:created_by)
  @id = args[:id] if args.key?(:id)
  @env_variables = args[:env_variables] if args.key?(:env_variables)
  @liveness_check = args[:liveness_check] if args.key?(:liveness_check)
  @network = args[:network] if args.key?(:network)
  @beta_settings = args[:beta_settings] if args.key?(:beta_settings)
  @env = args[:env] if args.key?(:env)
  @handlers = args[:handlers] if args.key?(:handlers)
  @automatic_scaling = args[:automatic_scaling] if args.key?(:automatic_scaling)
  @disk_usage_bytes = args[:disk_usage_bytes] if args.key?(:disk_usage_bytes)
  @health_check = args[:health_check] if args.key?(:health_check)
  @threadsafe = args[:threadsafe] if args.key?(:threadsafe)
  @readiness_check = args[:readiness_check] if args.key?(:readiness_check)
end