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



1070
1071
1072
# File 'generated/google/apis/appengine_v1/classes.rb', line 1070

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



940
941
942
# File 'generated/google/apis/appengine_v1/classes.rb', line 940

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



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

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



1039
1040
1041
# File 'generated/google/apis/appengine_v1/classes.rb', line 1039

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


879
880
881
# File 'generated/google/apis/appengine_v1/classes.rb', line 879

def beta_settings
  @beta_settings
end

#create_timeString

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

Returns:

  • (String)


993
994
995
# File 'generated/google/apis/appengine_v1/classes.rb', line 993

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)


1056
1057
1058
# File 'generated/google/apis/appengine_v1/classes.rb', line 1056

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)


1019
1020
1021
# File 'generated/google/apis/appengine_v1/classes.rb', line 1019

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



988
989
990
# File 'generated/google/apis/appengine_v1/classes.rb', line 988

def deployment
  @deployment
end

#disk_usage_bytesFixnum

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)


903
904
905
# File 'generated/google/apis/appengine_v1/classes.rb', line 903

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



949
950
951
# File 'generated/google/apis/appengine_v1/classes.rb', line 949

def endpoints_api_service
  @endpoints_api_service
end

#envString

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

Returns:

  • (String)


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

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


1062
1063
1064
# File 'generated/google/apis/appengine_v1/classes.rb', line 1062

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



1010
1011
1012
# File 'generated/google/apis/appengine_v1/classes.rb', line 1010

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



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

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



910
911
912
# File 'generated/google/apis/appengine_v1/classes.rb', line 910

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)


1051
1052
1053
# File 'generated/google/apis/appengine_v1/classes.rb', line 1051

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


999
1000
1001
# File 'generated/google/apis/appengine_v1/classes.rb', line 999

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)


969
970
971
# File 'generated/google/apis/appengine_v1/classes.rb', line 969

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



1025
1026
1027
# File 'generated/google/apis/appengine_v1/classes.rb', line 1025

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



1068
1069
1070
# File 'generated/google/apis/appengine_v1/classes.rb', line 1068

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



928
929
930
# File 'generated/google/apis/appengine_v1/classes.rb', line 928

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)


934
935
936
# File 'generated/google/apis/appengine_v1/classes.rb', line 934

def name
  @name
end

#networkGoogle::Apis::AppengineV1::Network

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



873
874
875
# File 'generated/google/apis/appengine_v1/classes.rb', line 873

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)


1031
1032
1033
# File 'generated/google/apis/appengine_v1/classes.rb', line 1031

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



922
923
924
# File 'generated/google/apis/appengine_v1/classes.rb', line 922

def readiness_check
  @readiness_check
end

#resourcesGoogle::Apis::AppengineV1::Resources

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



1004
1005
1006
# File 'generated/google/apis/appengine_v1/classes.rb', line 1004

def resources
  @resources
end

#runtimeString

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

Returns:

  • (String)


1044
1045
1046
# File 'generated/google/apis/appengine_v1/classes.rb', line 1044

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)


983
984
985
# File 'generated/google/apis/appengine_v1/classes.rb', line 983

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


976
977
978
# File 'generated/google/apis/appengine_v1/classes.rb', line 976

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)


915
916
917
# File 'generated/google/apis/appengine_v1/classes.rb', line 915

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)


955
956
957
# File 'generated/google/apis/appengine_v1/classes.rb', line 955

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)


960
961
962
# File 'generated/google/apis/appengine_v1/classes.rb', line 960

def vm
  @vm
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
# File 'generated/google/apis/appengine_v1/classes.rb', line 1075

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