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



898
899
900
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 898

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:



875
876
877
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 875

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:



832
833
834
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 832

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:



774
775
776
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 774

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


814
815
816
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 814

def beta_settings
  @beta_settings
end

#create_time ⇒ String

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

Returns:

  • (String) 


728
729
730
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 728

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) 


784
785
786
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 784

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) 


754
755
756
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 754

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:



723
724
725
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 723

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) 


838
839
840
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 838

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:



884
885
886
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 884

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) 


819
820
821
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 819

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


797
798
799
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 797

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:



745
746
747
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 745

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:



826
827
828
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 826

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:



845
846
847
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 845

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) 


791
792
793
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 791

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


739
740
741
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 739

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) 


711
712
713
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 711

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:



760
761
762
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 760

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:



803
804
805
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 803

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:



863
864
865
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 863

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) 


869
870
871
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 869

def name
  @name
end

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

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

Returns:



808
809
810
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 808

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) 


766
767
768
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 766

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:



857
858
859
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 857

def readiness_check
  @readiness_check
end

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

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

Returns:



733
734
735
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 733

def resources
  @resources
end

#runtime ⇒ String

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

Returns:

  • (String) 


779
780
781
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 779

def runtime
  @runtime
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) 


718
719
720
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 718

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) 


850
851
852
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 850

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) 


890
891
892
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 890

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) 


895
896
897
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 895

def vm
  @vm
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 903

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