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



2962
2963
2964
# File 'generated/google/apis/appengine_v1/classes.rb', line 2962

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#api_configGoogle::Apis::AppengineV1::ApiConfigHandler

Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/ endpoints/) configuration for API handlers. Corresponds to the JSON property apiConfig



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

def api_config
  @api_config
end

#automatic_scalingGoogle::Apis::AppengineV1::AutomaticScaling

Automatic scaling is based on request rate, response latencies, and other application metrics. Corresponds to the JSON property automaticScaling



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

def automatic_scaling
  @automatic_scaling
end

#basic_scalingGoogle::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



2757
2758
2759
# File 'generated/google/apis/appengine_v1/classes.rb', line 2757

def basic_scaling
  @basic_scaling
end

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


2763
2764
2765
# File 'generated/google/apis/appengine_v1/classes.rb', line 2763

def beta_settings
  @beta_settings
end

#create_timeString

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

Returns:

  • (String)


2768
2769
2770
# File 'generated/google/apis/appengine_v1/classes.rb', line 2768

def create_time
  @create_time
end

#created_byString

Email address of the user who created this version.@OutputOnly Corresponds to the JSON property createdBy

Returns:

  • (String)


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

def created_by
  @created_by
end

#default_expirationString

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)


2782
2783
2784
# File 'generated/google/apis/appengine_v1/classes.rb', line 2782

def default_expiration
  @default_expiration
end

#deploymentGoogle::Apis::AppengineV1::Deployment

Code and application artifacts used to deploy a version to App Engine. Corresponds to the JSON property deployment



2787
2788
2789
# File 'generated/google/apis/appengine_v1/classes.rb', line 2787

def deployment
  @deployment
end

#disk_usage_bytesFixnum

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)


2793
2794
2795
# File 'generated/google/apis/appengine_v1/classes.rb', line 2793

def disk_usage_bytes
  @disk_usage_bytes
end

#endpoints_api_serviceGoogle::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



2803
2804
2805
# File 'generated/google/apis/appengine_v1/classes.rb', line 2803

def endpoints_api_service
  @endpoints_api_service
end

#entrypointGoogle::Apis::AppengineV1::Entrypoint

The entrypoint for the application. Corresponds to the JSON property entrypoint



2808
2809
2810
# File 'generated/google/apis/appengine_v1/classes.rb', line 2808

def entrypoint
  @entrypoint
end

#envString

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

Returns:

  • (String)


2813
2814
2815
# File 'generated/google/apis/appengine_v1/classes.rb', line 2813

def env
  @env
end

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


2819
2820
2821
# File 'generated/google/apis/appengine_v1/classes.rb', line 2819

def env_variables
  @env_variables
end

#error_handlersArray<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



2825
2826
2827
# File 'generated/google/apis/appengine_v1/classes.rb', line 2825

def error_handlers
  @error_handlers
end

#handlersArray<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



2832
2833
2834
# File 'generated/google/apis/appengine_v1/classes.rb', line 2832

def handlers
  @handlers
end

#health_checkGoogle::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



2839
2840
2841
# File 'generated/google/apis/appengine_v1/classes.rb', line 2839

def health_check
  @health_check
end

#idString

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)


2846
2847
2848
# File 'generated/google/apis/appengine_v1/classes.rb', line 2846

def id
  @id
end

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


2852
2853
2854
# File 'generated/google/apis/appengine_v1/classes.rb', line 2852

def inbound_services
  @inbound_services
end

#instance_classString

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)


2860
2861
2862
# File 'generated/google/apis/appengine_v1/classes.rb', line 2860

def instance_class
  @instance_class
end

#librariesArray<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



2866
2867
2868
# File 'generated/google/apis/appengine_v1/classes.rb', line 2866

def libraries
  @libraries
end

#liveness_checkGoogle::Apis::AppengineV1::LivenessCheck

Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Corresponds to the JSON property livenessCheck



2872
2873
2874
# File 'generated/google/apis/appengine_v1/classes.rb', line 2872

def liveness_check
  @liveness_check
end

#manual_scalingGoogle::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



2878
2879
2880
# File 'generated/google/apis/appengine_v1/classes.rb', line 2878

def manual_scaling
  @manual_scaling
end

#nameString

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)


2884
2885
2886
# File 'generated/google/apis/appengine_v1/classes.rb', line 2884

def name
  @name
end

#networkGoogle::Apis::AppengineV1::Network

Extra network settings. Only applicable in the App Engine flexible environment. Corresponds to the JSON property network



2889
2890
2891
# File 'generated/google/apis/appengine_v1/classes.rb', line 2889

def network
  @network
end

#nobuild_files_regexString

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)


2895
2896
2897
# File 'generated/google/apis/appengine_v1/classes.rb', line 2895

def nobuild_files_regex
  @nobuild_files_regex
end

#readiness_checkGoogle::Apis::AppengineV1::ReadinessCheck

Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation. Corresponds to the JSON property readinessCheck



2901
2902
2903
# File 'generated/google/apis/appengine_v1/classes.rb', line 2901

def readiness_check
  @readiness_check
end

#resourcesGoogle::Apis::AppengineV1::Resources

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



2906
2907
2908
# File 'generated/google/apis/appengine_v1/classes.rb', line 2906

def resources
  @resources
end

#runtimeString

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

Returns:

  • (String)


2911
2912
2913
# File 'generated/google/apis/appengine_v1/classes.rb', line 2911

def runtime
  @runtime
end

#runtime_api_versionString

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)


2918
2919
2920
# File 'generated/google/apis/appengine_v1/classes.rb', line 2918

def runtime_api_version
  @runtime_api_version
end

#runtime_channelString

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)


2924
2925
2926
# File 'generated/google/apis/appengine_v1/classes.rb', line 2924

def runtime_channel
  @runtime_channel
end

#runtime_main_executable_pathString

The path or name of the app's main executable. Corresponds to the JSON property runtimeMainExecutablePath

Returns:

  • (String)


2929
2930
2931
# File 'generated/google/apis/appengine_v1/classes.rb', line 2929

def runtime_main_executable_path
  @runtime_main_executable_path
end

#serving_statusString

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)


2936
2937
2938
# File 'generated/google/apis/appengine_v1/classes.rb', line 2936

def serving_status
  @serving_status
end

#threadsafeBoolean Also known as: threadsafe?

Whether multiple requests can be dispatched to this version at once. Corresponds to the JSON property threadsafe

Returns:

  • (Boolean)


2941
2942
2943
# File 'generated/google/apis/appengine_v1/classes.rb', line 2941

def threadsafe
  @threadsafe
end

#version_urlString

Serving URL for this version. Example: "https://myversion-dot-myservice-dot- myapp.appspot.com"@OutputOnly Corresponds to the JSON property versionUrl

Returns:

  • (String)


2948
2949
2950
# File 'generated/google/apis/appengine_v1/classes.rb', line 2948

def version_url
  @version_url
end

#vmBoolean Also known as: vm?

Whether to deploy this version in a container on a virtual machine. Corresponds to the JSON property vm

Returns:

  • (Boolean)


2953
2954
2955
# File 'generated/google/apis/appengine_v1/classes.rb', line 2953

def vm
  @vm
end

#zonesArray<String>

The Google Compute Engine zones that are supported by this version in the App Engine flexible environment. Corresponds to the JSON property zones

Returns:

  • (Array<String>)


2960
2961
2962
# File 'generated/google/apis/appengine_v1/classes.rb', line 2960

def zones
  @zones
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
# File 'generated/google/apis/appengine_v1/classes.rb', line 2967

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