Class: Google::Apis::AppengineV1beta::Version

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



3045
3046
3047
# File 'lib/google/apis/appengine_v1beta/classes.rb', line 3045

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

Instance Attribute Details

#api_configGoogle::Apis::AppengineV1beta::ApiConfigHandler

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



2801
2802
2803
# File 'lib/google/apis/appengine_v1beta/classes.rb', line 2801

def api_config
  @api_config
end

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


2807
2808
2809
# File 'lib/google/apis/appengine_v1beta/classes.rb', line 2807

def app_engine_apis
  @app_engine_apis
end

#automatic_scalingGoogle::Apis::AppengineV1beta::AutomaticScaling

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



2814
2815
2816
# File 'lib/google/apis/appengine_v1beta/classes.rb', line 2814

def automatic_scaling
  @automatic_scaling
end

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



2822
2823
2824
# File 'lib/google/apis/appengine_v1beta/classes.rb', line 2822

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


2828
2829
2830
# File 'lib/google/apis/appengine_v1beta/classes.rb', line 2828

def beta_settings
  @beta_settings
end

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


2834
2835
2836
# File 'lib/google/apis/appengine_v1beta/classes.rb', line 2834

def build_env_variables
  @build_env_variables
end

#create_timeString

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

Returns:

  • (String)


2839
2840
2841
# File 'lib/google/apis/appengine_v1beta/classes.rb', line 2839

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)


2844
2845
2846
# File 'lib/google/apis/appengine_v1beta/classes.rb', line 2844

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


2853
2854
2855
# File 'lib/google/apis/appengine_v1beta/classes.rb', line 2853

def default_expiration
  @default_expiration
end

#deploymentGoogle::Apis::AppengineV1beta::Deployment

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



2858
2859
2860
# File 'lib/google/apis/appengine_v1beta/classes.rb', line 2858

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)


2864
2865
2866
# File 'lib/google/apis/appengine_v1beta/classes.rb', line 2864

def disk_usage_bytes
  @disk_usage_bytes
end

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



2874
2875
2876
# File 'lib/google/apis/appengine_v1beta/classes.rb', line 2874

def endpoints_api_service
  @endpoints_api_service
end

#entrypointGoogle::Apis::AppengineV1beta::Entrypoint

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



2879
2880
2881
# File 'lib/google/apis/appengine_v1beta/classes.rb', line 2879

def entrypoint
  @entrypoint
end

#envString

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

Returns:

  • (String)


2884
2885
2886
# File 'lib/google/apis/appengine_v1beta/classes.rb', line 2884

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


2890
2891
2892
# File 'lib/google/apis/appengine_v1beta/classes.rb', line 2890

def env_variables
  @env_variables
end

#error_handlersArray<Google::Apis::AppengineV1beta::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



2896
2897
2898
# File 'lib/google/apis/appengine_v1beta/classes.rb', line 2896

def error_handlers
  @error_handlers
end

#handlersArray<Google::Apis::AppengineV1beta::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



2903
2904
2905
# File 'lib/google/apis/appengine_v1beta/classes.rb', line 2903

def handlers
  @handlers
end

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



2910
2911
2912
# File 'lib/google/apis/appengine_v1beta/classes.rb', line 2910

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)


2917
2918
2919
# File 'lib/google/apis/appengine_v1beta/classes.rb', line 2917

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


2923
2924
2925
# File 'lib/google/apis/appengine_v1beta/classes.rb', line 2923

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)


2931
2932
2933
# File 'lib/google/apis/appengine_v1beta/classes.rb', line 2931

def instance_class
  @instance_class
end

#librariesArray<Google::Apis::AppengineV1beta::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



2937
2938
2939
# File 'lib/google/apis/appengine_v1beta/classes.rb', line 2937

def libraries
  @libraries
end

#liveness_checkGoogle::Apis::AppengineV1beta::LivenessCheck

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



2943
2944
2945
# File 'lib/google/apis/appengine_v1beta/classes.rb', line 2943

def liveness_check
  @liveness_check
end

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



2949
2950
2951
# File 'lib/google/apis/appengine_v1beta/classes.rb', line 2949

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)


2955
2956
2957
# File 'lib/google/apis/appengine_v1beta/classes.rb', line 2955

def name
  @name
end

#networkGoogle::Apis::AppengineV1beta::Network

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



2960
2961
2962
# File 'lib/google/apis/appengine_v1beta/classes.rb', line 2960

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)


2966
2967
2968
# File 'lib/google/apis/appengine_v1beta/classes.rb', line 2966

def nobuild_files_regex
  @nobuild_files_regex
end

#readiness_checkGoogle::Apis::AppengineV1beta::ReadinessCheck

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



2972
2973
2974
# File 'lib/google/apis/appengine_v1beta/classes.rb', line 2972

def readiness_check
  @readiness_check
end

#resourcesGoogle::Apis::AppengineV1beta::Resources

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



2977
2978
2979
# File 'lib/google/apis/appengine_v1beta/classes.rb', line 2977

def resources
  @resources
end

#runtimeString

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

Returns:

  • (String)


2982
2983
2984
# File 'lib/google/apis/appengine_v1beta/classes.rb', line 2982

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)


2989
2990
2991
# File 'lib/google/apis/appengine_v1beta/classes.rb', line 2989

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)


2995
2996
2997
# File 'lib/google/apis/appengine_v1beta/classes.rb', line 2995

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)


3000
3001
3002
# File 'lib/google/apis/appengine_v1beta/classes.rb', line 3000

def runtime_main_executable_path
  @runtime_main_executable_path
end

#service_accountString

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)


3007
3008
3009
# File 'lib/google/apis/appengine_v1beta/classes.rb', line 3007

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


3014
3015
3016
# File 'lib/google/apis/appengine_v1beta/classes.rb', line 3014

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)


3019
3020
3021
# File 'lib/google/apis/appengine_v1beta/classes.rb', line 3019

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)


3026
3027
3028
# File 'lib/google/apis/appengine_v1beta/classes.rb', line 3026

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)


3031
3032
3033
# File 'lib/google/apis/appengine_v1beta/classes.rb', line 3031

def vm
  @vm
end

#vpc_access_connectorGoogle::Apis::AppengineV1beta::VpcAccessConnector

VPC access connector specification. Corresponds to the JSON property vpcAccessConnector



3037
3038
3039
# File 'lib/google/apis/appengine_v1beta/classes.rb', line 3037

def vpc_access_connector
  @vpc_access_connector
end

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


3043
3044
3045
# File 'lib/google/apis/appengine_v1beta/classes.rb', line 3043

def zones
  @zones
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
# File 'lib/google/apis/appengine_v1beta/classes.rb', line 3050

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