mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-27 04:10:02 +01:00
685 lines
28 KiB
HTML
685 lines
28 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 Executions Create - AI Platform Notebooks v3.0.0+20220224</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"> AI Platform Notebooks v3.0.0+20220224</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-environments-create">Locations Environments Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-environments-delete">Locations Environments Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-environments-get">Locations Environments Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-environments-list">Locations Environments List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 current">
|
|
<a class="current" href=".">Locations Executions Create</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-executions-delete">Locations Executions Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-executions-get">Locations Executions Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-executions-list">Locations Executions List</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-instances-create">Locations Instances Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-instances-delete">Locations Instances Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-instances-get">Locations Instances Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-instances-get-iam-policy">Locations Instances Get Iam Policy</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-instances-get-instance-health">Locations Instances Get Instance Health</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-instances-is-upgradeable">Locations Instances Is Upgradeable</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-instances-list">Locations Instances List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-instances-register">Locations Instances Register</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-instances-report">Locations Instances Report</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-instances-reset">Locations Instances Reset</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-instances-rollback">Locations Instances Rollback</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-instances-set-accelerator">Locations Instances Set Accelerator</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-instances-set-iam-policy">Locations Instances Set Iam Policy</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-instances-set-labels">Locations Instances Set Labels</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-instances-set-machine-type">Locations Instances Set Machine Type</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-instances-start">Locations Instances Start</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-instances-stop">Locations Instances Stop</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-instances-test-iam-permissions">Locations Instances Test Iam Permissions</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-instances-update-config">Locations Instances Update Config</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-instances-update-metadata-items">Locations Instances Update Metadata Items</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-instances-update-shielded-instance-config">Locations Instances Update Shielded Instance Config</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-instances-upgrade">Locations Instances Upgrade</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-instances-upgrade-internal">Locations Instances Upgrade Internal</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-delete">Locations Operations Delete</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-runtimes-create">Locations Runtimes Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-runtimes-delete">Locations Runtimes Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-runtimes-get">Locations Runtimes Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-runtimes-get-iam-policy">Locations Runtimes Get Iam Policy</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-runtimes-list">Locations Runtimes List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-runtimes-report-event">Locations Runtimes Report Event</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-runtimes-reset">Locations Runtimes Reset</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-runtimes-set-iam-policy">Locations Runtimes Set Iam Policy</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-runtimes-start">Locations Runtimes Start</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-runtimes-stop">Locations Runtimes Stop</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-runtimes-switch">Locations Runtimes Switch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-runtimes-test-iam-permissions">Locations Runtimes Test Iam Permissions</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-schedules-create">Locations Schedules Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-schedules-delete">Locations Schedules Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-schedules-get">Locations Schedules Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-schedules-list">Locations Schedules List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-schedules-trigger">Locations Schedules Trigger</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
</div>
|
|
|
|
</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> »</li>
|
|
<li>Locations Executions Create</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/notebooks1-cli" class="icon icon-github"> Edit on GitHub</a>
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main">
|
|
<div class="section">
|
|
<p>Creates a new Execution in a given project and location.</p>
|
|
<h1 id="scopes">Scopes</h1>
|
|
<p>You will need authorization for the <em>https://www.googleapis.com/auth/cloud-platform</em> scope to make a valid call.</p>
|
|
<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>notebooks1 --scope <scope> projects locations-executions-create ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><parent></strong> <em>(string)</em><ul>
|
|
<li>Required. Format: <code>parent=projects/{project_id}/locations/{location}</code></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>Execution:
|
|
create-time: string
|
|
description: string
|
|
display-name: string
|
|
execution-template:
|
|
accelerator-config:
|
|
core-count: int64
|
|
type: string
|
|
container-image-uri: string
|
|
dataproc-parameters:
|
|
cluster: string
|
|
input-notebook-file: string
|
|
job-type: string
|
|
kernel-spec: string
|
|
labels: { string: string }
|
|
master-type: string
|
|
output-notebook-folder: string
|
|
parameters: string
|
|
params-yaml-file: string
|
|
scale-tier: string
|
|
service-account: string
|
|
tensorboard: string
|
|
vertex-ai-parameters:
|
|
env: { string: string }
|
|
network: string
|
|
job-uri: string
|
|
name: string
|
|
output-notebook-file: string
|
|
state: 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 . create-time=amet.</code><ul>
|
|
<li>Output only. Time the Execution was instantiated.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>description=duo</code><ul>
|
|
<li>A brief description of this execution.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>display-name=ipsum</code><ul>
|
|
<li>Output only. Name used for UI purposes. Name can only contain alphanumeric characters and underscores '_'.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>execution-template.accelerator-config core-count=-62</code><ul>
|
|
<li>Count of cores of this accelerator.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>type=lorem</code></p>
|
|
<ul>
|
|
<li>Type of this accelerator.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. container-image-uri=gubergren</code></p>
|
|
<ul>
|
|
<li>Container Image URI to a DLVM Example: 'gcr.io/deeplearning-platform-release/base-cu100' More examples can be found at: https://cloud.google.com/ai-platform/deep-learning-containers/docs/choosing-container</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>dataproc-parameters cluster=eos</code></p>
|
|
<ul>
|
|
<li>URI for cluster used to run Dataproc execution. Format: <code>projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}</code></li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. input-notebook-file=dolor</code></p>
|
|
<ul>
|
|
<li>Path to the notebook file to execute. Must be in a Google Cloud Storage bucket. Format: <code>gs://{bucket_name}/{folder}/{notebook_file_name}</code> Ex: <code>gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb</code></li>
|
|
</ul>
|
|
</li>
|
|
<li><code>job-type=ea</code><ul>
|
|
<li>The type of Job to be used on this execution.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>kernel-spec=ipsum</code><ul>
|
|
<li>Name of the kernel spec to use. This must be specified if the kernel spec name on the execution target does not match the name in the input notebook file.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>labels=key=invidunt</code><ul>
|
|
<li>Labels for execution. If execution is scheduled, a field included will be 'nbs-scheduled'. Otherwise, it is an immediate execution, and an included field will be 'nbs-immediate'. Use fields to efficiently index between various types of executions.</li>
|
|
<li>the value will be associated with the given <code>key</code></li>
|
|
</ul>
|
|
</li>
|
|
<li><code>master-type=amet</code><ul>
|
|
<li>Specifies the type of virtual machine to use for your training job's master worker. You must specify this field when <code>scaleTier</code> is set to <code>CUSTOM</code>. You can use certain Compute Engine machine types directly in this field. The following types are supported: - <code>n1-standard-4</code> - <code>n1-standard-8</code> - <code>n1-standard-16</code> - <code>n1-standard-32</code> - <code>n1-standard-64</code> - <code>n1-standard-96</code> - <code>n1-highmem-2</code> - <code>n1-highmem-4</code> - <code>n1-highmem-8</code> - <code>n1-highmem-16</code> - <code>n1-highmem-32</code> - <code>n1-highmem-64</code> - <code>n1-highmem-96</code> - <code>n1-highcpu-16</code> - <code>n1-highcpu-32</code> - <code>n1-highcpu-64</code> - <code>n1-highcpu-96</code> Alternatively, you can use the following legacy machine types: - <code>standard</code> - <code>large_model</code> - <code>complex_model_s</code> - <code>complex_model_m</code> - <code>complex_model_l</code> - <code>standard_gpu</code> - <code>complex_model_m_gpu</code> - <code>complex_model_l_gpu</code> - <code>standard_p100</code> - <code>complex_model_m_p100</code> - <code>standard_v100</code> - <code>large_model_v100</code> - <code>complex_model_m_v100</code> - <code>complex_model_l_v100</code> Finally, if you want to use a TPU for training, specify <code>cloud_tpu</code> in this field. Learn more about the <a href="https://cloud.google.com/ai-platform/training/docs/using-tpus#configuring_a_custom_tpu_machine">special configuration options for training with TPU</a>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>output-notebook-folder=duo</code><ul>
|
|
<li>Path to the notebook folder to write to. Must be in a Google Cloud Storage bucket path. Format: <code>gs://{bucket_name}/{folder}</code> Ex: <code>gs://notebook_user/scheduled_notebooks</code></li>
|
|
</ul>
|
|
</li>
|
|
<li><code>parameters=ipsum</code><ul>
|
|
<li>Parameters used within the 'input_notebook_file' notebook.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>params-yaml-file=sed</code><ul>
|
|
<li>Parameters to be overridden in the notebook during execution. Ref https://papermill.readthedocs.io/en/latest/usage-parameterize.html on how to specifying parameters in the input notebook and pass them here in an YAML file. Ex: <code>gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml</code></li>
|
|
</ul>
|
|
</li>
|
|
<li><code>scale-tier=ut</code><ul>
|
|
<li>Required. Scale tier of the hardware used for notebook execution. DEPRECATED Will be discontinued. As right now only CUSTOM is supported.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>service-account=gubergren</code><ul>
|
|
<li>The email address of a service account to use when running the execution. You must have the <code>iam.serviceAccounts.actAs</code> permission for the specified service account.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>tensorboard=rebum.</code><ul>
|
|
<li>The name of a Vertex AI [Tensorboard] resource to which this execution will upload Tensorboard logs. Format: <code>projects/{project}/locations/{location}/tensorboards/{tensorboard}</code></li>
|
|
</ul>
|
|
</li>
|
|
<li><code>vertex-ai-parameters env=key=est</code><ul>
|
|
<li>Environment variables. At most 100 environment variables can be specified and unique. Example: GCP_BUCKET=gs://my-bucket/samples/</li>
|
|
<li>the value will be associated with the given <code>key</code></li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>network=ipsum</code></p>
|
|
<ul>
|
|
<li>The full name of the Compute Engine <a href="..//compute/docs/networks-and-firewalls#networks">network</a> to which the Job should be peered. For example, <code>projects/12345/global/networks/myVPC</code>. <a href="https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert">Format</a> is of the form <code>projects/{project}/global/networks/{network}</code>. Where {project} is a project number, as in <code>12345</code>, and {network} is a network name. Private services access must already be configured for the network. If left unspecified, the job is not peered with any network.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>... job-uri=ipsum</code></p>
|
|
<ul>
|
|
<li>Output only. The URI of the external job used to execute the notebook.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>name=est</code><ul>
|
|
<li>Output only. The resource name of the execute. Format: <code>projects/{project_id}/locations/{location}/executions/{execution_id}</code></li>
|
|
</ul>
|
|
</li>
|
|
<li><code>output-notebook-file=gubergren</code><ul>
|
|
<li>Output notebook file generated by this execution</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>state=ea</code><ul>
|
|
<li>Output only. State of the underlying AI Platform job.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>update-time=dolor</code><ul>
|
|
<li>Output only. Time the Execution was last updated.</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 execution-id=string</strong><ul>
|
|
<li>Required. User-defined unique ID of this execution.</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-executions-delete" class="btn btn-neutral float-right" title="Locations Executions Delete"/>Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
|
|
|
|
<a href="../projects_locations-environments-list" class="btn btn-neutral" title="Locations Environments 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-environments-list" style="color: #fcfcfc;">« Previous</a></span>
|
|
<span style="margin-left: 15px"><a href="../projects_locations-executions-delete" style="color: #fcfcfc">Next »</a></span>
|
|
</span>
|
|
</div>
|
|
</body>
|
|
</html> |