mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-25 12:44:07 +01:00
438 lines
21 KiB
HTML
438 lines
21 KiB
HTML
<!DOCTYPE html>
|
|
<html class="writer-html5" lang="en" >
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><link rel="canonical" href="http://byron.github.io/google-apis-rs/google-cloudiot1-cli/projects_locations-registries-devices-patch/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Locations Registries Devices Patch - Cloud Iot v5.0.4+0</title>
|
|
<link rel="stylesheet" href="../css/theme.css" />
|
|
<link rel="stylesheet" href="../css/theme_extra.css" />
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
|
|
|
|
<script>
|
|
// Current page data
|
|
var mkdocs_page_name = "Locations Registries Devices Patch";
|
|
var mkdocs_page_input_path = "projects_locations-registries-devices-patch.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-cloudiot1-cli/projects_locations-registries-devices-patch/";
|
|
</script>
|
|
|
|
<script src="../js/jquery-3.6.0.min.js" defer></script>
|
|
<!--[if lt IE 9]>
|
|
<script src="../js/html5shiv.min.js"></script>
|
|
<![endif]-->
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
|
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav" role="document">
|
|
|
|
<div class="wy-grid-for-nav">
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search">
|
|
<a href=".." class="icon icon-home"> Cloud Iot v5.0.4+0
|
|
</a><div role="search">
|
|
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
|
</form>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Projects</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-registries-bind-device-to-gateway/">Locations Registries Bind Device To Gateway</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-registries-create/">Locations Registries Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-registries-delete/">Locations Registries Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-registries-devices-config-versions-list/">Locations Registries Devices Config Versions List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-registries-devices-create/">Locations Registries Devices Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-registries-devices-delete/">Locations Registries Devices Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-registries-devices-get/">Locations Registries Devices Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-registries-devices-list/">Locations Registries Devices List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-registries-devices-modify-cloud-to-device-config/">Locations Registries Devices Modify Cloud To Device Config</a>
|
|
</li>
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">Locations Registries Devices Patch</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-registries-devices-send-command-to-device/">Locations Registries Devices Send Command To Device</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-registries-devices-states-list/">Locations Registries Devices States List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-registries-get/">Locations Registries Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-registries-get-iam-policy/">Locations Registries Get Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-registries-groups-devices-list/">Locations Registries Groups Devices List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-registries-groups-get-iam-policy/">Locations Registries Groups Get Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-registries-groups-set-iam-policy/">Locations Registries Groups Set Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-registries-groups-test-iam-permissions/">Locations Registries Groups Test Iam Permissions</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-registries-list/">Locations Registries List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-registries-patch/">Locations Registries Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-registries-set-iam-policy/">Locations Registries Set Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-registries-test-iam-permissions/">Locations Registries Test Iam Permissions</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-registries-unbind-device-from-gateway/">Locations Registries Unbind Device From Gateway</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="..">Cloud Iot v5.0.4+0</a>
|
|
|
|
</nav>
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href=".." class="icon icon-home" alt="Docs"></a> »</li>
|
|
<li>Projects »</li>
|
|
<li>Locations Registries Devices Patch</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/cloudiot1-cli/edit/master/docs/projects_locations-registries-devices-patch.md"
|
|
class="icon icon-github"> Edit on GitHub</a>
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div class="section" itemprop="articleBody">
|
|
|
|
<p>Updates a device.</p>
|
|
<h1 id="scopes">Scopes</h1>
|
|
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
|
|
<ul>
|
|
<li><em>https://www.googleapis.com/auth/cloud-platform</em></li>
|
|
<li><em>https://www.googleapis.com/auth/cloudiot</em></li>
|
|
</ul>
|
|
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/cloud-platform</em>.
|
|
You can set the scope for this method like this: <code>cloudiot1 --scope <scope> projects locations-registries-devices-patch ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><name></strong> <em>(string)</em><ul>
|
|
<li>The resource path name. For example, <code>projects/p1/locations/us-central1/registries/registry0/devices/dev0</code> or <code>projects/p1/locations/us-central1/registries/registry0/devices/{num_id}</code>. When <code>name</code> is populated as a response from the service, it always ends in the device numeric ID.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="required-request-value">Required Request Value</h1>
|
|
<p>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.</p>
|
|
<p>For example, a structure like this:</p>
|
|
<pre><code>Device:
|
|
blocked: boolean
|
|
config:
|
|
binary-data: string
|
|
cloud-update-time: string
|
|
device-ack-time: string
|
|
version: string
|
|
gateway-config:
|
|
gateway-auth-method: string
|
|
gateway-type: string
|
|
last-accessed-gateway-id: string
|
|
last-accessed-gateway-time: string
|
|
id: string
|
|
last-config-ack-time: string
|
|
last-config-send-time: string
|
|
last-error-status:
|
|
code: integer
|
|
message: string
|
|
last-error-time: string
|
|
last-event-time: string
|
|
last-heartbeat-time: string
|
|
last-state-time: string
|
|
log-level: string
|
|
metadata: { string: string }
|
|
name: string
|
|
num-id: string
|
|
state:
|
|
binary-data: string
|
|
update-time: string
|
|
|
|
</code></pre>
|
|
<p>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.</p>
|
|
<ul>
|
|
<li><code>-r . blocked=true</code><ul>
|
|
<li>If a device is blocked, connections or requests from this device will fail. Can be used to temporarily prevent the device from connecting if, for example, the sensor is generating bad data and needs maintenance.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>config binary-data=eos</code><ul>
|
|
<li>The device configuration data.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>cloud-update-time=labore</code><ul>
|
|
<li>[Output only] The time at which this configuration version was updated in Cloud IoT Core. This timestamp is set by the server.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>device-ack-time=sed</code><ul>
|
|
<li>[Output only] The time at which Cloud IoT Core received the acknowledgment from the device, indicating that the device has received this configuration version. If this field is not present, the device has not yet acknowledged that it received this version. Note that when the config was sent to the device, many config versions may have been available in Cloud IoT Core while the device was disconnected, and on connection, only the latest version is sent to the device. Some versions may never be sent to the device, and therefore are never acknowledged. This timestamp is set by Cloud IoT Core.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>version=duo</code></p>
|
|
<ul>
|
|
<li>[Output only] The version of this update. The version number is assigned by the server, and is always greater than 0 after device creation. The version must be 0 on the <code>CreateDevice</code> request if a <code>config</code> is specified; the response of <code>CreateDevice</code> will always have a value of 1.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..gateway-config gateway-auth-method=sed</code></p>
|
|
<ul>
|
|
<li>Indicates how to authorize and/or authenticate devices to access the gateway.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>gateway-type=no</code><ul>
|
|
<li>Indicates whether the device is a gateway.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>last-accessed-gateway-id=stet</code><ul>
|
|
<li>[Output only] The ID of the gateway the device accessed most recently.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>last-accessed-gateway-time=kasd</code></p>
|
|
<ul>
|
|
<li>[Output only] The most recent time at which the device accessed the gateway specified in <code>last_accessed_gateway</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. id=et</code></p>
|
|
<ul>
|
|
<li>The user-defined device identifier. The device ID must be unique within a device registry.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>last-config-ack-time=sed</code><ul>
|
|
<li>[Output only] The last time a cloud-to-device config version acknowledgment was received from the device. This field is only for configurations sent through MQTT.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>last-config-send-time=et</code><ul>
|
|
<li>[Output only] The last time a cloud-to-device config version was sent to the device.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>last-error-status code=33</code><ul>
|
|
<li>The status code, which should be an enum value of google.rpc.Code.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>message=vero</code></p>
|
|
<ul>
|
|
<li>A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. last-error-time=erat</code></p>
|
|
<ul>
|
|
<li>[Output only] The time the most recent error occurred, such as a failure to publish to Cloud Pub/Sub. This field is the timestamp of 'last_error_status'.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>last-event-time=sed</code><ul>
|
|
<li>[Output only] The last time a telemetry event was received. Timestamps are periodically collected and written to storage; they may be stale by a few minutes.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>last-heartbeat-time=duo</code><ul>
|
|
<li>[Output only] The last time an MQTT <code>PINGREQ</code> was received. This field applies only to devices connecting through MQTT. MQTT clients usually only send <code>PINGREQ</code> messages if the connection is idle, and no other messages have been sent. Timestamps are periodically collected and written to storage; they may be stale by a few minutes.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>last-state-time=dolore</code><ul>
|
|
<li>[Output only] The last time a state event was received. Timestamps are periodically collected and written to storage; they may be stale by a few minutes.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>log-level=et</code><ul>
|
|
<li><strong>Beta Feature</strong> The logging verbosity for device activity. If unspecified, DeviceRegistry.log_level will be used.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>metadata=key=voluptua.</code><ul>
|
|
<li>The metadata key-value pairs assigned to the device. This metadata is not interpreted or indexed by Cloud IoT Core. It can be used to add contextual information for the device. Keys must conform to the regular expression a-zA-Z+ and be less than 128 bytes in length. Values are free-form strings. Each value must be less than or equal to 32 KB in size. The total size of all keys and values must be less than 256 KB, and the maximum number of key-value pairs is 500.</li>
|
|
<li>the value will be associated with the given <code>key</code></li>
|
|
</ul>
|
|
</li>
|
|
<li><code>name=amet.</code><ul>
|
|
<li>The resource path name. For example, <code>projects/p1/locations/us-central1/registries/registry0/devices/dev0</code> or <code>projects/p1/locations/us-central1/registries/registry0/devices/{num_id}</code>. When <code>name</code> is populated as a response from the service, it always ends in the device numeric ID.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>num-id=consetetur</code><ul>
|
|
<li>[Output only] A server-defined unique numeric ID for the device. This is a more compact way to identify devices, and it is globally unique.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>state binary-data=diam</code><ul>
|
|
<li>The device state data.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>update-time=dolor</code><ul>
|
|
<li>[Output only] The time at which this state version was updated in Cloud IoT Core.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h3 id="about-cursors">About Cursors</h3>
|
|
<p>The cursor position is key to comfortably set complex nested structures. The following rules apply:</p>
|
|
<ul>
|
|
<li>The cursor position is always set relative to the current one, unless the field name starts with the <code>.</code> character. Fields can be nested such as in <code>-r f.s.o</code> .</li>
|
|
<li>The cursor position is set relative to the top-level structure if it starts with <code>.</code>, e.g. <code>-r .s.s</code></li>
|
|
<li>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 <code>-r struct.sub_struct=bar</code>.</li>
|
|
<li>You can move the cursor one level up by using <code>..</code>. Each additional <code>.</code> moves it up one additional level. E.g. <code>...</code> would go three levels up.</li>
|
|
</ul>
|
|
<h1 id="optional-output-flags">Optional Output Flags</h1>
|
|
<p>The method's return value a JSON encoded structure, which will be written to standard output by default.</p>
|
|
<ul>
|
|
<li><strong>-o out</strong><ul>
|
|
<li><em>out</em> specifies the <em>destination</em> to which to write the server's result to.
|
|
It will be a JSON-encoded structure.
|
|
The <em>destination</em> may be <code>-</code> to indicate standard output, or a filepath that is to contain the received bytes.
|
|
If unset, it defaults to standard output.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="optional-method-properties">Optional Method Properties</h1>
|
|
<p>You may set the following properties to further configure the call. Please note that <code>-p</code> is followed by one
|
|
or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> even though the listing below repeats the
|
|
<code>-p</code> for completeness.</p>
|
|
<ul>
|
|
<li><strong>-p update-mask=string</strong><ul>
|
|
<li>Required. Only updates the <code>device</code> fields indicated by this mask. The field mask must not be empty, and it must not contain fields that are immutable or only set by the server. Mutable top-level fields: <code>credentials</code>, <code>blocked</code>, and <code>metadata</code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="optional-general-properties">Optional General Properties</h1>
|
|
<p>The following properties can configure any call, and are not specific to this method.</p>
|
|
<ul>
|
|
<li>
|
|
<p><strong>-p $-xgafv=string</strong></p>
|
|
<ul>
|
|
<li>V1 error format.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p access-token=string</strong></p>
|
|
<ul>
|
|
<li>OAuth access token.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p alt=string</strong></p>
|
|
<ul>
|
|
<li>Data format for response.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p callback=string</strong></p>
|
|
<ul>
|
|
<li>JSONP</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p fields=string</strong></p>
|
|
<ul>
|
|
<li>Selector specifying which fields to include in a partial response.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p key=string</strong></p>
|
|
<ul>
|
|
<li>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.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p oauth-token=string</strong></p>
|
|
<ul>
|
|
<li>OAuth 2.0 token for the current user.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p pretty-print=boolean</strong></p>
|
|
<ul>
|
|
<li>Returns response with indentations and line breaks.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p quota-user=string</strong></p>
|
|
<ul>
|
|
<li>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.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p upload-type=string</strong></p>
|
|
<ul>
|
|
<li>Legacy upload protocol for media (e.g. "media", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p upload-protocol=string</strong></p>
|
|
<ul>
|
|
<li>Upload protocol for media (e.g. "raw", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div><footer>
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
|
<a href="../projects_locations-registries-devices-modify-cloud-to-device-config/" class="btn btn-neutral float-left" title="Locations Registries Devices Modify Cloud To Device Config"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../projects_locations-registries-devices-send-command-to-device/" class="btn btn-neutral float-right" title="Locations Registries Devices Send Command To Device">Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<!-- Copyright etc -->
|
|
<p>Copyright © 2015-2020, `Sebastian Thiel`</p>
|
|
</div>
|
|
|
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
<div class="rst-versions" role="note" aria-label="Versions">
|
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
|
|
|
<span>
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/cloudiot1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../projects_locations-registries-devices-modify-cloud-to-device-config/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../projects_locations-registries-devices-send-command-to-device/" style="color: #fcfcfc">Next »</a></span>
|
|
|
|
</span>
|
|
</div>
|
|
<script>var base_url = '..';</script>
|
|
<script src="../js/theme_extra.js" defer></script>
|
|
<script src="../js/theme.js" defer></script>
|
|
<script src="../search/main.js" defer></script>
|
|
<script defer>
|
|
window.onload = function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
};
|
|
</script>
|
|
|
|
</body>
|
|
</html>
|