Class: Google::Apis::AppengineV1::Version

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/appengine_v1/classes.rb,
lib/google/apis/appengine_v1/representations.rb,
lib/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

Constructor Details

#initialize(**args) ⇒ Version

Returns a new instance of Version.



3411
3412
3413
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 3411

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

Instance Attribute Details

#api_config ⇒ Google::Apis::AppengineV1::ApiConfigHandler

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

Returns:



3155
3156
3157
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 3155

def api_config
  @api_config
end

#app_engine_apis ⇒ Boolean Also known as: app_engine_apis?

Allows App Engine second generation runtimes to access the legacy bundled services. Corresponds to the JSON property appEngineApis

Returns:

  • (Boolean) 


3161
3162
3163
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 3161

def app_engine_apis
  @app_engine_apis
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:



3168
3169
3170
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 3168

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:



3176
3177
3178
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 3176

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


3182
3183
3184
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 3182

def beta_settings
  @beta_settings
end

#build_env_variables ⇒ Hash<String,String>

Environment variables available to the build environment.Only returned in GET requests if view=FULL is set. Corresponds to the JSON property buildEnvVariables

Returns:

  • (Hash<String,String>) 


3188
3189
3190
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 3188

def build_env_variables
  @build_env_variables
end

#create_time ⇒ String

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

Returns:

  • (String) 


3193
3194
3195
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 3193

def create_time
  @create_time
end

#created_by ⇒ String

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

Returns:

  • (String) 


3198
3199
3200
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 3198

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) 


3207
3208
3209
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 3207

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:



3212
3213
3214
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 3212

def deployment
  @deployment
end

#disk_usage_bytes ⇒ Fixnum

Output only. 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) 


3218
3219
3220
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 3218

def disk_usage_bytes
  @disk_usage_bytes
end

#endpoints_api_service ⇒ Google::Apis::AppengineV1::EndpointsApiService

Google 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

Returns:



3228
3229
3230
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 3228

def endpoints_api_service
  @endpoints_api_service
end

#entrypoint ⇒ Google::Apis::AppengineV1::Entrypoint

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

Returns:



3233
3234
3235
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 3233

def entrypoint
  @entrypoint
end

#env ⇒ String

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

Returns:

  • (String) 


3238
3239
3240
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 3238

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


3244
3245
3246
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 3244

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:



3250
3251
3252
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 3250

def error_handlers
  @error_handlers
end

#flexible_runtime_settings ⇒ Google::Apis::AppengineV1::FlexibleRuntimeSettings

Runtime settings for the App Engine flexible environment. Corresponds to the JSON property flexibleRuntimeSettings

Returns:



3255
3256
3257
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 3255

def flexible_runtime_settings
  @flexible_runtime_settings
end

#generated_customer_metadata ⇒ Hash<String,Object>

Additional Google Generated Customer Metadata, this field won't be provided by default and can be requested by setting the IncludeExtraData field in GetVersionRequest Corresponds to the JSON property generatedCustomerMetadata

Returns:

  • (Hash<String,Object>) 


3262
3263
3264
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 3262

def generated_customer_metadata
  @generated_customer_metadata
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:



3269
3270
3271
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 3269

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:



3276
3277
3278
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 3276

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) 


3283
3284
3285
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 3283

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


3289
3290
3291
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 3289

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) 


3297
3298
3299
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 3297

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:



3303
3304
3305
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 3303

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:



3309
3310
3311
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 3309

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:



3315
3316
3317
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 3315

def manual_scaling
  @manual_scaling
end

#name ⇒ String

Output only. 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) 


3321
3322
3323
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 3321

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:



3326
3327
3328
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 3326

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) 


3332
3333
3334
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 3332

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:



3338
3339
3340
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 3338

def readiness_check
  @readiness_check
end

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

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

Returns:



3343
3344
3345
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 3343

def resources
  @resources
end

#runtime ⇒ String

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

Returns:

  • (String) 


3348
3349
3350
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 3348

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) 


3355
3356
3357
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 3355

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) 


3361
3362
3363
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 3361

def runtime_channel
  @runtime_channel
end

#runtime_main_executable_path ⇒ String

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

Returns:

  • (String) 


3366
3367
3368
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 3366

def runtime_main_executable_path
  @runtime_main_executable_path
end

#service_account ⇒ String

The identity that the deployed version will run as. Admin API will use the App Engine Appspot service account as default if this field is neither provided in app.yaml file nor through CLI flag. Corresponds to the JSON property serviceAccount

Returns:

  • (String) 


3373
3374
3375
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 3373

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


3380
3381
3382
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 3380

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) 


3385
3386
3387
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 3385

def threadsafe
  @threadsafe
end

#version_url ⇒ String

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

Returns:

  • (String) 


3392
3393
3394
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 3392

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) 


3397
3398
3399
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 3397

def vm
  @vm
end

#vpc_access_connector ⇒ Google::Apis::AppengineV1::VpcAccessConnector

VPC access connector specification. Corresponds to the JSON property vpcAccessConnector

Returns:



3403
3404
3405
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 3403

def vpc_access_connector
  @vpc_access_connector
end

#zones ⇒ Array<String>

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

Returns:

  • (Array<String>) 


3409
3410
3411
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 3409

def zones
  @zones
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 3416

def update!(**args)
  @api_config = args[:api_config] if args.key?(:api_config)
  @app_engine_apis = args[:app_engine_apis] if args.key?(:app_engine_apis)
  @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)
  @build_env_variables = args[:build_env_variables] if args.key?(:build_env_variables)
  @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)
  @flexible_runtime_settings = args[:flexible_runtime_settings] if args.key?(:flexible_runtime_settings)
  @generated_customer_metadata = args[:generated_customer_metadata] if args.key?(:generated_customer_metadata)
  @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)
  @service_account = args[:service_account] if args.key?(:service_account)
  @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)
  @vpc_access_connector = args[:vpc_access_connector] if args.key?(:vpc_access_connector)
  @zones = args[:zones] if args.key?(:zones)
end