Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses: serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment. instance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment. automatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment. automatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.

Scopes

You will need authorization for the https://www.googleapis.com/auth/cloud-platform scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: appengine1-beta4 --scope <scope> apps modules-versions-patch ...

Required Scalar Arguments

  • <apps-id> (string)
    • Part of name. Name of the resource to update. Example: apps/myapp/modules/default/versions/1.
  • <modules-id> (string)
    • Part of name. See documentation of appsId.
  • <versions-id> (string)
    • Part of name. See documentation of appsId.

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

Version:
  api-config:
    auth-fail-action: string
    login: string
    script: string
    security-level: string
    url: string
  automatic-scaling:
    cool-down-period: string
    cpu-utilization:
      aggregation-window-length: string
      target-utilization: number
    disk-utilization:
      target-read-bytes-per-sec: integer
      target-read-ops-per-sec: integer
      target-write-bytes-per-sec: integer
      target-write-ops-per-sec: integer
    max-concurrent-requests: integer
    max-idle-instances: integer
    max-pending-latency: string
    max-total-instances: integer
    min-idle-instances: integer
    min-pending-latency: string
    min-total-instances: integer
    network-utilization:
      target-received-bytes-per-sec: integer
      target-received-packets-per-sec: integer
      target-sent-bytes-per-sec: integer
      target-sent-packets-per-sec: integer
    request-utilization:
      target-concurrent-requests: integer
      target-request-count-per-sec: integer
  basic-scaling:
    idle-timeout: string
    max-instances: integer
  beta-settings: { string: string }
  creation-time: string
  default-expiration: string
  deployer: string
  deployment:
    container:
      image: string
  endpoints-api-service:
    config-id: string
    disable-trace-sampling: boolean
    name: string
    rollout-strategy: string
  env: string
  env-variables: { string: string }
  health-check:
    check-interval: string
    disable-health-check: boolean
    healthy-threshold: integer
    host: string
    restart-threshold: integer
    timeout: string
    unhealthy-threshold: integer
  id: string
  inbound-services: [string]
  instance-class: string
  manual-scaling:
    instances: integer
  name: string
  network:
    forwarded-ports: [string]
    instance-tag: string
    name: string
  nobuild-files-regex: string
  resources:
    cpu: number
    disk-gb: number
    memory-gb: number
  runtime: string
  runtime-api-version: string
  serving-status: string
  threadsafe: boolean
  vm: boolean

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r .api-config auth-fail-action=voluptua.
    • Action to take when users access resources that require authentication. Defaults to redirect.
  • login=dolore
    • Level of login required to access this resource. Defaults to optional.
  • script=dolore
    • Path to the script from the application root directory.
  • security-level=dolore
    • Security (HTTPS) enforcement for this URL.

  • url=voluptua.

    • URL to serve the endpoint at.

  • ..automatic-scaling cool-down-period=amet.

    • The time period that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. Only applicable in the App Engine flexible environment.
  • cpu-utilization aggregation-window-length=ea
    • Period of time over which CPU utilization is calculated.

  • target-utilization=0.05043422241780038

    • Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.

  • ..disk-utilization target-read-bytes-per-sec=63

    • Target bytes read per second.
  • target-read-ops-per-sec=90
    • Target ops read per second.
  • target-write-bytes-per-sec=94
    • Target bytes written per second.

  • target-write-ops-per-sec=74

    • Target ops written per second.

  • .. max-concurrent-requests=58

    • Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.
  • max-idle-instances=3
    • Maximum number of idle instances that should be maintained for this version.
  • max-pending-latency=et
    • Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
  • max-total-instances=62
    • Maximum number of instances that should be started to handle requests.
  • min-idle-instances=69
    • Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a module.
  • min-pending-latency=ipsum
    • Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
  • min-total-instances=83
    • Minimum number of instances that should be maintained for this version.
  • network-utilization target-received-bytes-per-sec=93
    • Target bytes received per second.
  • target-received-packets-per-sec=45
    • Target packets received per second.
  • target-sent-bytes-per-sec=94
    • Target bytes sent per second.

  • target-sent-packets-per-sec=71

    • Target packets sent per second.

  • ..request-utilization target-concurrent-requests=72

    • Target number of concurrent requests.

  • target-request-count-per-sec=82

    • Target requests per second.

  • ...basic-scaling idle-timeout=dolores

    • Duration of time after the last request that an instance must wait before the instance is shut down.

  • max-instances=33

    • Maximum number of instances to create for this version.

  • .. beta-settings=key=sed

    • Metadata settings that are supplied to this version to enable beta runtime features.
    • the value will be associated with the given key
  • creation-time=no
    • Time that this version was created.@OutputOnly
  • default-expiration=et
    • 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.
  • deployer=elitr
    • Email address of the user who created this version.@OutputOnly

  • deployment.container image=sed

    • URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"

  • ...endpoints-api-service config-id=no

    • Endpoints service configuration id as specified by the Service Management API. For example "2016-09-19r1"By default, the Endpoints service configuration id is fixed and config_id must be specified. To keep the Endpoints service configuration id updated with each rollout, specify RolloutStrategy.MANAGED and omit config_id.
  • disable-trace-sampling=false
    • Enable or disable trace sampling. By default, this is set to false for enabled.
  • name=at
    • Endpoints service name which is the name of the "service" resource in the Service Management API. For example "myapi.endpoints.myproject.cloud.goog"

  • rollout-strategy=sadipscing

    • Endpoints rollout strategy. If FIXED, config_id must be specified. If MANAGED, config_id must be omitted.

  • .. env=aliquyam

    • App Engine execution environment to use for this version.Defaults to 1.
  • env-variables=key=dolores
    • Environment variables made available to the application.Only returned in GET requests if view=FULL is set.
    • the value will be associated with the given key
  • health-check check-interval=sadipscing
    • Interval between health checks.
  • disable-health-check=false
    • Whether to explicitly disable health checks for this instance.
  • healthy-threshold=54
    • Number of consecutive successful health checks required before receiving traffic.
  • host=est
    • Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"
  • restart-threshold=77
    • Number of consecutive failed health checks required before an instance is restarted.
  • timeout=sea
    • Time before the health check is considered failed.

  • unhealthy-threshold=5

    • Number of consecutive failed health checks required before removing traffic.

  • .. id=consetetur

    • Relative name of the version within the module. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-".
  • inbound-services=stet
    • Before an application can receive email or XMPP messages, the application must be configured to enable the service.
    • Each invocation of this argument appends the given value to the array.
  • instance-class=est
    • 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.

  • manual-scaling instances=19

    • Number of instances to assign to the module at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function.

  • .. name=elitr

    • Full path to the Version resource in the API. Example: apps/myapp/modules/default/versions/v1.@OutputOnly
  • network forwarded-ports=duo
    • List of ports, or port pairs, to forward from the virtual machine to the application container.
    • Each invocation of this argument appends the given value to the array.
  • instance-tag=diam
    • Tag to apply to the VM instance during creation.

  • name=est

    • Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.

  • .. nobuild-files-regex=sit

    • 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.
  • resources cpu=0.06840925818992016
    • Number of CPU cores needed.
  • disk-gb=0.3524215642896459
    • Disk size (GB) needed.

  • memory-gb=0.6768631685059072

    • Memory (GB) needed.

  • .. runtime=eos

    • Desired runtime. Example: python27.
  • runtime-api-version=et
    • 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/<language>/config/appref
  • serving-status=sea
    • 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.
  • threadsafe=false
    • Whether multiple requests can be dispatched to this version at once.
  • vm=false
    • Whether to deploy this version in a container on a virtual machine.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

  • -p mask=string
    • Standard field mask for the set of fields to be updated.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.

  • -p access-token=string

    • OAuth access token.

  • -p alt=string

    • Data format for response.

  • -p callback=string

    • JSONP

  • -p fields=string

    • Selector specifying which fields to include in a partial response.

  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

  • -p oauth-token=string

    • OAuth 2.0 token for the current user.

  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.

  • -p quota-user=string

    • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").

  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").