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



1330
1331
1332
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1330

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:



1184
1185
1186
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1184

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:



1141
1142
1143
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1141

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:



1276
1277
1278
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1276

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


1316
1317
1318
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1316

def beta_settings
  @beta_settings
end

#create_time ⇒ String

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

Returns:

  • (String) 


1230
1231
1232
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1230

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) 


1293
1294
1295
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1293

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) 


1256
1257
1258
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1256

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:



1225
1226
1227
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1225

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) 


1147
1148
1149
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1147

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:



1193
1194
1195
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1193

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) 


1321
1322
1323
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1321

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


1299
1300
1301
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1299

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:



1247
1248
1249
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1247

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:



1328
1329
1330
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1328

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:



1154
1155
1156
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1154

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) 


1288
1289
1290
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1288

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


1236
1237
1238
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1236

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) 


1213
1214
1215
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1213

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:



1262
1263
1264
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1262

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:



1305
1306
1307
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1305

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:



1172
1173
1174
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1172

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) 


1178
1179
1180
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1178

def name
  @name
end

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

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

Returns:



1310
1311
1312
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1310

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) 


1268
1269
1270
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1268

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:



1166
1167
1168
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1166

def readiness_check
  @readiness_check
end

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

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

Returns:



1241
1242
1243
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1241

def resources
  @resources
end

#runtime ⇒ String

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

Returns:

  • (String) 


1281
1282
1283
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1281

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) 


1220
1221
1222
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1220

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) 


1159
1160
1161
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1159

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) 


1199
1200
1201
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1199

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) 


1204
1205
1206
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1204

def vm
  @vm
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1335

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