Updates the specified metadata for the specified version. This method will fail with FAILED_PRECONDITION in the event of an invalid state transition. The supported state transitions for a version are from CREATED to FINALIZED. Use DeleteVersion to set the status of a version to DELETED.

Scopes

You will need authorization for at least one of the following scopes to make a valid call:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/firebase

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: firebasehosting1-beta1 --scope <scope> projects sites-versions-patch ...

Required Scalar Argument

  • <name> (string)
    • The fully-qualified resource name for the version, in the format: sites/ SITE_ID/versions/VERSION_ID This name is provided in the response body when you call CreateVersion.

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:
  config:
    app-association: string
    clean-urls: boolean
    i18n:
      root: string
    trailing-slash-behavior: string
  create-time: string
  create-user:
    email: string
    image-url: string
  delete-time: string
  delete-user:
    email: string
    image-url: string
  file-count: int64
  finalize-time: string
  finalize-user:
    email: string
    image-url: string
  labels: { string: string }
  name: string
  status: string
  version-bytes: string

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 .config app-association=tempor
    • How to handle well known App Association files.
  • clean-urls=false
    • Defines whether to drop the file extension from uploaded files.

  • i18n root=lorem

    • Required. The user-supplied path where country and language specific content will be looked for within the public directory.

  • .. trailing-slash-behavior=magna

    • Defines how to handle a trailing slash in the URL path.

  • .. create-time=takimata

    • Output only. The time at which the version was created.
  • create-user email=rebum.
    • The email address of the user when the user performed the action.

  • image-url=at

    • A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.

  • .. delete-time=invidunt

    • Output only. The time at which the version was DELETED.
  • delete-user email=clita
    • The email address of the user when the user performed the action.

  • image-url=stet

    • A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.

  • .. file-count=-82

    • Output only. The total number of files associated with the version. This value is calculated after a version is FINALIZED.
  • finalize-time=ut
    • Output only. The time at which the version was FINALIZED.
  • finalize-user email=sit
    • The email address of the user when the user performed the action.

  • image-url=vero

    • A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.

  • .. labels=key=rebum.

    • The labels used for extra metadata and/or filtering.
    • the value will be associated with the given key
  • name=dolores
    • The fully-qualified resource name for the version, in the format: sites/ SITE_ID/versions/VERSION_ID This name is provided in the response body when you call CreateVersion.
  • status=consetetur
    • The deploy status of the version. For a successful deploy, call CreateVersion to make a new version (CREATED status), upload all desired files to the version, then update the version to the FINALIZED status. Note that if you leave the version in the CREATED state for more than 12 hours, the system will automatically mark the version as ABANDONED. You can also change the status of a version to DELETED by calling DeleteVersion.
  • version-bytes=dolores
    • Output only. The total stored bytesize of the version. This value is calculated after a version is FINALIZED.

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 update-mask=string
    • A set of field names from your version that you want to update. A field will be overwritten if, and only if, it's in the mask. If a mask is not provided then a default mask of only status will be used.

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