Updates the specified connection. For security reasons, also resets credential if connection properties are in the update field mask.

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: bigqueryconnection1-beta1 --scope <scope> projects locations-connections-patch ...

Required Scalar Argument

• <name> (string)
  • Required. Name of the connection to update, for example: projects/{project_id}/locations/{location_id}/connections/{connection_id}

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:

Connection:
  cloud-sql:
    credential:
      password: string
      username: string
    database: string
    instance-id: string
    service-account-id: string
    type: string
  creation-time: string
  description: string
  friendly-name: string
  has-credential: boolean
  last-modified-time: string
  name: 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 .cloud-sql.credential password=gubergren
  • The password for the credential.

• username=lorem

  • The username for the credential.

• .. database=gubergren

  • Database name.
• instance-id=eos
  • Cloud SQL instance ID in the form project:location:instance.
• service-account-id=dolor
  • Output only. The account ID of the service used for the purpose of this connection. When the connection is used in the context of an operation in BigQuery, this service account will serve as the identity being used for connecting to the CloudSQL instance specified in this connection.

• type=ea

  • Type of the Cloud SQL database.

• .. creation-time=ipsum

  • Output only. The creation timestamp of the connection.
• description=invidunt
  • User provided description.
• friendly-name=amet
  • User provided display name for the connection.
• has-credential=true
  • Output only. True, if credential is configured for this connection.
• last-modified-time=sed
  • Output only. The last update timestamp of the connection.
• name=ut
  • The resource name of the connection in the form of: projects/{project_id}/locations/{location_id}/connections/{connection_id}

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
  • Required. Update mask for the connection 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").