mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-25 12:44:07 +01:00
500 lines
18 KiB
HTML
500 lines
18 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 Instances Create - Data Fusion v3.0.0+20211028</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"> Data Fusion v3.0.0+20211028</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-get">Locations Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 current">
|
|
<a class="current" href=".">Locations Instances 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-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-list">Locations Instances List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-instances-patch">Locations Instances Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-instances-restart">Locations Instances Restart</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-test-iam-permissions">Locations Instances Test Iam Permissions</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-versions-list">Locations Versions List</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 Instances Create</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/datafusion1-cli" class="icon icon-github"> Edit on GitHub</a>
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main">
|
|
<div class="section">
|
|
<p>Creates a new Data Fusion instance in the specified 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>datafusion1 --scope <scope> projects locations-instances-create ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><parent></strong> <em>(string)</em><ul>
|
|
<li>Required. The instance's project and location in the format projects/{project}/locations/{location}.</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>Instance:
|
|
api-endpoint: string
|
|
create-time: string
|
|
crypto-key-config:
|
|
key-reference: string
|
|
dataproc-service-account: string
|
|
description: string
|
|
disabled-reason: [string]
|
|
display-name: string
|
|
enable-rbac: boolean
|
|
enable-stackdriver-logging: boolean
|
|
enable-stackdriver-monitoring: boolean
|
|
gcs-bucket: string
|
|
labels: { string: string }
|
|
name: string
|
|
network-config:
|
|
ip-allocation: string
|
|
network: string
|
|
options: { string: string }
|
|
p4-service-account: string
|
|
private-instance: boolean
|
|
service-account: string
|
|
service-endpoint: string
|
|
state: string
|
|
state-message: string
|
|
tenant-project-id: string
|
|
type: string
|
|
update-time: string
|
|
version: string
|
|
zone: 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 . api-endpoint=et</code><ul>
|
|
<li>Output only. Endpoint on which the REST APIs is accessible.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>create-time=magna</code><ul>
|
|
<li>Output only. The time the instance was created.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>crypto-key-config key-reference=no</code></p>
|
|
<ul>
|
|
<li>The name of the key which is used to encrypt/decrypt customer data. For key in Cloud KMS, the key should be in the format of <code>projects/*/locations/*/keyRings/*/cryptoKeys/*</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. dataproc-service-account=ipsum</code></p>
|
|
<ul>
|
|
<li>User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines. This allows users to have fine-grained access control on Dataproc's accesses to cloud resources.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>description=voluptua.</code><ul>
|
|
<li>A description of this instance.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>disabled-reason=at</code><ul>
|
|
<li>Output only. If the instance state is DISABLED, the reason for disabling the instance.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>display-name=sanctus</code><ul>
|
|
<li>Display name for an instance.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>enable-rbac=false</code><ul>
|
|
<li>Option to enable granular role-based access control.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>enable-stackdriver-logging=true</code><ul>
|
|
<li>Option to enable Stackdriver Logging.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>enable-stackdriver-monitoring=true</code><ul>
|
|
<li>Option to enable Stackdriver Monitoring.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>gcs-bucket=duo</code><ul>
|
|
<li>Output only. Cloud Storage bucket generated by Data Fusion in the customer project.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>labels=key=ipsum</code><ul>
|
|
<li>The resource labels for instance to use to annotate any related underlying resources such as Compute Engine VMs. The character '=' is not allowed to be used within the labels.</li>
|
|
<li>the value will be associated with the given <code>key</code></li>
|
|
</ul>
|
|
</li>
|
|
<li><code>name=gubergren</code><ul>
|
|
<li>Output only. The name of this instance is in the form of projects/{project}/locations/{location}/instances/{instance}.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>network-config ip-allocation=lorem</code><ul>
|
|
<li>The IP range in CIDR notation to use for the managed Data Fusion instance nodes. This range must not overlap with any other ranges used in the customer network.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>network=gubergren</code></p>
|
|
<ul>
|
|
<li>Name of the network in the customer project with which the Tenant Project will be peered for executing pipelines. In case of shared VPC where the network resides in another host project the network should specified in the form of projects/{host-project-id}/global/networks/{network}</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. options=key=eos</code></p>
|
|
<ul>
|
|
<li>Map of additional options used to configure the behavior of Data Fusion instance.</li>
|
|
<li>the value will be associated with the given <code>key</code></li>
|
|
</ul>
|
|
</li>
|
|
<li><code>p4-service-account=dolor</code><ul>
|
|
<li>Output only. P4 service account for the customer project.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>private-instance=true</code><ul>
|
|
<li>Specifies whether the Data Fusion instance should be private. If set to true, all Data Fusion nodes will have private IP addresses and will not be able to access the public internet.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>service-account=invidunt</code><ul>
|
|
<li>Output only. Deprecated. Use tenant_project_id instead to extract the tenant project ID.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>service-endpoint=amet</code><ul>
|
|
<li>Output only. Endpoint on which the Data Fusion UI is accessible.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>state=duo</code><ul>
|
|
<li>Output only. The current state of this Data Fusion instance.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>state-message=ipsum</code><ul>
|
|
<li>Output only. Additional information about the current state of this Data Fusion instance if available.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>tenant-project-id=sed</code><ul>
|
|
<li>Output only. The name of the tenant project.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>type=ut</code><ul>
|
|
<li>Required. Instance type.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>update-time=gubergren</code><ul>
|
|
<li>Output only. The time the instance was last updated.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>version=rebum.</code><ul>
|
|
<li>Current version of the Data Fusion. Only specifiable in Update.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>zone=est</code><ul>
|
|
<li>Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field.</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 instance-id=string</strong><ul>
|
|
<li>Required. The name of the instance to create.</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-instances-delete" class="btn btn-neutral float-right" title="Locations Instances Delete"/>Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
|
|
|
|
<a href="../projects_locations-get" class="btn btn-neutral" title="Locations Get"><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-get" style="color: #fcfcfc;">« Previous</a></span>
|
|
<span style="margin-left: 15px"><a href="../projects_locations-instances-delete" style="color: #fcfcfc">Next »</a></span>
|
|
</span>
|
|
</div>
|
|
</body>
|
|
</html> |