Patch specific fields in the specified model.

Scopes

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

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

If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigquery. You can set the scope for this method like this: bigquery2 --scope <scope> models patch ...

Required Scalar Arguments

  • <project-id> (string)
    • Required. Project ID of the model to patch.
  • <dataset-id> (string)
    • Required. Dataset ID of the model to patch.
  • <model-id> (string)
    • Required. Model ID of the model to patch.

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:

Model:
  best-trial-id: string
  creation-time: string
  description: string
  encryption-configuration:
    kms-key-name: string
  etag: string
  expiration-time: string
  friendly-name: string
  labels: { string: string }
  last-modified-time: string
  location: string
  model-reference:
    dataset-id: string
    model-id: string
    project-id: string
  model-type: 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 . best-trial-id=clita
    • The best trial_id across all training runs.
  • creation-time=dolor
    • Output only. The time when this model was created, in millisecs since the epoch.
  • description=aliquyam
    • Optional. A user-friendly description of this model.

  • encryption-configuration kms-key-name=magna

    • [Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.

  • .. etag=diam

    • Output only. A hash of this resource.
  • expiration-time=nonumy
    • Optional. The time when this model expires, in milliseconds since the epoch. If not present, the model will persist indefinitely. Expired models will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created models.
  • friendly-name=et
    • Optional. A descriptive name for this model.
  • labels=key=sanctus
    • The labels associated with this model. You can use these to organize and group your models. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.
    • the value will be associated with the given key
  • last-modified-time=accusam
    • Output only. The time when this model was last modified, in millisecs since the epoch.
  • location=tempor
    • Output only. The geographic location where the model resides. This value is inherited from the dataset.
  • model-reference dataset-id=sed
    • [Required] The ID of the dataset containing this model.
  • model-id=est
    • [Required] The ID of the model. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.

  • project-id=takimata

    • [Required] The ID of the project containing this model.

  • .. model-type=dolor

    • Output only. Type of the model resource.

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 General Properties

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

  • -p alt=string

    • Data format for the response.

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

    • An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • -p user-ip=string

    • Deprecated. Please use quotaUser instead.