mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-26 19:58:50 +01:00
680 lines
37 KiB
HTML
680 lines
37 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-dataproc1-cli/projects_locations-sessions-create/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Locations Sessions Create - Dataproc v5.0.4+20240222</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 Sessions Create";
|
|
var mkdocs_page_input_path = "projects_locations-sessions-create.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-dataproc1-cli/projects_locations-sessions-create/";
|
|
</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"> Dataproc v5.0.4+20240222
|
|
</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-autoscaling-policies-create/">Locations Autoscaling Policies Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-autoscaling-policies-delete/">Locations Autoscaling Policies Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-autoscaling-policies-get/">Locations Autoscaling Policies Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-autoscaling-policies-get-iam-policy/">Locations Autoscaling Policies Get Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-autoscaling-policies-list/">Locations Autoscaling Policies List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-autoscaling-policies-set-iam-policy/">Locations Autoscaling Policies Set Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-autoscaling-policies-test-iam-permissions/">Locations Autoscaling Policies Test Iam Permissions</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-autoscaling-policies-update/">Locations Autoscaling Policies Update</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-batches-create/">Locations Batches Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-batches-delete/">Locations Batches Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-batches-get/">Locations Batches Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-batches-list/">Locations Batches List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-operations-cancel/">Locations Operations Cancel</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-operations-delete/">Locations Operations Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-operations-get/">Locations Operations Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-operations-list/">Locations Operations List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-session-templates-create/">Locations Session Templates Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-session-templates-delete/">Locations Session Templates Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-session-templates-get/">Locations Session Templates Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-session-templates-list/">Locations Session Templates List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-session-templates-patch/">Locations Session Templates Patch</a>
|
|
</li>
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">Locations Sessions Create</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-sessions-delete/">Locations Sessions Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-sessions-get/">Locations Sessions Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-sessions-list/">Locations Sessions List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-sessions-terminate/">Locations Sessions Terminate</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workflow-templates-create/">Locations Workflow Templates Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workflow-templates-delete/">Locations Workflow Templates Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workflow-templates-get/">Locations Workflow Templates Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workflow-templates-get-iam-policy/">Locations Workflow Templates Get Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workflow-templates-instantiate/">Locations Workflow Templates Instantiate</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workflow-templates-instantiate-inline/">Locations Workflow Templates Instantiate Inline</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workflow-templates-list/">Locations Workflow Templates List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workflow-templates-set-iam-policy/">Locations Workflow Templates Set Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workflow-templates-test-iam-permissions/">Locations Workflow Templates Test Iam Permissions</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workflow-templates-update/">Locations Workflow Templates Update</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-autoscaling-policies-create/">Regions Autoscaling Policies Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-autoscaling-policies-delete/">Regions Autoscaling Policies Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-autoscaling-policies-get/">Regions Autoscaling Policies Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-autoscaling-policies-get-iam-policy/">Regions Autoscaling Policies Get Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-autoscaling-policies-list/">Regions Autoscaling Policies List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-autoscaling-policies-set-iam-policy/">Regions Autoscaling Policies Set Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-autoscaling-policies-test-iam-permissions/">Regions Autoscaling Policies Test Iam Permissions</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-autoscaling-policies-update/">Regions Autoscaling Policies Update</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-clusters-create/">Regions Clusters Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-clusters-delete/">Regions Clusters Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-clusters-diagnose/">Regions Clusters Diagnose</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-clusters-get/">Regions Clusters Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-clusters-get-iam-policy/">Regions Clusters Get Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-clusters-inject-credentials/">Regions Clusters Inject Credentials</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-clusters-list/">Regions Clusters List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-clusters-node-groups-create/">Regions Clusters Node Groups Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-clusters-node-groups-get/">Regions Clusters Node Groups Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-clusters-node-groups-repair/">Regions Clusters Node Groups Repair</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-clusters-node-groups-resize/">Regions Clusters Node Groups Resize</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-clusters-patch/">Regions Clusters Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-clusters-repair/">Regions Clusters Repair</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-clusters-set-iam-policy/">Regions Clusters Set Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-clusters-start/">Regions Clusters Start</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-clusters-stop/">Regions Clusters Stop</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-clusters-test-iam-permissions/">Regions Clusters Test Iam Permissions</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-jobs-cancel/">Regions Jobs Cancel</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-jobs-delete/">Regions Jobs Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-jobs-get/">Regions Jobs Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-jobs-get-iam-policy/">Regions Jobs Get Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-jobs-list/">Regions Jobs List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-jobs-patch/">Regions Jobs Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-jobs-set-iam-policy/">Regions Jobs Set Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-jobs-submit/">Regions Jobs Submit</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-jobs-submit-as-operation/">Regions Jobs Submit As Operation</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-jobs-test-iam-permissions/">Regions Jobs Test Iam Permissions</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-operations-cancel/">Regions Operations Cancel</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-operations-delete/">Regions Operations Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-operations-get/">Regions Operations Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-operations-get-iam-policy/">Regions Operations Get Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-operations-list/">Regions Operations List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-operations-set-iam-policy/">Regions Operations Set Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-operations-test-iam-permissions/">Regions Operations Test Iam Permissions</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-workflow-templates-create/">Regions Workflow Templates Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-workflow-templates-delete/">Regions Workflow Templates Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-workflow-templates-get/">Regions Workflow Templates Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-workflow-templates-get-iam-policy/">Regions Workflow Templates Get Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-workflow-templates-instantiate/">Regions Workflow Templates Instantiate</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-workflow-templates-instantiate-inline/">Regions Workflow Templates Instantiate Inline</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-workflow-templates-list/">Regions Workflow Templates List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-workflow-templates-set-iam-policy/">Regions Workflow Templates Set Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-workflow-templates-test-iam-permissions/">Regions Workflow Templates Test Iam Permissions</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_regions-workflow-templates-update/">Regions Workflow Templates Update</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="..">Dataproc v5.0.4+20240222</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 Sessions Create</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/dataproc1-cli/edit/master/docs/projects_locations-sessions-create.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>Create an interactive session asynchronously.</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>dataproc1 --scope <scope> projects locations-sessions-create ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><parent></strong> <em>(string)</em><ul>
|
|
<li>Required. The parent resource where this session will be created.</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>Session:
|
|
create-time: string
|
|
creator: string
|
|
environment-config:
|
|
execution-config:
|
|
idle-ttl: string
|
|
kms-key: string
|
|
network-tags: [string]
|
|
network-uri: string
|
|
service-account: string
|
|
staging-bucket: string
|
|
subnetwork-uri: string
|
|
ttl: string
|
|
peripherals-config:
|
|
metastore-service: string
|
|
spark-history-server-config:
|
|
dataproc-cluster: string
|
|
jupyter-session:
|
|
display-name: string
|
|
kernel: string
|
|
labels: { string: string }
|
|
name: string
|
|
runtime-config:
|
|
container-image: string
|
|
properties: { string: string }
|
|
repository-config:
|
|
pypi-repository-config:
|
|
pypi-repository: string
|
|
version: string
|
|
runtime-info:
|
|
approximate-usage:
|
|
accelerator-type: string
|
|
milli-accelerator-seconds: string
|
|
milli-dcu-seconds: string
|
|
shuffle-storage-gb-seconds: string
|
|
current-usage:
|
|
accelerator-type: string
|
|
milli-accelerator: string
|
|
milli-dcu: string
|
|
milli-dcu-premium: string
|
|
shuffle-storage-gb: string
|
|
shuffle-storage-gb-premium: string
|
|
snapshot-time: string
|
|
diagnostic-output-uri: string
|
|
endpoints: { string: string }
|
|
output-uri: string
|
|
session-template: string
|
|
state: string
|
|
state-message: string
|
|
state-time: string
|
|
user: string
|
|
uuid: 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=dolore</code><ul>
|
|
<li>Output only. The time when the session was created.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>creator=eirmod</code><ul>
|
|
<li>Output only. The email address of the user who created the session.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>environment-config.execution-config idle-ttl=lorem</code><ul>
|
|
<li>Optional. Applies to sessions only. The duration to keep the session alive while it's idling. Exceeding this threshold causes the session to terminate. This field cannot be set on a batch workload. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)). Defaults to 1 hour if not set. If both ttl and idle_ttl are specified for an interactive session, the conditions are treated as OR conditions: the workload will be terminated when it has been idle for idle_ttl or when ttl has been exceeded, whichever occurs first.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>kms-key=accusam</code><ul>
|
|
<li>Optional. The Cloud KMS key to use for encryption.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>network-tags=amet</code><ul>
|
|
<li>Optional. Tags used for network traffic control.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>network-uri=erat</code><ul>
|
|
<li>Optional. Network URI to connect workload to.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>service-account=dolores</code><ul>
|
|
<li>Optional. Service account that used to execute workload.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>staging-bucket=erat</code><ul>
|
|
<li>Optional. A Cloud Storage bucket used to stage workload dependencies, config files, and store workload output and other ephemeral data, such as Spark history files. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location according to the region where your workload is running, and then create and manage project-level, per-location staging and temporary buckets. This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>subnetwork-uri=accusam</code><ul>
|
|
<li>Optional. Subnetwork URI to connect workload to.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>ttl=sea</code></p>
|
|
<ul>
|
|
<li>Optional. The duration after which the workload will be terminated, specified as the JSON representation for Duration (https://protobuf.dev/programming-guides/proto3/#json). When the workload exceeds this duration, it will be unconditionally terminated without waiting for ongoing work to finish. If ttl is not specified for a batch workload, the workload will be allowed to run until it exits naturally (or run forever without exiting). If ttl is not specified for an interactive session, it defaults to 24 hours. If ttl is not specified for a batch that uses 2.1+ runtime version, it defaults to 4 hours. Minimum value is 10 minutes; maximum value is 14 days. If both ttl and idle_ttl are specified (for an interactive session), the conditions are treated as OR conditions: the workload will be terminated when it has been idle for idle_ttl or when ttl has been exceeded, whichever occurs first.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..peripherals-config metastore-service=takimata</code></p>
|
|
<ul>
|
|
<li>Optional. Resource name of an existing Dataproc Metastore service.Example: projects/[project_id]/locations/[region]/services/[service_id]</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>spark-history-server-config dataproc-cluster=lorem</code></p>
|
|
<ul>
|
|
<li>Optional. Resource name of an existing Dataproc Cluster to act as a Spark History Server for the workload.Example: projects/[project_id]/regions/[region]/clusters/[cluster_name]</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>....jupyter-session display-name=et</code></p>
|
|
<ul>
|
|
<li>Optional. Display name, shown in the Jupyter kernelspec card.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>kernel=at</code></p>
|
|
<ul>
|
|
<li>Optional. Kernel</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. labels=key=dolor</code></p>
|
|
<ul>
|
|
<li>Optional. The labels to associate with the session. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a session.</li>
|
|
<li>the value will be associated with the given <code>key</code></li>
|
|
</ul>
|
|
</li>
|
|
<li><code>name=et</code><ul>
|
|
<li>Required. The resource name of the session.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>runtime-config container-image=sit</code><ul>
|
|
<li>Optional. Optional custom container image for the job runtime environment. If not specified, a default container image will be used.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>properties=key=erat</code><ul>
|
|
<li>Optional. A mapping of property names to values, which are used to configure workload execution.</li>
|
|
<li>the value will be associated with the given <code>key</code></li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>repository-config.pypi-repository-config pypi-repository=sea</code></p>
|
|
<ul>
|
|
<li>Optional. PyPi repository address</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>... version=nonumy</code></p>
|
|
<ul>
|
|
<li>Optional. Version of the batch runtime.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..runtime-info.approximate-usage accelerator-type=et</code></p>
|
|
<ul>
|
|
<li>Optional. Accelerator type being used, if any</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>milli-accelerator-seconds=gubergren</code><ul>
|
|
<li>Optional. Accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>milli-dcu-seconds=justo</code><ul>
|
|
<li>Optional. DCU (Dataproc Compute Units) usage in (milliDCU x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>shuffle-storage-gb-seconds=sea</code></p>
|
|
<ul>
|
|
<li>Optional. Shuffle storage usage in (GB x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..current-usage accelerator-type=consetetur</code></p>
|
|
<ul>
|
|
<li>Optional. Accelerator type being used, if any</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>milli-accelerator=sit</code><ul>
|
|
<li>Optional. Milli (one-thousandth) accelerator. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing))</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>milli-dcu=aliquyam</code><ul>
|
|
<li>Optional. Milli (one-thousandth) Dataproc Compute Units (DCUs) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>milli-dcu-premium=eos</code><ul>
|
|
<li>Optional. Milli (one-thousandth) Dataproc Compute Units (DCUs) charged at premium tier (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>shuffle-storage-gb=at</code><ul>
|
|
<li>Optional. Shuffle Storage in gigabytes (GB). (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing))</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>shuffle-storage-gb-premium=dolores</code><ul>
|
|
<li>Optional. Shuffle Storage in gigabytes (GB) charged at premium tier. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing))</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>snapshot-time=consetetur</code></p>
|
|
<ul>
|
|
<li>Optional. The timestamp of the usage snapshot.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. diagnostic-output-uri=gubergren</code></p>
|
|
<ul>
|
|
<li>Output only. A URI pointing to the location of the diagnostics tarball.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>endpoints=key=dolor</code><ul>
|
|
<li>Output only. Map of remote access endpoints (such as web interfaces and APIs) to their URIs.</li>
|
|
<li>the value will be associated with the given <code>key</code></li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>output-uri=aliquyam</code></p>
|
|
<ul>
|
|
<li>Output only. A URI pointing to the location of the stdout and stderr of the workload.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. session-template=no</code></p>
|
|
<ul>
|
|
<li>Optional. The session template used by the session.Only resource names, including project ID and location, are valid.Example: * https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id] * projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id]The template must be in the same project and Dataproc region as the session.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>state=amet.</code><ul>
|
|
<li>Output only. A state of the session.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>state-message=ipsum</code><ul>
|
|
<li>Output only. Session state details, such as the failure description if the state is FAILED.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>state-time=lorem</code><ul>
|
|
<li>Output only. The time when the session entered the current state.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>user=accusam</code><ul>
|
|
<li>Optional. The email address of the user who owns the session.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>uuid=gubergren</code><ul>
|
|
<li>Output only. A session UUID (Unique Universal Identifier). The service generates this value when it creates the session.</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>
|
|
<p><strong>-p request-id=string</strong></p>
|
|
<ul>
|
|
<li>Optional. A unique ID used to identify the request. If the service receives two CreateSessionRequests (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.CreateSessionRequest)s with the same ID, the second request is ignored, and the first Session is created and stored in the backend.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The value must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p session-id=string</strong></p>
|
|
<ul>
|
|
<li>Required. The ID to use for the session, which becomes the final component of the session's resource name.This value must be 4-63 characters. Valid characters are /a-z-/.</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-session-templates-patch/" class="btn btn-neutral float-left" title="Locations Session Templates Patch"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../projects_locations-sessions-delete/" class="btn btn-neutral float-right" title="Locations Sessions Delete">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/dataproc1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../projects_locations-session-templates-patch/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../projects_locations-sessions-delete/" 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>
|