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



1810
1811
1812
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1810

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:



1755
1756
1757
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1755

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:



1712
1713
1714
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1712

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:



1654
1655
1656
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1654

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


1694
1695
1696
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1694

def beta_settings
  @beta_settings
end

#create_time ⇒ String

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

Returns:

  • (String) 


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

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) 


1664
1665
1666
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1664

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) 


1634
1635
1636
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1634

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:



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

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) 


1718
1719
1720
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1718

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:



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

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) 


1699
1700
1701
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1699

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


1677
1678
1679
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1677

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:



1625
1626
1627
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1625

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:



1706
1707
1708
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1706

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:



1725
1726
1727
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1725

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) 


1671
1672
1673
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1671

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


1619
1620
1621
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1619

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) 


1784
1785
1786
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1784

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:



1640
1641
1642
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1640

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:



1683
1684
1685
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1683

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:



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

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) 


1749
1750
1751
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1749

def name
  @name
end

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

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

Returns:



1688
1689
1690
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1688

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) 


1646
1647
1648
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1646

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:



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

def readiness_check
  @readiness_check
end

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

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

Returns:



1613
1614
1615
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1613

def resources
  @resources
end

#runtime ⇒ String

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

Returns:

  • (String) 


1659
1660
1661
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1659

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) 


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

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) 


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

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) 


1730
1731
1732
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1730

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) 


1776
1777
1778
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1776

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) 


1769
1770
1771
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1769

def vm
  @vm
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1815

def update!(**args)
  @resources = args[:resources] if args.key?(:resources)
  @inbound_services = args[:inbound_services] if args.key?(:inbound_services)
  @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)
  @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)
  @vm = args[:vm] if args.key?(:vm)
  @version_url = args[:version_url] if args.key?(:version_url)
  @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)
end