mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-28 04:41:02 +01:00
895 lines
35 KiB
HTML
895 lines
35 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 Batches Create - Dataproc 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"> Dataproc 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-autoscaling-policies-create">Locations Autoscaling Policies Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-autoscaling-policies-delete">Locations Autoscaling Policies Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-autoscaling-policies-get">Locations Autoscaling Policies Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-autoscaling-policies-get-iam-policy">Locations Autoscaling Policies Get Iam Policy</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-autoscaling-policies-list">Locations Autoscaling Policies List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-autoscaling-policies-set-iam-policy">Locations Autoscaling Policies Set Iam Policy</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-autoscaling-policies-test-iam-permissions">Locations Autoscaling Policies Test Iam Permissions</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-autoscaling-policies-update">Locations Autoscaling Policies Update</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 current">
|
|
<a class="current" href=".">Locations Batches 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-batches-delete">Locations Batches Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-batches-get">Locations Batches Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-batches-list">Locations Batches List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-workflow-templates-create">Locations Workflow Templates Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-workflow-templates-delete">Locations Workflow Templates Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-workflow-templates-get">Locations Workflow Templates Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-workflow-templates-get-iam-policy">Locations Workflow Templates Get Iam Policy</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-workflow-templates-instantiate">Locations Workflow Templates Instantiate</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-workflow-templates-instantiate-inline">Locations Workflow Templates Instantiate Inline</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-workflow-templates-list">Locations Workflow Templates List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-workflow-templates-set-iam-policy">Locations Workflow Templates Set Iam Policy</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-workflow-templates-test-iam-permissions">Locations Workflow Templates Test Iam Permissions</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-workflow-templates-update">Locations Workflow Templates Update</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_regions-autoscaling-policies-create">Regions Autoscaling Policies Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_regions-autoscaling-policies-delete">Regions Autoscaling Policies Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_regions-autoscaling-policies-get">Regions Autoscaling Policies Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_regions-autoscaling-policies-get-iam-policy">Regions Autoscaling Policies Get Iam Policy</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_regions-autoscaling-policies-list">Regions Autoscaling Policies List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_regions-autoscaling-policies-set-iam-policy">Regions Autoscaling Policies Set Iam Policy</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_regions-autoscaling-policies-test-iam-permissions">Regions Autoscaling Policies Test Iam Permissions</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_regions-autoscaling-policies-update">Regions Autoscaling Policies Update</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_regions-clusters-create">Regions Clusters Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_regions-clusters-delete">Regions Clusters Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_regions-clusters-diagnose">Regions Clusters Diagnose</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_regions-clusters-get">Regions Clusters Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_regions-clusters-get-iam-policy">Regions Clusters Get Iam Policy</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_regions-clusters-inject-credentials">Regions Clusters Inject Credentials</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_regions-clusters-list">Regions Clusters List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_regions-clusters-patch">Regions Clusters Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_regions-clusters-repair">Regions Clusters Repair</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_regions-clusters-set-iam-policy">Regions Clusters Set Iam Policy</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_regions-clusters-start">Regions Clusters Start</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_regions-clusters-stop">Regions Clusters Stop</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_regions-clusters-test-iam-permissions">Regions Clusters Test Iam Permissions</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_regions-jobs-cancel">Regions Jobs Cancel</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_regions-jobs-delete">Regions Jobs Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_regions-jobs-get">Regions Jobs Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_regions-jobs-get-iam-policy">Regions Jobs Get Iam Policy</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_regions-jobs-list">Regions Jobs List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_regions-jobs-patch">Regions Jobs Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_regions-jobs-set-iam-policy">Regions Jobs Set Iam Policy</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_regions-jobs-submit">Regions Jobs Submit</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_regions-jobs-submit-as-operation">Regions Jobs Submit As Operation</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_regions-jobs-test-iam-permissions">Regions Jobs Test Iam Permissions</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_regions-operations-cancel">Regions Operations Cancel</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_regions-operations-delete">Regions Operations Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_regions-operations-get">Regions Operations Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_regions-operations-get-iam-policy">Regions Operations Get Iam Policy</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_regions-operations-list">Regions Operations List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_regions-operations-set-iam-policy">Regions Operations Set Iam Policy</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_regions-operations-test-iam-permissions">Regions Operations Test Iam Permissions</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_regions-workflow-templates-create">Regions Workflow Templates Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_regions-workflow-templates-delete">Regions Workflow Templates Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_regions-workflow-templates-get">Regions Workflow Templates Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_regions-workflow-templates-get-iam-policy">Regions Workflow Templates Get Iam Policy</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_regions-workflow-templates-instantiate">Regions Workflow Templates Instantiate</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_regions-workflow-templates-instantiate-inline">Regions Workflow Templates Instantiate Inline</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_regions-workflow-templates-list">Regions Workflow Templates List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_regions-workflow-templates-set-iam-policy">Regions Workflow Templates Set Iam Policy</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_regions-workflow-templates-test-iam-permissions">Regions Workflow Templates Test Iam Permissions</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_regions-workflow-templates-update">Regions Workflow Templates Update</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 Batches Create</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/dataproc1-cli" class="icon icon-github"> Edit on GitHub</a>
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main">
|
|
<div class="section">
|
|
<p>Creates a batch workload that executes 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-batches-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 batch 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>Batch:
|
|
create-time: string
|
|
creator: string
|
|
environment-config:
|
|
execution-config:
|
|
kms-key: string
|
|
network-tags: [string]
|
|
network-uri: string
|
|
service-account: string
|
|
subnetwork-uri: string
|
|
peripherals-config:
|
|
metastore-service: string
|
|
spark-history-server-config:
|
|
dataproc-cluster: string
|
|
labels: { string: string }
|
|
name: string
|
|
operation: string
|
|
pyspark-batch:
|
|
archive-uris: [string]
|
|
args: [string]
|
|
file-uris: [string]
|
|
jar-file-uris: [string]
|
|
main-python-file-uri: string
|
|
python-file-uris: [string]
|
|
runtime-config:
|
|
container-image: string
|
|
properties: { string: string }
|
|
version: string
|
|
runtime-info:
|
|
diagnostic-output-uri: string
|
|
endpoints: { string: string }
|
|
output-uri: string
|
|
spark-batch:
|
|
archive-uris: [string]
|
|
args: [string]
|
|
file-uris: [string]
|
|
jar-file-uris: [string]
|
|
main-class: string
|
|
main-jar-file-uri: string
|
|
spark-r-batch:
|
|
archive-uris: [string]
|
|
args: [string]
|
|
file-uris: [string]
|
|
main-r-file-uri: string
|
|
spark-sql-batch:
|
|
jar-file-uris: [string]
|
|
query-file-uri: string
|
|
query-variables: { string: string }
|
|
state: string
|
|
state-message: string
|
|
state-time: 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=sed</code><ul>
|
|
<li>Output only. The time when the batch was created.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>creator=duo</code><ul>
|
|
<li>Output only. The email address of the user who created the batch.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>environment-config.execution-config kms-key=dolore</code><ul>
|
|
<li>Optional. The Cloud KMS key to use for encryption.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>network-tags=et</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=voluptua.</code><ul>
|
|
<li>Optional. Network URI to connect workload to.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>service-account=amet.</code><ul>
|
|
<li>Optional. Service account that used to execute workload.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>subnetwork-uri=consetetur</code></p>
|
|
<ul>
|
|
<li>Optional. Subnetwork URI to connect workload to.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..peripherals-config metastore-service=diam</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=dolor</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>.... labels=key=et</code></p>
|
|
<ul>
|
|
<li>Optional. The labels to associate with this batch. 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 batch.</li>
|
|
<li>the value will be associated with the given <code>key</code></li>
|
|
</ul>
|
|
</li>
|
|
<li><code>name=et</code><ul>
|
|
<li>Output only. The resource name of the batch.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>operation=sadipscing</code><ul>
|
|
<li>Output only. The resource name of the operation associated with this batch.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>pyspark-batch archive-uris=stet</code><ul>
|
|
<li>Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>args=dolor</code><ul>
|
|
<li>Optional. The arguments to pass to the driver. Do not include arguments that can be set as batch properties, such as --conf, since a collision can occur that causes an incorrect batch submission.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>file-uris=duo</code><ul>
|
|
<li>Optional. HCFS URIs of files to be placed in the working directory of each executor.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>jar-file-uris=vero</code><ul>
|
|
<li>Optional. HCFS URIs of jar files to add to the classpath of the Spark driver and tasks.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>main-python-file-uri=vero</code><ul>
|
|
<li>Required. The HCFS URI of the main Python file to use as the Spark driver. Must be a .py file.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>python-file-uris=invidunt</code></p>
|
|
<ul>
|
|
<li>Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..runtime-config container-image=stet</code></p>
|
|
<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=vero</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>version=elitr</code></p>
|
|
<ul>
|
|
<li>Optional. Version of the batch runtime.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..runtime-info diagnostic-output-uri=lorem</code></p>
|
|
<ul>
|
|
<li>Output only. A URI pointing to the location of the diagnostics tarball.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>endpoints=key=diam</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=no</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>..spark-batch archive-uris=ipsum</code></p>
|
|
<ul>
|
|
<li>Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>args=accusam</code><ul>
|
|
<li>Optional. The arguments to pass to the driver. Do not include arguments that can be set as batch properties, such as --conf, since a collision can occur that causes an incorrect batch submission.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>file-uris=takimata</code><ul>
|
|
<li>Optional. HCFS URIs of files to be placed in the working directory of each executor.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>jar-file-uris=consetetur</code><ul>
|
|
<li>Optional. HCFS URIs of jar files to add to the classpath of the Spark driver and tasks.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>main-class=voluptua.</code><ul>
|
|
<li>Optional. The name of the driver main class. The jar file that contains the class must be in the classpath or specified in jar_file_uris.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>main-jar-file-uri=et</code></p>
|
|
<ul>
|
|
<li>Optional. The HCFS URI of the jar file that contains the main class.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..spark-r-batch archive-uris=erat</code></p>
|
|
<ul>
|
|
<li>Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>args=consetetur</code><ul>
|
|
<li>Optional. The arguments to pass to the Spark driver. Do not include arguments that can be set as batch properties, such as --conf, since a collision can occur that causes an incorrect batch submission.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>file-uris=amet.</code><ul>
|
|
<li>Optional. HCFS URIs of files to be placed in the working directory of each executor.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>main-r-file-uri=sed</code></p>
|
|
<ul>
|
|
<li>Required. The HCFS URI of the main R file to use as the driver. Must be a .R or .r file.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..spark-sql-batch jar-file-uris=takimata</code></p>
|
|
<ul>
|
|
<li>Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>query-file-uri=dolores</code><ul>
|
|
<li>Required. The HCFS URI of the script that contains Spark SQL queries to execute.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>query-variables=key=gubergren</code></p>
|
|
<ul>
|
|
<li>Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).</li>
|
|
<li>the value will be associated with the given <code>key</code></li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. state=et</code></p>
|
|
<ul>
|
|
<li>Output only. The state of the batch.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>state-message=accusam</code><ul>
|
|
<li>Output only. Batch state details, such as a failure description if the state is FAILED.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>state-time=voluptua.</code><ul>
|
|
<li>Output only. The time when the batch entered a current state.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>uuid=dolore</code><ul>
|
|
<li>Output only. A batch UUID (Unique Universal Identifier). The service generates this value when it creates the batch.</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 batch-id=string</strong></p>
|
|
<ul>
|
|
<li>Optional. The ID to use for the batch, which will become the final component of the batch's resource name.This value must be 4-63 characters. Valid characters are /[a-z][0-9]-/.</li>
|
|
</ul>
|
|
</li>
|
|
<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 CreateBatchRequest (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.CreateBatchRequest)s with the same request_id, the second request is ignored and the Operation that corresponds to the first Batch created and stored in the backend is returned.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>
|
|
</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-batches-delete" class="btn btn-neutral float-right" title="Locations Batches Delete"/>Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
|
|
|
|
<a href="../projects_locations-autoscaling-policies-update" class="btn btn-neutral" title="Locations Autoscaling Policies Update"><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-autoscaling-policies-update" style="color: #fcfcfc;">« Previous</a></span>
|
|
<span style="margin-left: 15px"><a href="../projects_locations-batches-delete" style="color: #fcfcfc">Next »</a></span>
|
|
</span>
|
|
</div>
|
|
</body>
|
|
</html> |