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



2774
2775
2776
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2774

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:



2567
2568
2569
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2567

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:



2573
2574
2575
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2573

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:



2581
2582
2583
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2581

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


2587
2588
2589
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2587

def beta_settings
  @beta_settings
end

#create_time ⇒ String

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

Returns:

  • (String) 


2592
2593
2594
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2592

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) 


2597
2598
2599
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2597

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) 


2606
2607
2608
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2606

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:



2611
2612
2613
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2611

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

Returns:

  • (Fixnum) 


2617
2618
2619
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2617

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:



2626
2627
2628
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2626

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) 


2631
2632
2633
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2631

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


2637
2638
2639
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2637

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:



2643
2644
2645
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2643

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:



2650
2651
2652
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2650

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:



2657
2658
2659
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2657

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) 


2664
2665
2666
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2664

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


2670
2671
2672
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2670

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) 


2678
2679
2680
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2678

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:



2684
2685
2686
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2684

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:



2690
2691
2692
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2690

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:



2696
2697
2698
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2696

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) 


2702
2703
2704
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2702

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

Returns:



2707
2708
2709
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2707

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) 


2713
2714
2715
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2713

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:



2719
2720
2721
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2719

def readiness_check
  @readiness_check
end

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

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

Returns:



2724
2725
2726
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2724

def resources
  @resources
end

#runtime ⇒ String

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

Returns:

  • (String) 


2729
2730
2731
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2729

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) 


2736
2737
2738
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2736

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

Returns:

  • (String) 


2742
2743
2744
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2742

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


2749
2750
2751
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2749

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) 


2754
2755
2756
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2754

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) 


2761
2762
2763
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2761

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) 


2766
2767
2768
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2766

def vm
  @vm
end

#zones ⇒ Array<String>

The choice of gce zones to use for this App Engine Flexible version. Corresponds to the JSON property zones

Returns:

  • (Array<String>) 


2772
2773
2774
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2772

def zones
  @zones
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2779

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)
  @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)
  @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)
  @zones = args[:zones] if args.key?(:zones)
end