PATCH /v1/projects/{projectId}/deviceSessions/deviceSessionId}:updateDeviceSession Updates the current device session to the fields described by the update_mask.

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: testing1 --scope <scope> projects device-sessions-patch ...

Required Scalar Argument

  • <name> (string)
    • Optional. Name of the DeviceSession, e.g. "projects/{project_id}/deviceSessions/{session_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:

DeviceSession:
  active-start-time: string
  android-device:
    android-model-id: string
    android-version-id: string
    locale: string
    orientation: string
  create-time: string
  display-name: string
  expire-time: string
  inactivity-timeout: string
  name: string
  state: string
  ttl: 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 . active-start-time=gubergren
    • Output only. The timestamp that the session first became ACTIVE.
  • android-device android-model-id=lorem
    • Required. The id of the Android device to be used. Use the TestEnvironmentDiscoveryService to get supported options.
  • android-version-id=gubergren
    • Required. The id of the Android OS version to be used. Use the TestEnvironmentDiscoveryService to get supported options.
  • locale=eos
    • Required. The locale the test device used for testing. Use the TestEnvironmentDiscoveryService to get supported options.

  • orientation=dolor

    • Required. How the device is oriented during the test. Use the TestEnvironmentDiscoveryService to get supported options.

  • .. create-time=ea

    • Output only. The time that the Session was created.
  • display-name=ipsum
    • Output only. The title of the DeviceSession to be presented in the UI.
  • expire-time=invidunt
    • Optional. If the device is still in use at this time, any connections will be ended and the SessionState will transition from ACTIVE to FINISHED.
  • inactivity-timeout=amet
    • Output only. The interval of time that this device must be interacted with before it transitions from ACTIVE to TIMEOUT_INACTIVITY.
  • name=duo
    • Optional. Name of the DeviceSession, e.g. "projects/{project_id}/deviceSessions/{session_id}"
  • state=ipsum
    • Output only. Current state of the DeviceSession.
  • ttl=sed
    • Optional. The amount of time that a device will be initially allocated for. This can eventually be extended with the UpdateDeviceSession RPC. Default: 30 minutes.

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. The list of fields to update.

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