Files
2022-03-08 15:36:16 +08:00

941 lines
38 KiB
HTML

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Locations Agents Environments Experiments Patch - Dialogflow v3.0.0+20220228</title>
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="../css/theme.css" type="text/css" />
<link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
<link rel="stylesheet" href="../css/highlight.css">
<script src="//cdnjs.cloudflare.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/modernizr/2.8.3/modernizr.min.js"></script>
<script type="text/javascript" src="../js/highlight.pack.js"></script>
<script src="../js/theme.js"></script>
<style>
body {font-size: 90%;}
pre, code {font-size: 100%;}
h3, h4, h5, h6 {color: #2980b9; font-weight: 300}
</style>
</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-nav-search">
<a href=".." class="icon icon-home"> Dialogflow v3.0.0+20220228</a>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<span>Projects</span>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-changelogs-get">Locations Agents Changelogs Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-changelogs-list">Locations Agents Changelogs List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-create">Locations Agents Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-delete">Locations Agents Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-entity-types-create">Locations Agents Entity Types Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-entity-types-delete">Locations Agents Entity Types Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-entity-types-get">Locations Agents Entity Types Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-entity-types-list">Locations Agents Entity Types List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-entity-types-patch">Locations Agents Entity Types Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-environments-continuous-test-results-list">Locations Agents Environments Continuous Test Results List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-environments-create">Locations Agents Environments Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-environments-delete">Locations Agents Environments Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-environments-deploy-flow">Locations Agents Environments Deploy Flow</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-environments-deployments-get">Locations Agents Environments Deployments Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-environments-deployments-list">Locations Agents Environments Deployments List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-environments-experiments-create">Locations Agents Environments Experiments Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-environments-experiments-delete">Locations Agents Environments Experiments Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-environments-experiments-get">Locations Agents Environments Experiments Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-environments-experiments-list">Locations Agents Environments Experiments List</a>
</li>
<li class="toctree-l1 current">
<a class="current" href=".">Locations Agents Environments Experiments Patch</a>
<ul>
<li class="toctree-l2"><a href="#scopes">Scopes</a></li>
<li class="toctree-l2"><a href="#required-scalar-argument">Required Scalar Argument</a></li>
<li class="toctree-l2"><a href="#required-request-value">Required Request Value</a></li>
<li><a class="toctree-l3" href="#about-cursors">About Cursors</a></li>
<li class="toctree-l2"><a href="#optional-output-flags">Optional Output Flags</a></li>
<li class="toctree-l2"><a href="#optional-method-properties">Optional Method Properties</a></li>
<li class="toctree-l2"><a href="#optional-general-properties">Optional General Properties</a></li>
</ul>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-environments-experiments-start">Locations Agents Environments Experiments Start</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-environments-experiments-stop">Locations Agents Environments Experiments Stop</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-environments-get">Locations Agents Environments Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-environments-list">Locations Agents Environments List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-environments-lookup-environment-history">Locations Agents Environments Lookup Environment History</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-environments-patch">Locations Agents Environments Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-environments-run-continuous-test">Locations Agents Environments Run Continuous Test</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-environments-sessions-detect-intent">Locations Agents Environments Sessions Detect Intent</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-environments-sessions-entity-types-create">Locations Agents Environments Sessions Entity Types Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-environments-sessions-entity-types-delete">Locations Agents Environments Sessions Entity Types Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-environments-sessions-entity-types-get">Locations Agents Environments Sessions Entity Types Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-environments-sessions-entity-types-list">Locations Agents Environments Sessions Entity Types List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-environments-sessions-entity-types-patch">Locations Agents Environments Sessions Entity Types Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-environments-sessions-fulfill-intent">Locations Agents Environments Sessions Fulfill Intent</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-environments-sessions-match-intent">Locations Agents Environments Sessions Match Intent</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-export">Locations Agents Export</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-flows-create">Locations Agents Flows Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-flows-delete">Locations Agents Flows Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-flows-export">Locations Agents Flows Export</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-flows-get">Locations Agents Flows Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-flows-get-validation-result">Locations Agents Flows Get Validation Result</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-flows-import">Locations Agents Flows Import</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-flows-list">Locations Agents Flows List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-flows-pages-create">Locations Agents Flows Pages Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-flows-pages-delete">Locations Agents Flows Pages Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-flows-pages-get">Locations Agents Flows Pages Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-flows-pages-list">Locations Agents Flows Pages List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-flows-pages-patch">Locations Agents Flows Pages Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-flows-patch">Locations Agents Flows Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-flows-train">Locations Agents Flows Train</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-flows-transition-route-groups-create">Locations Agents Flows Transition Route Groups Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-flows-transition-route-groups-delete">Locations Agents Flows Transition Route Groups Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-flows-transition-route-groups-get">Locations Agents Flows Transition Route Groups Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-flows-transition-route-groups-list">Locations Agents Flows Transition Route Groups List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-flows-transition-route-groups-patch">Locations Agents Flows Transition Route Groups Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-flows-validate">Locations Agents Flows Validate</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-flows-versions-compare-versions">Locations Agents Flows Versions Compare Versions</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-flows-versions-create">Locations Agents Flows Versions Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-flows-versions-delete">Locations Agents Flows Versions Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-flows-versions-get">Locations Agents Flows Versions Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-flows-versions-list">Locations Agents Flows Versions List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-flows-versions-load">Locations Agents Flows Versions Load</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-flows-versions-patch">Locations Agents Flows Versions Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-get">Locations Agents Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-get-validation-result">Locations Agents Get Validation Result</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-intents-create">Locations Agents Intents Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-intents-delete">Locations Agents Intents Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-intents-get">Locations Agents Intents Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-intents-list">Locations Agents Intents List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-intents-patch">Locations Agents Intents Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-list">Locations Agents List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-patch">Locations Agents Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-restore">Locations Agents Restore</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-sessions-detect-intent">Locations Agents Sessions Detect Intent</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-sessions-entity-types-create">Locations Agents Sessions Entity Types Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-sessions-entity-types-delete">Locations Agents Sessions Entity Types Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-sessions-entity-types-get">Locations Agents Sessions Entity Types Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-sessions-entity-types-list">Locations Agents Sessions Entity Types List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-sessions-entity-types-patch">Locations Agents Sessions Entity Types Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-sessions-fulfill-intent">Locations Agents Sessions Fulfill Intent</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-sessions-match-intent">Locations Agents Sessions Match Intent</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-test-cases-batch-delete">Locations Agents Test Cases Batch Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-test-cases-batch-run">Locations Agents Test Cases Batch Run</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-test-cases-calculate-coverage">Locations Agents Test Cases Calculate Coverage</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-test-cases-create">Locations Agents Test Cases Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-test-cases-export">Locations Agents Test Cases Export</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-test-cases-get">Locations Agents Test Cases Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-test-cases-import">Locations Agents Test Cases Import</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-test-cases-list">Locations Agents Test Cases List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-test-cases-patch">Locations Agents Test Cases Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-test-cases-results-get">Locations Agents Test Cases Results Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-test-cases-results-list">Locations Agents Test Cases Results List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-test-cases-run">Locations Agents Test Cases Run</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-validate">Locations Agents Validate</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-webhooks-create">Locations Agents Webhooks Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-webhooks-delete">Locations Agents Webhooks Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-webhooks-get">Locations Agents Webhooks Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-webhooks-list">Locations Agents Webhooks List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agents-webhooks-patch">Locations Agents Webhooks Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-get">Locations Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-list">Locations List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-operations-cancel">Locations Operations Cancel</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-operations-get">Locations Operations Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-operations-list">Locations Operations List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-security-settings-create">Locations Security Settings Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-security-settings-delete">Locations Security Settings Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-security-settings-get">Locations Security Settings Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-security-settings-list">Locations Security Settings List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-security-settings-patch">Locations Security Settings Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_operations-cancel">Operations Cancel</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_operations-get">Operations Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_operations-list">Operations List</a>
</li>
</ul>
</div>
&nbsp;
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="icon icon-reorder"></i>
<a href=".."></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="..">Docs</a> &raquo;</li>
<li>Locations Agents Environments Experiments Patch</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/dialogflow3-cli" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<p>Updates the specified Experiment.</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/dialogflow</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>dialogflow3 --scope &lt;scope&gt; projects locations-agents-environments-experiments-patch ...</code></p>
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
<ul>
<li><strong>&lt;name&gt;</strong> <em>(string)</em><ul>
<li>The name of the experiment. Format: projects//locations//agents//environments//experiments/..</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>GoogleCloudDialogflowCxV3Experiment:
create-time: string
definition:
condition: string
description: string
display-name: string
end-time: string
experiment-length: string
last-update-time: string
name: string
result:
last-update-time: string
rollout-config:
failure-condition: string
rollout-condition: string
rollout-failure-reason: string
rollout-state:
start-time: string
step: string
step-index: integer
start-time: string
state: 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 . create-time=sadipscing</code><ul>
<li>Creation time of this experiment.</li>
</ul>
</li>
<li>
<p><code>definition condition=stet</code></p>
<ul>
<li>The condition defines which subset of sessions are selected for this experiment. If not specified, all sessions are eligible. E.g. &#34;query_input.language_code=en&#34; See the <a href="https://cloud.google.com/dialogflow/cx/docs/reference/condition">conditions reference</a>.</li>
</ul>
</li>
<li>
<p><code>.. description=dolor</code></p>
<ul>
<li>The human-readable description of the experiment.</li>
</ul>
</li>
<li><code>display-name=duo</code><ul>
<li>Required. The human-readable name of the experiment (unique in an environment). Limit of 64 characters.</li>
</ul>
</li>
<li><code>end-time=vero</code><ul>
<li>End time of this experiment.</li>
</ul>
</li>
<li><code>experiment-length=vero</code><ul>
<li>Maximum number of days to run the experiment/rollout. If auto-rollout is not enabled, default value and maximum will be 30 days. If auto-rollout is enabled, default value and maximum will be 6 days.</li>
</ul>
</li>
<li><code>last-update-time=invidunt</code><ul>
<li>Last update time of this experiment.</li>
</ul>
</li>
<li><code>name=stet</code><ul>
<li>The name of the experiment. Format: projects//locations//agents//environments//experiments/..</li>
</ul>
</li>
<li>
<p><code>result last-update-time=vero</code></p>
<ul>
<li>The last time the experiment&#39;s stats data was updated. Will have default value if stats have never been computed for this experiment.</li>
</ul>
</li>
<li>
<p><code>..rollout-config failure-condition=elitr</code></p>
<ul>
<li>The conditions that are used to evaluate the failure of a rollout step. If not specified, no rollout steps will fail. E.g. &#34;containment_rate &lt; 10% OR average_turn_count &lt; 3&#34;. See the <a href="https://cloud.google.com/dialogflow/cx/docs/reference/condition">conditions reference</a>.</li>
</ul>
</li>
<li>
<p><code>rollout-condition=lorem</code></p>
<ul>
<li>The conditions that are used to evaluate the success of a rollout step. If not specified, all rollout steps will proceed to the next one unless failure conditions are met. E.g. &#34;containment_rate &gt; 60% AND callback_rate &lt; 20%&#34;. See the <a href="https://cloud.google.com/dialogflow/cx/docs/reference/condition">conditions reference</a>.</li>
</ul>
</li>
<li>
<p><code>.. rollout-failure-reason=diam</code></p>
<ul>
<li>The reason why rollout has failed. Should only be set when state is ROLLOUT_FAILED.</li>
</ul>
</li>
<li><code>rollout-state start-time=no</code><ul>
<li>Start time of the current step.</li>
</ul>
</li>
<li><code>step=ipsum</code><ul>
<li>Display name of the current auto rollout step.</li>
</ul>
</li>
<li>
<p><code>step-index=78</code></p>
<ul>
<li>Index of the current step in the auto rollout steps list.</li>
</ul>
</li>
<li>
<p><code>.. start-time=takimata</code></p>
<ul>
<li>Start time of this experiment.</li>
</ul>
</li>
<li><code>state=consetetur</code><ul>
<li>The current state of the experiment. Transition triggered by Experiments.StartExperiment: DRAFT-&gt;RUNNING. Transition triggered by Experiments.CancelExperiment: DRAFT-&gt;DONE or RUNNING-&gt;DONE.</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. The mask to control which fields get updated.</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. &#34;media&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
<li>
<p><strong>-p upload-protocol=string</strong></p>
<ul>
<li>Upload protocol for media (e.g. &#34;raw&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
</ul>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../projects_locations-agents-environments-experiments-start" class="btn btn-neutral float-right" title="Locations Agents Environments Experiments Start"/>Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../projects_locations-agents-environments-experiments-list" class="btn btn-neutral" title="Locations Agents Environments Experiments List"><span class="icon icon-circle-arrow-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
<!-- Copyright etc -->
</p>
</div>
Built with <a href="http://www.mkdocs.org">MkDocs</a>, using a <a href="https://github.com/snide/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" style="cursor: pointer">
<span class="rst-current-version" data-toggle="rst-current-version">
<a class="icon icon-github" style="float: left; color: #fcfcfc"> GitHub</a>
<span><a href="../projects_locations-agents-environments-experiments-list" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../projects_locations-agents-environments-experiments-start" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
</body>
</html>