mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-02-23 15:49:49 +01:00
Update documentation
This commit is contained in:
Sebastian Thiel
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>BigQuery Data Transfer v2.0.4+20210324</title>
|
||||
<title>BigQuery Data Transfer v3.0.0+20220225</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href="." class="icon icon-home"> BigQuery Data Transfer v2.0.4+20210324</a>
|
||||
<a href="." class="icon icon-home"> BigQuery Data Transfer v3.0.0+20220225</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -59,6 +59,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="projects_enroll-data-sources/">Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="projects_locations-data-sources-check-valid-creds/">Locations Data Sources Check Valid Creds</a>
|
||||
|
||||
@@ -74,6 +79,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="projects_locations-enroll-data-sources/">Locations Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="projects_locations-get/">Locations Get</a>
|
||||
|
||||
@@ -249,15 +259,17 @@ capabilities. Errors will be printed to standard error, and cause the program's
|
||||
|
||||
<p>Find the source code <a href="https://github.com/Byron/google-apis-rs/tree/main/gen/bigquerydatatransfer1-cli">on github</a>.</p>
|
||||
<h1 id="usage">Usage</h1>
|
||||
<p>This documentation was generated from the <em>BigQuery Data Transfer</em> API at revision <em>20210324</em>. The CLI is at version <em>2.0.4</em>.</p>
|
||||
<p>This documentation was generated from the <em>BigQuery Data Transfer</em> API at revision <em>20220225</em>. The CLI is at version <em>3.0.0</em>.</p>
|
||||
<pre><code class="bash">bigquerydatatransfer1 [options]
|
||||
projects
|
||||
data-sources-check-valid-creds <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
||||
data-sources-get <name> [-p <v>]... [-o <out>]
|
||||
data-sources-list <parent> [-p <v>]... [-o <out>]
|
||||
enroll-data-sources <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
||||
locations-data-sources-check-valid-creds <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
||||
locations-data-sources-get <name> [-p <v>]... [-o <out>]
|
||||
locations-data-sources-list <parent> [-p <v>]... [-o <out>]
|
||||
locations-enroll-data-sources <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
||||
locations-get <name> [-p <v>]... [-o <out>]
|
||||
locations-list <name> [-p <v>]... [-o <out>]
|
||||
locations-transfer-configs-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Data Sources Check Valid Creds - BigQuery Data Transfer v2.0.4+20210324</title>
|
||||
<title>Data Sources Check Valid Creds - BigQuery Data Transfer v3.0.0+20220225</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v2.0.4+20210324</a>
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v3.0.0+20220225</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -80,6 +80,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_enroll-data-sources">Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-data-sources-check-valid-creds">Locations Data Sources Check Valid Creds</a>
|
||||
|
||||
@@ -95,6 +100,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-enroll-data-sources">Locations Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-get">Locations Get</a>
|
||||
|
||||
@@ -251,12 +261,11 @@
|
||||
</div>
|
||||
<div role="main">
|
||||
<div class="section">
|
||||
<p>Returns true if valid credentials exist for the given data source and requesting user. Some data sources doesn't support service account, so we need to talk to them on behalf of the end user. This API just checks whether we have OAuth token for the particular user, which is a pre-requisite before user can create a transfer config.</p>
|
||||
<p>Returns true if valid credentials exist for the given data source and requesting user.</p>
|
||||
<h1 id="scopes">Scopes</h1>
|
||||
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
|
||||
<ul>
|
||||
<li><em>https://www.googleapis.com/auth/bigquery</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/bigquery.readonly</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/cloud-platform</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/cloud-platform.read-only</em></li>
|
||||
</ul>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Data Sources Get - BigQuery Data Transfer v2.0.4+20210324</title>
|
||||
<title>Data Sources Get - BigQuery Data Transfer v3.0.0+20220225</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v2.0.4+20210324</a>
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v3.0.0+20220225</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -75,6 +75,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_enroll-data-sources">Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-data-sources-check-valid-creds">Locations Data Sources Check Valid Creds</a>
|
||||
|
||||
@@ -90,6 +95,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-enroll-data-sources">Locations Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-get">Locations Get</a>
|
||||
|
||||
@@ -246,16 +256,15 @@
|
||||
</div>
|
||||
<div role="main">
|
||||
<div class="section">
|
||||
<p>Retrieves a supported data source and returns its settings, which can be used for UI rendering.</p>
|
||||
<p>Retrieves a supported data source and returns its settings.</p>
|
||||
<h1 id="scopes">Scopes</h1>
|
||||
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
|
||||
<ul>
|
||||
<li><em>https://www.googleapis.com/auth/bigquery</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/bigquery.readonly</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/cloud-platform</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/cloud-platform.read-only</em></li>
|
||||
</ul>
|
||||
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/bigquery.readonly</em>.
|
||||
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/bigquery</em>.
|
||||
You can set the scope for this method like this: <code>bigquerydatatransfer1 --scope <scope> projects data-sources-get ...</code></p>
|
||||
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
||||
<ul>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Data Sources List - BigQuery Data Transfer v2.0.4+20210324</title>
|
||||
<title>Data Sources List - BigQuery Data Transfer v3.0.0+20220225</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v2.0.4+20210324</a>
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v3.0.0+20220225</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -78,6 +78,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_enroll-data-sources">Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-data-sources-check-valid-creds">Locations Data Sources Check Valid Creds</a>
|
||||
|
||||
@@ -93,6 +98,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-enroll-data-sources">Locations Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-get">Locations Get</a>
|
||||
|
||||
@@ -249,21 +259,20 @@
|
||||
</div>
|
||||
<div role="main">
|
||||
<div class="section">
|
||||
<p>Lists supported data sources and returns their settings, which can be used for UI rendering.</p>
|
||||
<p>Lists supported data sources and returns their settings.</p>
|
||||
<h1 id="scopes">Scopes</h1>
|
||||
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
|
||||
<ul>
|
||||
<li><em>https://www.googleapis.com/auth/bigquery</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/bigquery.readonly</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/cloud-platform</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/cloud-platform.read-only</em></li>
|
||||
</ul>
|
||||
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/bigquery.readonly</em>.
|
||||
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/bigquery</em>.
|
||||
You can set the scope for this method like this: <code>bigquerydatatransfer1 --scope <scope> projects data-sources-list ...</code></p>
|
||||
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
||||
<ul>
|
||||
<li><strong><parent></strong> <em>(string)</em><ul>
|
||||
<li>Required. The BigQuery project id for which data sources should be returned. Must be in the form: <code>projects/{project_id}</code> or `projects/{project_id}/locations/{location_id}</li>
|
||||
<li>Required. The BigQuery project id for which data sources should be returned. Must be in the form: <code>projects/{project_id}</code> or <code>projects/{project_id}/locations/{location_id}</code></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -373,7 +382,7 @@ or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> eve
|
||||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
<a href="../projects_locations-data-sources-check-valid-creds" class="btn btn-neutral float-right" title="Locations Data Sources Check Valid Creds"/>Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||
<a href="../projects_enroll-data-sources" class="btn btn-neutral float-right" title="Enroll Data Sources"/>Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||
|
||||
|
||||
<a href="../projects_data-sources-get" class="btn btn-neutral" title="Data Sources Get"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||
@@ -405,7 +414,7 @@ or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> eve
|
||||
<a class="icon icon-github" style="float: left; color: #fcfcfc"> GitHub</a>
|
||||
|
||||
<span><a href="../projects_data-sources-get" style="color: #fcfcfc;">« Previous</a></span>
|
||||
<span style="margin-left: 15px"><a href="../projects_locations-data-sources-check-valid-creds" style="color: #fcfcfc">Next »</a></span>
|
||||
<span style="margin-left: 15px"><a href="../projects_enroll-data-sources" style="color: #fcfcfc">Next »</a></span>
|
||||
</span>
|
||||
</div>
|
||||
</body>
|
||||
|
||||
@@ -0,0 +1,429 @@
|
||||
<!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>Enroll Data Sources - BigQuery Data Transfer v3.0.0+20220225</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"> BigQuery Data Transfer v3.0.0+20220225</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_data-sources-check-valid-creds">Data Sources Check Valid Creds</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_data-sources-get">Data Sources Get</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_data-sources-list">Data Sources List</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 current">
|
||||
<a class="current" href=".">Enroll Data Sources</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-general-properties">Optional General Properties</a></li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-data-sources-check-valid-creds">Locations Data Sources Check Valid Creds</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-data-sources-get">Locations Data Sources Get</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-data-sources-list">Locations Data Sources List</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-enroll-data-sources">Locations Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-get">Locations Get</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-list">Locations List</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-transfer-configs-create">Locations Transfer Configs Create</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-transfer-configs-delete">Locations Transfer Configs Delete</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-transfer-configs-get">Locations Transfer Configs Get</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-transfer-configs-list">Locations Transfer Configs List</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-transfer-configs-patch">Locations Transfer Configs Patch</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-transfer-configs-runs-delete">Locations Transfer Configs Runs Delete</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-transfer-configs-runs-get">Locations Transfer Configs Runs Get</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-transfer-configs-runs-list">Locations Transfer Configs Runs List</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-transfer-configs-runs-transfer-logs-list">Locations Transfer Configs Runs Transfer Logs List</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-transfer-configs-schedule-runs">Locations Transfer Configs Schedule Runs</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-transfer-configs-start-manual-runs">Locations Transfer Configs Start Manual Runs</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_transfer-configs-create">Transfer Configs Create</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_transfer-configs-delete">Transfer Configs Delete</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_transfer-configs-get">Transfer Configs Get</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_transfer-configs-list">Transfer Configs List</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_transfer-configs-patch">Transfer Configs Patch</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_transfer-configs-runs-delete">Transfer Configs Runs Delete</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_transfer-configs-runs-get">Transfer Configs Runs Get</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_transfer-configs-runs-list">Transfer Configs Runs List</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_transfer-configs-runs-transfer-logs-list">Transfer Configs Runs Transfer Logs List</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_transfer-configs-schedule-runs">Transfer Configs Schedule Runs</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_transfer-configs-start-manual-runs">Transfer Configs Start Manual Runs</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>Enroll Data Sources</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/bigquerydatatransfer1-cli" class="icon icon-github"> Edit on GitHub</a>
|
||||
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main">
|
||||
<div class="section">
|
||||
<p>Enroll data sources in a user project. This allows users to create transfer configurations for these data sources. They will also appear in the ListDataSources RPC and as such, will appear in the BigQuery UI 'https://bigquery.cloud.google.com' (and the documents can be found at https://cloud.google.com/bigquery/bigquery-web-ui and https://cloud.google.com/bigquery/docs/working-with-transfers).</p>
|
||||
<h1 id="scopes">Scopes</h1>
|
||||
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
|
||||
<ul>
|
||||
<li><em>https://www.googleapis.com/auth/bigquery</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/cloud-platform</em></li>
|
||||
</ul>
|
||||
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/bigquery</em>.
|
||||
You can set the scope for this method like this: <code>bigquerydatatransfer1 --scope <scope> projects enroll-data-sources ...</code></p>
|
||||
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
||||
<ul>
|
||||
<li><strong><name></strong> <em>(string)</em><ul>
|
||||
<li>The name of the project resource in the form: <code>projects/{project_id}</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>EnrollDataSourcesRequest:
|
||||
data-source-ids: [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 . data-source-ids=et</code><ul>
|
||||
<li>Data sources that are enrolled. It is required to provide at least one data source id.</li>
|
||||
<li>Each invocation of this argument appends the given value to the array.</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-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-data-sources-check-valid-creds" class="btn btn-neutral float-right" title="Locations Data Sources Check Valid Creds"/>Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||
|
||||
|
||||
<a href="../projects_data-sources-list" class="btn btn-neutral" title="Data Sources 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_data-sources-list" style="color: #fcfcfc;">« Previous</a></span>
|
||||
<span style="margin-left: 15px"><a href="../projects_locations-data-sources-check-valid-creds" style="color: #fcfcfc">Next »</a></span>
|
||||
</span>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Locations Data Sources Check Valid Creds - BigQuery Data Transfer v2.0.4+20210324</title>
|
||||
<title>Locations Data Sources Check Valid Creds - BigQuery Data Transfer v3.0.0+20220225</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v2.0.4+20210324</a>
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v3.0.0+20220225</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -59,6 +59,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_enroll-data-sources">Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 current">
|
||||
<a class="current" href=".">Locations Data Sources Check Valid Creds</a>
|
||||
|
||||
@@ -95,6 +100,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-enroll-data-sources">Locations Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-get">Locations Get</a>
|
||||
|
||||
@@ -251,12 +261,11 @@
|
||||
</div>
|
||||
<div role="main">
|
||||
<div class="section">
|
||||
<p>Returns true if valid credentials exist for the given data source and requesting user. Some data sources doesn't support service account, so we need to talk to them on behalf of the end user. This API just checks whether we have OAuth token for the particular user, which is a pre-requisite before user can create a transfer config.</p>
|
||||
<p>Returns true if valid credentials exist for the given data source and requesting user.</p>
|
||||
<h1 id="scopes">Scopes</h1>
|
||||
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
|
||||
<ul>
|
||||
<li><em>https://www.googleapis.com/auth/bigquery</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/bigquery.readonly</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/cloud-platform</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/cloud-platform.read-only</em></li>
|
||||
</ul>
|
||||
@@ -377,7 +386,7 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
<a href="../projects_locations-data-sources-get" class="btn btn-neutral float-right" title="Locations Data Sources Get"/>Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||
|
||||
|
||||
<a href="../projects_data-sources-list" class="btn btn-neutral" title="Data Sources List"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||
<a href="../projects_enroll-data-sources" class="btn btn-neutral" title="Enroll Data Sources"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -405,7 +414,7 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
|
||||
<a class="icon icon-github" style="float: left; color: #fcfcfc"> GitHub</a>
|
||||
|
||||
<span><a href="../projects_data-sources-list" style="color: #fcfcfc;">« Previous</a></span>
|
||||
<span><a href="../projects_enroll-data-sources" style="color: #fcfcfc;">« Previous</a></span>
|
||||
<span style="margin-left: 15px"><a href="../projects_locations-data-sources-get" style="color: #fcfcfc">Next »</a></span>
|
||||
</span>
|
||||
</div>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Locations Data Sources Get - BigQuery Data Transfer v2.0.4+20210324</title>
|
||||
<title>Locations Data Sources Get - BigQuery Data Transfer v3.0.0+20220225</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v2.0.4+20210324</a>
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v3.0.0+20220225</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -59,6 +59,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_enroll-data-sources">Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-data-sources-check-valid-creds">Locations Data Sources Check Valid Creds</a>
|
||||
|
||||
@@ -90,6 +95,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-enroll-data-sources">Locations Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-get">Locations Get</a>
|
||||
|
||||
@@ -246,16 +256,15 @@
|
||||
</div>
|
||||
<div role="main">
|
||||
<div class="section">
|
||||
<p>Retrieves a supported data source and returns its settings, which can be used for UI rendering.</p>
|
||||
<p>Retrieves a supported data source and returns its settings.</p>
|
||||
<h1 id="scopes">Scopes</h1>
|
||||
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
|
||||
<ul>
|
||||
<li><em>https://www.googleapis.com/auth/bigquery</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/bigquery.readonly</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/cloud-platform</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/cloud-platform.read-only</em></li>
|
||||
</ul>
|
||||
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/bigquery.readonly</em>.
|
||||
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/bigquery</em>.
|
||||
You can set the scope for this method like this: <code>bigquerydatatransfer1 --scope <scope> projects locations-data-sources-get ...</code></p>
|
||||
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
||||
<ul>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Locations Data Sources List - BigQuery Data Transfer v2.0.4+20210324</title>
|
||||
<title>Locations Data Sources List - BigQuery Data Transfer v3.0.0+20220225</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v2.0.4+20210324</a>
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v3.0.0+20220225</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -59,6 +59,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_enroll-data-sources">Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-data-sources-check-valid-creds">Locations Data Sources Check Valid Creds</a>
|
||||
|
||||
@@ -93,6 +98,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-enroll-data-sources">Locations Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-get">Locations Get</a>
|
||||
|
||||
@@ -249,21 +259,20 @@
|
||||
</div>
|
||||
<div role="main">
|
||||
<div class="section">
|
||||
<p>Lists supported data sources and returns their settings, which can be used for UI rendering.</p>
|
||||
<p>Lists supported data sources and returns their settings.</p>
|
||||
<h1 id="scopes">Scopes</h1>
|
||||
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
|
||||
<ul>
|
||||
<li><em>https://www.googleapis.com/auth/bigquery</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/bigquery.readonly</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/cloud-platform</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/cloud-platform.read-only</em></li>
|
||||
</ul>
|
||||
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/bigquery.readonly</em>.
|
||||
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/bigquery</em>.
|
||||
You can set the scope for this method like this: <code>bigquerydatatransfer1 --scope <scope> projects locations-data-sources-list ...</code></p>
|
||||
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
||||
<ul>
|
||||
<li><strong><parent></strong> <em>(string)</em><ul>
|
||||
<li>Required. The BigQuery project id for which data sources should be returned. Must be in the form: <code>projects/{project_id}</code> or `projects/{project_id}/locations/{location_id}</li>
|
||||
<li>Required. The BigQuery project id for which data sources should be returned. Must be in the form: <code>projects/{project_id}</code> or <code>projects/{project_id}/locations/{location_id}</code></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -373,7 +382,7 @@ or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> eve
|
||||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
<a href="../projects_locations-get" class="btn btn-neutral float-right" title="Locations Get"/>Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||
<a href="../projects_locations-enroll-data-sources" class="btn btn-neutral float-right" title="Locations Enroll Data Sources"/>Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||
|
||||
|
||||
<a href="../projects_locations-data-sources-get" class="btn btn-neutral" title="Locations Data Sources Get"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||
@@ -405,7 +414,7 @@ or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> eve
|
||||
<a class="icon icon-github" style="float: left; color: #fcfcfc"> GitHub</a>
|
||||
|
||||
<span><a href="../projects_locations-data-sources-get" style="color: #fcfcfc;">« Previous</a></span>
|
||||
<span style="margin-left: 15px"><a href="../projects_locations-get" style="color: #fcfcfc">Next »</a></span>
|
||||
<span style="margin-left: 15px"><a href="../projects_locations-enroll-data-sources" style="color: #fcfcfc">Next »</a></span>
|
||||
</span>
|
||||
</div>
|
||||
</body>
|
||||
|
||||
@@ -0,0 +1,429 @@
|
||||
<!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 Enroll Data Sources - BigQuery Data Transfer v3.0.0+20220225</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"> BigQuery Data Transfer v3.0.0+20220225</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_data-sources-check-valid-creds">Data Sources Check Valid Creds</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_data-sources-get">Data Sources Get</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_data-sources-list">Data Sources List</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_enroll-data-sources">Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-data-sources-check-valid-creds">Locations Data Sources Check Valid Creds</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-data-sources-get">Locations Data Sources Get</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-data-sources-list">Locations Data Sources List</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 current">
|
||||
<a class="current" href=".">Locations Enroll Data Sources</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-general-properties">Optional General Properties</a></li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-get">Locations Get</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-list">Locations List</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-transfer-configs-create">Locations Transfer Configs Create</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-transfer-configs-delete">Locations Transfer Configs Delete</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-transfer-configs-get">Locations Transfer Configs Get</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-transfer-configs-list">Locations Transfer Configs List</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-transfer-configs-patch">Locations Transfer Configs Patch</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-transfer-configs-runs-delete">Locations Transfer Configs Runs Delete</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-transfer-configs-runs-get">Locations Transfer Configs Runs Get</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-transfer-configs-runs-list">Locations Transfer Configs Runs List</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-transfer-configs-runs-transfer-logs-list">Locations Transfer Configs Runs Transfer Logs List</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-transfer-configs-schedule-runs">Locations Transfer Configs Schedule Runs</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-transfer-configs-start-manual-runs">Locations Transfer Configs Start Manual Runs</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_transfer-configs-create">Transfer Configs Create</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_transfer-configs-delete">Transfer Configs Delete</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_transfer-configs-get">Transfer Configs Get</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_transfer-configs-list">Transfer Configs List</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_transfer-configs-patch">Transfer Configs Patch</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_transfer-configs-runs-delete">Transfer Configs Runs Delete</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_transfer-configs-runs-get">Transfer Configs Runs Get</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_transfer-configs-runs-list">Transfer Configs Runs List</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_transfer-configs-runs-transfer-logs-list">Transfer Configs Runs Transfer Logs List</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_transfer-configs-schedule-runs">Transfer Configs Schedule Runs</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_transfer-configs-start-manual-runs">Transfer Configs Start Manual Runs</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 Enroll Data Sources</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/bigquerydatatransfer1-cli" class="icon icon-github"> Edit on GitHub</a>
|
||||
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main">
|
||||
<div class="section">
|
||||
<p>Enroll data sources in a user project. This allows users to create transfer configurations for these data sources. They will also appear in the ListDataSources RPC and as such, will appear in the BigQuery UI 'https://bigquery.cloud.google.com' (and the documents can be found at https://cloud.google.com/bigquery/bigquery-web-ui and https://cloud.google.com/bigquery/docs/working-with-transfers).</p>
|
||||
<h1 id="scopes">Scopes</h1>
|
||||
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
|
||||
<ul>
|
||||
<li><em>https://www.googleapis.com/auth/bigquery</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/cloud-platform</em></li>
|
||||
</ul>
|
||||
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/bigquery</em>.
|
||||
You can set the scope for this method like this: <code>bigquerydatatransfer1 --scope <scope> projects locations-enroll-data-sources ...</code></p>
|
||||
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
||||
<ul>
|
||||
<li><strong><name></strong> <em>(string)</em><ul>
|
||||
<li>The name of the project resource in the form: <code>projects/{project_id}</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>EnrollDataSourcesRequest:
|
||||
data-source-ids: [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 . data-source-ids=magna</code><ul>
|
||||
<li>Data sources that are enrolled. It is required to provide at least one data source id.</li>
|
||||
<li>Each invocation of this argument appends the given value to the array.</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-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-get" class="btn btn-neutral float-right" title="Locations Get"/>Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||
|
||||
|
||||
<a href="../projects_locations-data-sources-list" class="btn btn-neutral" title="Locations Data Sources 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-data-sources-list" style="color: #fcfcfc;">« Previous</a></span>
|
||||
<span style="margin-left: 15px"><a href="../projects_locations-get" style="color: #fcfcfc">Next »</a></span>
|
||||
</span>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Locations Get - BigQuery Data Transfer v2.0.4+20210324</title>
|
||||
<title>Locations Get - BigQuery Data Transfer v3.0.0+20220225</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v2.0.4+20210324</a>
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v3.0.0+20220225</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -59,6 +59,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_enroll-data-sources">Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-data-sources-check-valid-creds">Locations Data Sources Check Valid Creds</a>
|
||||
|
||||
@@ -74,6 +79,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-enroll-data-sources">Locations Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 current">
|
||||
<a class="current" href=".">Locations Get</a>
|
||||
|
||||
@@ -251,11 +261,10 @@
|
||||
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
|
||||
<ul>
|
||||
<li><em>https://www.googleapis.com/auth/bigquery</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/bigquery.readonly</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/cloud-platform</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/cloud-platform.read-only</em></li>
|
||||
</ul>
|
||||
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/bigquery.readonly</em>.
|
||||
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/bigquery</em>.
|
||||
You can set the scope for this method like this: <code>bigquerydatatransfer1 --scope <scope> projects locations-get ...</code></p>
|
||||
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
||||
<ul>
|
||||
@@ -355,7 +364,7 @@ You can set the scope for this method like this: <code>bigquerydatatransfer1 --s
|
||||
<a href="../projects_locations-list" class="btn btn-neutral float-right" title="Locations List"/>Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||
|
||||
|
||||
<a href="../projects_locations-data-sources-list" class="btn btn-neutral" title="Locations Data Sources List"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||
<a href="../projects_locations-enroll-data-sources" class="btn btn-neutral" title="Locations Enroll Data Sources"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -383,7 +392,7 @@ You can set the scope for this method like this: <code>bigquerydatatransfer1 --s
|
||||
|
||||
<a class="icon icon-github" style="float: left; color: #fcfcfc"> GitHub</a>
|
||||
|
||||
<span><a href="../projects_locations-data-sources-list" style="color: #fcfcfc;">« Previous</a></span>
|
||||
<span><a href="../projects_locations-enroll-data-sources" style="color: #fcfcfc;">« Previous</a></span>
|
||||
<span style="margin-left: 15px"><a href="../projects_locations-list" style="color: #fcfcfc">Next »</a></span>
|
||||
</span>
|
||||
</div>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Locations List - BigQuery Data Transfer v2.0.4+20210324</title>
|
||||
<title>Locations List - BigQuery Data Transfer v3.0.0+20220225</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v2.0.4+20210324</a>
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v3.0.0+20220225</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -59,6 +59,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_enroll-data-sources">Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-data-sources-check-valid-creds">Locations Data Sources Check Valid Creds</a>
|
||||
|
||||
@@ -74,6 +79,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-enroll-data-sources">Locations Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-get">Locations Get</a>
|
||||
|
||||
@@ -254,11 +264,10 @@
|
||||
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
|
||||
<ul>
|
||||
<li><em>https://www.googleapis.com/auth/bigquery</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/bigquery.readonly</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/cloud-platform</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/cloud-platform.read-only</em></li>
|
||||
</ul>
|
||||
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/bigquery.readonly</em>.
|
||||
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/bigquery</em>.
|
||||
You can set the scope for this method like this: <code>bigquerydatatransfer1 --scope <scope> projects locations-list ...</code></p>
|
||||
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
||||
<ul>
|
||||
@@ -292,7 +301,7 @@ or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> eve
|
||||
<li>
|
||||
<p><strong>-p page-size=integer</strong></p>
|
||||
<ul>
|
||||
<li>The maximum number of results to return. If not set, the service will select a default.</li>
|
||||
<li>The maximum number of results to return. If not set, the service selects a default.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Locations Transfer Configs Create - BigQuery Data Transfer v2.0.4+20210324</title>
|
||||
<title>Locations Transfer Configs Create - BigQuery Data Transfer v3.0.0+20220225</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v2.0.4+20210324</a>
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v3.0.0+20220225</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -59,6 +59,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_enroll-data-sources">Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-data-sources-check-valid-creds">Locations Data Sources Check Valid Creds</a>
|
||||
|
||||
@@ -74,6 +79,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-enroll-data-sources">Locations Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-get">Locations Get</a>
|
||||
|
||||
@@ -282,6 +292,8 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
name: string
|
||||
next-run-time: string
|
||||
notification-pubsub-topic: string
|
||||
owner-info:
|
||||
email: string
|
||||
schedule: string
|
||||
schedule-options:
|
||||
disable-auto-scheduling: boolean
|
||||
@@ -295,19 +307,19 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
|
||||
<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 . data-refresh-window-days=79</code><ul>
|
||||
<li><code>-r . data-refresh-window-days=90</code><ul>
|
||||
<li>The number of days to look back to automatically refresh the data. For example, if <code>data_refresh_window_days = 10</code>, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>data-source-id=magna</code><ul>
|
||||
<li><code>data-source-id=ipsum</code><ul>
|
||||
<li>Data source id. Cannot be changed once data transfer is created.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>dataset-region=no</code><ul>
|
||||
<li><code>dataset-region=voluptua.</code><ul>
|
||||
<li>Output only. Region in which BigQuery dataset is located.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>destination-dataset-id=ipsum</code><ul>
|
||||
<li><code>destination-dataset-id=at</code><ul>
|
||||
<li>The BigQuery target dataset id.</li>
|
||||
</ul>
|
||||
</li>
|
||||
@@ -336,38 +348,46 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>notification-pubsub-topic=ipsum</code><ul>
|
||||
<li>Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish.</li>
|
||||
<li>Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish. The format for specifying a pubsub topic is: <code>projects/{project}/topics/{topic}</code></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>schedule=gubergren</code><ul>
|
||||
<li>Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: <code>1st,3rd monday of month 15:30</code>, <code>every wed,fri of jan,jun 13:15</code>, and <code>first sunday of quarter 00:00</code>. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: the granularity should be at least 8 hours, or less frequent.</li>
|
||||
<li>
|
||||
<p><code>owner-info email=gubergren</code></p>
|
||||
<ul>
|
||||
<li>E-mail address of the user.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>schedule-options disable-auto-scheduling=true</code><ul>
|
||||
<li>
|
||||
<p><code>.. schedule=lorem</code></p>
|
||||
<ul>
|
||||
<li>Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: <code>1st,3rd monday of month 15:30</code>, <code>every wed,fri of jan,jun 13:15</code>, and <code>first sunday of quarter 00:00</code>. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: The minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>schedule-options disable-auto-scheduling=false</code><ul>
|
||||
<li>If true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using StartManualTransferRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>end-time=gubergren</code><ul>
|
||||
<li><code>end-time=dolor</code><ul>
|
||||
<li>Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>start-time=eos</code></p>
|
||||
<p><code>start-time=ea</code></p>
|
||||
<ul>
|
||||
<li>Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>.. state=dolor</code></p>
|
||||
<p><code>.. state=ipsum</code></p>
|
||||
<ul>
|
||||
<li>Output only. State of the most recently updated transfer run.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>update-time=ea</code><ul>
|
||||
<li><code>update-time=invidunt</code><ul>
|
||||
<li>Output only. Data transfer modification time. Ignored by server on input.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>user-id=ipsum</code><ul>
|
||||
<li><code>user-id=amet</code><ul>
|
||||
<li>Deprecated. Unique ID of the user on whose behalf transfer is done.</li>
|
||||
</ul>
|
||||
</li>
|
||||
@@ -399,19 +419,19 @@ or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> eve
|
||||
<li>
|
||||
<p><strong>-p authorization-code=string</strong></p>
|
||||
<ul>
|
||||
<li>Optional OAuth2 authorization code to use with this transfer configuration. This is required if new credentials are needed, as indicated by <code>CheckValidCreds</code>. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.</li>
|
||||
<li>Optional OAuth2 authorization code to use with this transfer configuration. This is required only if <code>transferConfig.dataSourceId</code> is 'youtube_channel' and new credentials are needed, as indicated by <code>CheckValidCreds</code>. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when <code>service_account_name</code> is used to create the transfer config.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><strong>-p service-account-name=string</strong></p>
|
||||
<ul>
|
||||
<li>Optional service account name. If this field is set, transfer config will be created with this service account credentials. It requires that requesting user calling this API has permissions to act as this service account.</li>
|
||||
<li>Optional service account name. If this field is set, transfer config will be created with this service account credential. It requires that requesting user calling this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating transfer config. Please refer to this public guide for the latest list of data sources with service account support: https://cloud.google.com/bigquery-transfer/docs/use-service-accounts</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><strong>-p version-info=string</strong></p>
|
||||
<ul>
|
||||
<li>Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.</li>
|
||||
<li>Optional version info. This is required only if <code>transferConfig.dataSourceId</code> is anything else but 'youtube_channel' and new credentials are needed, as indicated by <code>CheckValidCreds</code>. In order to obtain version info, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when <code>service_account_name</code> is used to create the transfer config.</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Locations Transfer Configs Delete - BigQuery Data Transfer v2.0.4+20210324</title>
|
||||
<title>Locations Transfer Configs Delete - BigQuery Data Transfer v3.0.0+20220225</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v2.0.4+20210324</a>
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v3.0.0+20220225</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -59,6 +59,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_enroll-data-sources">Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-data-sources-check-valid-creds">Locations Data Sources Check Valid Creds</a>
|
||||
|
||||
@@ -74,6 +79,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-enroll-data-sources">Locations Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-get">Locations Get</a>
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Locations Transfer Configs Get - BigQuery Data Transfer v2.0.4+20210324</title>
|
||||
<title>Locations Transfer Configs Get - BigQuery Data Transfer v3.0.0+20220225</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v2.0.4+20210324</a>
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v3.0.0+20220225</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -59,6 +59,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_enroll-data-sources">Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-data-sources-check-valid-creds">Locations Data Sources Check Valid Creds</a>
|
||||
|
||||
@@ -74,6 +79,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-enroll-data-sources">Locations Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-get">Locations Get</a>
|
||||
|
||||
@@ -251,11 +261,10 @@
|
||||
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
|
||||
<ul>
|
||||
<li><em>https://www.googleapis.com/auth/bigquery</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/bigquery.readonly</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/cloud-platform</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/cloud-platform.read-only</em></li>
|
||||
</ul>
|
||||
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/bigquery.readonly</em>.
|
||||
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/bigquery</em>.
|
||||
You can set the scope for this method like this: <code>bigquerydatatransfer1 --scope <scope> projects locations-transfer-configs-get ...</code></p>
|
||||
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
||||
<ul>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Locations Transfer Configs List - BigQuery Data Transfer v2.0.4+20210324</title>
|
||||
<title>Locations Transfer Configs List - BigQuery Data Transfer v3.0.0+20220225</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v2.0.4+20210324</a>
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v3.0.0+20220225</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -59,6 +59,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_enroll-data-sources">Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-data-sources-check-valid-creds">Locations Data Sources Check Valid Creds</a>
|
||||
|
||||
@@ -74,6 +79,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-enroll-data-sources">Locations Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-get">Locations Get</a>
|
||||
|
||||
@@ -249,21 +259,20 @@
|
||||
</div>
|
||||
<div role="main">
|
||||
<div class="section">
|
||||
<p>Returns information about all data transfers in the project.</p>
|
||||
<p>Returns information about all transfer configs owned by a project in the specified location.</p>
|
||||
<h1 id="scopes">Scopes</h1>
|
||||
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
|
||||
<ul>
|
||||
<li><em>https://www.googleapis.com/auth/bigquery</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/bigquery.readonly</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/cloud-platform</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/cloud-platform.read-only</em></li>
|
||||
</ul>
|
||||
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/bigquery.readonly</em>.
|
||||
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/bigquery</em>.
|
||||
You can set the scope for this method like this: <code>bigquerydatatransfer1 --scope <scope> projects locations-transfer-configs-list ...</code></p>
|
||||
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
||||
<ul>
|
||||
<li><strong><parent></strong> <em>(string)</em><ul>
|
||||
<li>Required. The BigQuery project id for which data sources should be returned: <code>projects/{project_id}</code> or <code>projects/{project_id}/locations/{location_id}</code></li>
|
||||
<li>Required. The BigQuery project id for which transfer configs should be returned: <code>projects/{project_id}</code> or <code>projects/{project_id}/locations/{location_id}</code></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Locations Transfer Configs Patch - BigQuery Data Transfer v2.0.4+20210324</title>
|
||||
<title>Locations Transfer Configs Patch - BigQuery Data Transfer v3.0.0+20220225</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v2.0.4+20210324</a>
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v3.0.0+20220225</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -59,6 +59,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_enroll-data-sources">Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-data-sources-check-valid-creds">Locations Data Sources Check Valid Creds</a>
|
||||
|
||||
@@ -74,6 +79,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-enroll-data-sources">Locations Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-get">Locations Get</a>
|
||||
|
||||
@@ -282,6 +292,8 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
name: string
|
||||
next-run-time: string
|
||||
notification-pubsub-topic: string
|
||||
owner-info:
|
||||
email: string
|
||||
schedule: string
|
||||
schedule-options:
|
||||
disable-auto-scheduling: boolean
|
||||
@@ -295,27 +307,27 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
|
||||
<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 . data-refresh-window-days=13</code><ul>
|
||||
<li><code>-r . data-refresh-window-days=81</code><ul>
|
||||
<li>The number of days to look back to automatically refresh the data. For example, if <code>data_refresh_window_days = 10</code>, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>data-source-id=amet</code><ul>
|
||||
<li><code>data-source-id=ipsum</code><ul>
|
||||
<li>Data source id. Cannot be changed once data transfer is created.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>dataset-region=duo</code><ul>
|
||||
<li><code>dataset-region=sed</code><ul>
|
||||
<li>Output only. Region in which BigQuery dataset is located.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>destination-dataset-id=ipsum</code><ul>
|
||||
<li><code>destination-dataset-id=ut</code><ul>
|
||||
<li>The BigQuery target dataset id.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>disabled=false</code><ul>
|
||||
<li><code>disabled=true</code><ul>
|
||||
<li>Is this config disabled. When set to true, no runs are scheduled for a given transfer.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>display-name=ut</code><ul>
|
||||
<li><code>display-name=ipsum</code><ul>
|
||||
<li>User specified display name for the data transfer.</li>
|
||||
</ul>
|
||||
</li>
|
||||
@@ -326,48 +338,56 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>.. name=ipsum</code></p>
|
||||
<p><code>.. name=est</code></p>
|
||||
<ul>
|
||||
<li>The resource name of the transfer config. Transfer config names have the form <code>projects/{project_id}/locations/{region}/transferConfigs/{config_id}</code>. Where <code>config_id</code> is usually a uuid, even though it is not guaranteed or required. The name is ignored when creating a transfer config.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>next-run-time=ipsum</code><ul>
|
||||
<li><code>next-run-time=gubergren</code><ul>
|
||||
<li>Output only. Next time when data transfer will run.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>notification-pubsub-topic=est</code><ul>
|
||||
<li>Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish.</li>
|
||||
<li><code>notification-pubsub-topic=ea</code><ul>
|
||||
<li>Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish. The format for specifying a pubsub topic is: <code>projects/{project}/topics/{topic}</code></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>schedule=gubergren</code><ul>
|
||||
<li>Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: <code>1st,3rd monday of month 15:30</code>, <code>every wed,fri of jan,jun 13:15</code>, and <code>first sunday of quarter 00:00</code>. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: the granularity should be at least 8 hours, or less frequent.</li>
|
||||
<li>
|
||||
<p><code>owner-info email=dolor</code></p>
|
||||
<ul>
|
||||
<li>E-mail address of the user.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>.. schedule=lorem</code></p>
|
||||
<ul>
|
||||
<li>Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: <code>1st,3rd monday of month 15:30</code>, <code>every wed,fri of jan,jun 13:15</code>, and <code>first sunday of quarter 00:00</code>. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: The minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>schedule-options disable-auto-scheduling=false</code><ul>
|
||||
<li>If true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using StartManualTransferRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>end-time=lorem</code><ul>
|
||||
<li><code>end-time=sed</code><ul>
|
||||
<li>Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>start-time=eos</code></p>
|
||||
<p><code>start-time=duo</code></p>
|
||||
<ul>
|
||||
<li>Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>.. state=labore</code></p>
|
||||
<p><code>.. state=sed</code></p>
|
||||
<ul>
|
||||
<li>Output only. State of the most recently updated transfer run.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>update-time=sed</code><ul>
|
||||
<li><code>update-time=no</code><ul>
|
||||
<li>Output only. Data transfer modification time. Ignored by server on input.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>user-id=duo</code><ul>
|
||||
<li><code>user-id=stet</code><ul>
|
||||
<li>Deprecated. Unique ID of the user on whose behalf transfer is done.</li>
|
||||
</ul>
|
||||
</li>
|
||||
@@ -399,13 +419,13 @@ or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> eve
|
||||
<li>
|
||||
<p><strong>-p authorization-code=string</strong></p>
|
||||
<ul>
|
||||
<li>Optional OAuth2 authorization code to use with this transfer configuration. If it is provided, the transfer configuration will be associated with the authorizing user. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.</li>
|
||||
<li>Optional OAuth2 authorization code to use with this transfer configuration. This is required only if <code>transferConfig.dataSourceId</code> is 'youtube_channel' and new credentials are needed, as indicated by <code>CheckValidCreds</code>. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when <code>service_account_name</code> is used to create the transfer config.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><strong>-p service-account-name=string</strong></p>
|
||||
<ul>
|
||||
<li>Optional service account name. If this field is set and "service_account_name" is set in update_mask, transfer config will be updated to use this service account credentials. It requires that requesting user calling this API has permissions to act as this service account.</li>
|
||||
<li>Optional service account name. If this field is set and "service_account_name" is set in update_mask, transfer config will be created with this service account credential. It requires that requesting user calling this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating transfer config. Please refer to this public guide for the latest list of data sources with service account support: https://cloud.google.com/bigquery-transfer/docs/use-service-accounts</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
@@ -417,7 +437,7 @@ or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> eve
|
||||
<li>
|
||||
<p><strong>-p version-info=string</strong></p>
|
||||
<ul>
|
||||
<li>Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.</li>
|
||||
<li>Optional version info. This is required only if <code>transferConfig.dataSourceId</code> is anything else but 'youtube_channel' and new credentials are needed, as indicated by <code>CheckValidCreds</code>. In order to obtain version info, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when <code>service_account_name</code> is used to create the transfer config.</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Locations Transfer Configs Runs Delete - BigQuery Data Transfer v2.0.4+20210324</title>
|
||||
<title>Locations Transfer Configs Runs Delete - BigQuery Data Transfer v3.0.0+20220225</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v2.0.4+20210324</a>
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v3.0.0+20220225</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -59,6 +59,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_enroll-data-sources">Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-data-sources-check-valid-creds">Locations Data Sources Check Valid Creds</a>
|
||||
|
||||
@@ -74,6 +79,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-enroll-data-sources">Locations Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-get">Locations Get</a>
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Locations Transfer Configs Runs Get - BigQuery Data Transfer v2.0.4+20210324</title>
|
||||
<title>Locations Transfer Configs Runs Get - BigQuery Data Transfer v3.0.0+20220225</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v2.0.4+20210324</a>
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v3.0.0+20220225</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -59,6 +59,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_enroll-data-sources">Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-data-sources-check-valid-creds">Locations Data Sources Check Valid Creds</a>
|
||||
|
||||
@@ -74,6 +79,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-enroll-data-sources">Locations Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-get">Locations Get</a>
|
||||
|
||||
@@ -251,11 +261,10 @@
|
||||
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
|
||||
<ul>
|
||||
<li><em>https://www.googleapis.com/auth/bigquery</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/bigquery.readonly</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/cloud-platform</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/cloud-platform.read-only</em></li>
|
||||
</ul>
|
||||
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/bigquery.readonly</em>.
|
||||
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/bigquery</em>.
|
||||
You can set the scope for this method like this: <code>bigquerydatatransfer1 --scope <scope> projects locations-transfer-configs-runs-get ...</code></p>
|
||||
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
||||
<ul>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Locations Transfer Configs Runs List - BigQuery Data Transfer v2.0.4+20210324</title>
|
||||
<title>Locations Transfer Configs Runs List - BigQuery Data Transfer v3.0.0+20220225</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v2.0.4+20210324</a>
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v3.0.0+20220225</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -59,6 +59,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_enroll-data-sources">Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-data-sources-check-valid-creds">Locations Data Sources Check Valid Creds</a>
|
||||
|
||||
@@ -74,6 +79,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-enroll-data-sources">Locations Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-get">Locations Get</a>
|
||||
|
||||
@@ -249,16 +259,15 @@
|
||||
</div>
|
||||
<div role="main">
|
||||
<div class="section">
|
||||
<p>Returns information about running and completed jobs.</p>
|
||||
<p>Returns information about running and completed transfer runs.</p>
|
||||
<h1 id="scopes">Scopes</h1>
|
||||
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
|
||||
<ul>
|
||||
<li><em>https://www.googleapis.com/auth/bigquery</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/bigquery.readonly</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/cloud-platform</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/cloud-platform.read-only</em></li>
|
||||
</ul>
|
||||
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/bigquery.readonly</em>.
|
||||
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/bigquery</em>.
|
||||
You can set the scope for this method like this: <code>bigquerydatatransfer1 --scope <scope> projects locations-transfer-configs-runs-list ...</code></p>
|
||||
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
||||
<ul>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Locations Transfer Configs Runs Transfer Logs List - BigQuery Data Transfer v2.0.4+20210324</title>
|
||||
<title>Locations Transfer Configs Runs Transfer Logs List - BigQuery Data Transfer v3.0.0+20220225</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v2.0.4+20210324</a>
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v3.0.0+20220225</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -59,6 +59,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_enroll-data-sources">Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-data-sources-check-valid-creds">Locations Data Sources Check Valid Creds</a>
|
||||
|
||||
@@ -74,6 +79,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-enroll-data-sources">Locations Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-get">Locations Get</a>
|
||||
|
||||
@@ -249,16 +259,15 @@
|
||||
</div>
|
||||
<div role="main">
|
||||
<div class="section">
|
||||
<p>Returns user facing log messages for the data transfer run.</p>
|
||||
<p>Returns log messages for the transfer run.</p>
|
||||
<h1 id="scopes">Scopes</h1>
|
||||
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
|
||||
<ul>
|
||||
<li><em>https://www.googleapis.com/auth/bigquery</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/bigquery.readonly</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/cloud-platform</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/cloud-platform.read-only</em></li>
|
||||
</ul>
|
||||
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/bigquery.readonly</em>.
|
||||
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/bigquery</em>.
|
||||
You can set the scope for this method like this: <code>bigquerydatatransfer1 --scope <scope> projects locations-transfer-configs-runs-transfer-logs-list ...</code></p>
|
||||
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
||||
<ul>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Locations Transfer Configs Schedule Runs - BigQuery Data Transfer v2.0.4+20210324</title>
|
||||
<title>Locations Transfer Configs Schedule Runs - BigQuery Data Transfer v3.0.0+20220225</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v2.0.4+20210324</a>
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v3.0.0+20220225</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -59,6 +59,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_enroll-data-sources">Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-data-sources-check-valid-creds">Locations Data Sources Check Valid Creds</a>
|
||||
|
||||
@@ -74,6 +79,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-enroll-data-sources">Locations Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-get">Locations Get</a>
|
||||
|
||||
@@ -279,11 +289,11 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
|
||||
<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 . end-time=sed</code><ul>
|
||||
<li><code>-r . end-time=kasd</code><ul>
|
||||
<li>Required. End time of the range of transfer runs. For example, <code>&#34;2017-05-30T00:00:00+00:00&#34;</code>.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>start-time=no</code><ul>
|
||||
<li><code>start-time=et</code><ul>
|
||||
<li>Required. Start time of the range of transfer runs. For example, <code>&#34;2017-05-25T00:00:00+00:00&#34;</code>.</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Locations Transfer Configs Start Manual Runs - BigQuery Data Transfer v2.0.4+20210324</title>
|
||||
<title>Locations Transfer Configs Start Manual Runs - BigQuery Data Transfer v3.0.0+20220225</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v2.0.4+20210324</a>
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v3.0.0+20220225</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -59,6 +59,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_enroll-data-sources">Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-data-sources-check-valid-creds">Locations Data Sources Check Valid Creds</a>
|
||||
|
||||
@@ -74,6 +79,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-enroll-data-sources">Locations Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-get">Locations Get</a>
|
||||
|
||||
@@ -281,11 +291,11 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
|
||||
<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 . requested-run-time=stet</code><ul>
|
||||
<li><code>-r . requested-run-time=sed</code><ul>
|
||||
<li>Specific run_time for a transfer run to be started. The requested_run_time must not be in the future.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>requested-time-range end-time=kasd</code><ul>
|
||||
<li><code>requested-time-range end-time=et</code><ul>
|
||||
<li>End time of the range of transfer runs. For example, <code>&#34;2017-05-30T00:00:00+00:00&#34;</code>. The end_time must not be in the future. Creates transfer runs where run_time is in the range between start_time (inclusive) and end_time (exclusive).</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Transfer Configs Create - BigQuery Data Transfer v2.0.4+20210324</title>
|
||||
<title>Transfer Configs Create - BigQuery Data Transfer v3.0.0+20220225</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v2.0.4+20210324</a>
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v3.0.0+20220225</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -59,6 +59,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_enroll-data-sources">Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-data-sources-check-valid-creds">Locations Data Sources Check Valid Creds</a>
|
||||
|
||||
@@ -74,6 +79,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-enroll-data-sources">Locations Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-get">Locations Get</a>
|
||||
|
||||
@@ -282,6 +292,8 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
name: string
|
||||
next-run-time: string
|
||||
notification-pubsub-topic: string
|
||||
owner-info:
|
||||
email: string
|
||||
schedule: string
|
||||
schedule-options:
|
||||
disable-auto-scheduling: boolean
|
||||
@@ -295,19 +307,19 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
|
||||
<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 . data-refresh-window-days=58</code><ul>
|
||||
<li><code>-r . data-refresh-window-days=25</code><ul>
|
||||
<li>The number of days to look back to automatically refresh the data. For example, if <code>data_refresh_window_days = 10</code>, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>data-source-id=et</code><ul>
|
||||
<li><code>data-source-id=erat</code><ul>
|
||||
<li>Data source id. Cannot be changed once data transfer is created.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>dataset-region=et</code><ul>
|
||||
<li><code>dataset-region=sed</code><ul>
|
||||
<li>Output only. Region in which BigQuery dataset is located.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>destination-dataset-id=vero</code><ul>
|
||||
<li><code>destination-dataset-id=duo</code><ul>
|
||||
<li>The BigQuery target dataset id.</li>
|
||||
</ul>
|
||||
</li>
|
||||
@@ -315,50 +327,58 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
<li>Is this config disabled. When set to true, no runs are scheduled for a given transfer.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>display-name=duo</code><ul>
|
||||
<li><code>display-name=diam</code><ul>
|
||||
<li>User specified display name for the data transfer.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>email-preferences enable-failure-email=false</code></p>
|
||||
<p><code>email-preferences enable-failure-email=true</code></p>
|
||||
<ul>
|
||||
<li>If true, email notifications will be sent on transfer run failures.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>.. name=diam</code></p>
|
||||
<p><code>.. name=et</code></p>
|
||||
<ul>
|
||||
<li>The resource name of the transfer config. Transfer config names have the form <code>projects/{project_id}/locations/{region}/transferConfigs/{config_id}</code>. Where <code>config_id</code> is usually a uuid, even though it is not guaranteed or required. The name is ignored when creating a transfer config.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>next-run-time=dolor</code><ul>
|
||||
<li><code>next-run-time=et</code><ul>
|
||||
<li>Output only. Next time when data transfer will run.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>notification-pubsub-topic=et</code><ul>
|
||||
<li>Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish.</li>
|
||||
<li><code>notification-pubsub-topic=sadipscing</code><ul>
|
||||
<li>Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish. The format for specifying a pubsub topic is: <code>projects/{project}/topics/{topic}</code></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>schedule=et</code><ul>
|
||||
<li>Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: <code>1st,3rd monday of month 15:30</code>, <code>every wed,fri of jan,jun 13:15</code>, and <code>first sunday of quarter 00:00</code>. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: the granularity should be at least 8 hours, or less frequent.</li>
|
||||
<li>
|
||||
<p><code>owner-info email=stet</code></p>
|
||||
<ul>
|
||||
<li>E-mail address of the user.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>.. schedule=dolor</code></p>
|
||||
<ul>
|
||||
<li>Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: <code>1st,3rd monday of month 15:30</code>, <code>every wed,fri of jan,jun 13:15</code>, and <code>first sunday of quarter 00:00</code>. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: The minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>schedule-options disable-auto-scheduling=false</code><ul>
|
||||
<li>If true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using StartManualTransferRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>end-time=stet</code><ul>
|
||||
<li><code>end-time=vero</code><ul>
|
||||
<li>Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>start-time=dolor</code></p>
|
||||
<p><code>start-time=invidunt</code></p>
|
||||
<ul>
|
||||
<li>Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>.. state=duo</code></p>
|
||||
<p><code>.. state=stet</code></p>
|
||||
<ul>
|
||||
<li>Output only. State of the most recently updated transfer run.</li>
|
||||
</ul>
|
||||
@@ -367,7 +387,7 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
<li>Output only. Data transfer modification time. Ignored by server on input.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>user-id=vero</code><ul>
|
||||
<li><code>user-id=elitr</code><ul>
|
||||
<li>Deprecated. Unique ID of the user on whose behalf transfer is done.</li>
|
||||
</ul>
|
||||
</li>
|
||||
@@ -399,19 +419,19 @@ or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> eve
|
||||
<li>
|
||||
<p><strong>-p authorization-code=string</strong></p>
|
||||
<ul>
|
||||
<li>Optional OAuth2 authorization code to use with this transfer configuration. This is required if new credentials are needed, as indicated by <code>CheckValidCreds</code>. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.</li>
|
||||
<li>Optional OAuth2 authorization code to use with this transfer configuration. This is required only if <code>transferConfig.dataSourceId</code> is 'youtube_channel' and new credentials are needed, as indicated by <code>CheckValidCreds</code>. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when <code>service_account_name</code> is used to create the transfer config.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><strong>-p service-account-name=string</strong></p>
|
||||
<ul>
|
||||
<li>Optional service account name. If this field is set, transfer config will be created with this service account credentials. It requires that requesting user calling this API has permissions to act as this service account.</li>
|
||||
<li>Optional service account name. If this field is set, transfer config will be created with this service account credential. It requires that requesting user calling this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating transfer config. Please refer to this public guide for the latest list of data sources with service account support: https://cloud.google.com/bigquery-transfer/docs/use-service-accounts</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><strong>-p version-info=string</strong></p>
|
||||
<ul>
|
||||
<li>Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.</li>
|
||||
<li>Optional version info. This is required only if <code>transferConfig.dataSourceId</code> is anything else but 'youtube_channel' and new credentials are needed, as indicated by <code>CheckValidCreds</code>. In order to obtain version info, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when <code>service_account_name</code> is used to create the transfer config.</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Transfer Configs Delete - BigQuery Data Transfer v2.0.4+20210324</title>
|
||||
<title>Transfer Configs Delete - BigQuery Data Transfer v3.0.0+20220225</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v2.0.4+20210324</a>
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v3.0.0+20220225</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -59,6 +59,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_enroll-data-sources">Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-data-sources-check-valid-creds">Locations Data Sources Check Valid Creds</a>
|
||||
|
||||
@@ -74,6 +79,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-enroll-data-sources">Locations Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-get">Locations Get</a>
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Transfer Configs Get - BigQuery Data Transfer v2.0.4+20210324</title>
|
||||
<title>Transfer Configs Get - BigQuery Data Transfer v3.0.0+20220225</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v2.0.4+20210324</a>
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v3.0.0+20220225</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -59,6 +59,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_enroll-data-sources">Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-data-sources-check-valid-creds">Locations Data Sources Check Valid Creds</a>
|
||||
|
||||
@@ -74,6 +79,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-enroll-data-sources">Locations Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-get">Locations Get</a>
|
||||
|
||||
@@ -251,11 +261,10 @@
|
||||
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
|
||||
<ul>
|
||||
<li><em>https://www.googleapis.com/auth/bigquery</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/bigquery.readonly</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/cloud-platform</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/cloud-platform.read-only</em></li>
|
||||
</ul>
|
||||
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/bigquery.readonly</em>.
|
||||
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/bigquery</em>.
|
||||
You can set the scope for this method like this: <code>bigquerydatatransfer1 --scope <scope> projects transfer-configs-get ...</code></p>
|
||||
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
||||
<ul>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Transfer Configs List - BigQuery Data Transfer v2.0.4+20210324</title>
|
||||
<title>Transfer Configs List - BigQuery Data Transfer v3.0.0+20220225</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v2.0.4+20210324</a>
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v3.0.0+20220225</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -59,6 +59,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_enroll-data-sources">Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-data-sources-check-valid-creds">Locations Data Sources Check Valid Creds</a>
|
||||
|
||||
@@ -74,6 +79,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-enroll-data-sources">Locations Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-get">Locations Get</a>
|
||||
|
||||
@@ -249,21 +259,20 @@
|
||||
</div>
|
||||
<div role="main">
|
||||
<div class="section">
|
||||
<p>Returns information about all data transfers in the project.</p>
|
||||
<p>Returns information about all transfer configs owned by a project in the specified location.</p>
|
||||
<h1 id="scopes">Scopes</h1>
|
||||
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
|
||||
<ul>
|
||||
<li><em>https://www.googleapis.com/auth/bigquery</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/bigquery.readonly</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/cloud-platform</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/cloud-platform.read-only</em></li>
|
||||
</ul>
|
||||
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/bigquery.readonly</em>.
|
||||
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/bigquery</em>.
|
||||
You can set the scope for this method like this: <code>bigquerydatatransfer1 --scope <scope> projects transfer-configs-list ...</code></p>
|
||||
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
||||
<ul>
|
||||
<li><strong><parent></strong> <em>(string)</em><ul>
|
||||
<li>Required. The BigQuery project id for which data sources should be returned: <code>projects/{project_id}</code> or <code>projects/{project_id}/locations/{location_id}</code></li>
|
||||
<li>Required. The BigQuery project id for which transfer configs should be returned: <code>projects/{project_id}</code> or <code>projects/{project_id}/locations/{location_id}</code></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Transfer Configs Patch - BigQuery Data Transfer v2.0.4+20210324</title>
|
||||
<title>Transfer Configs Patch - BigQuery Data Transfer v3.0.0+20220225</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v2.0.4+20210324</a>
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v3.0.0+20220225</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -59,6 +59,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_enroll-data-sources">Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-data-sources-check-valid-creds">Locations Data Sources Check Valid Creds</a>
|
||||
|
||||
@@ -74,6 +79,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-enroll-data-sources">Locations Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-get">Locations Get</a>
|
||||
|
||||
@@ -282,6 +292,8 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
name: string
|
||||
next-run-time: string
|
||||
notification-pubsub-topic: string
|
||||
owner-info:
|
||||
email: string
|
||||
schedule: string
|
||||
schedule-options:
|
||||
disable-auto-scheduling: boolean
|
||||
@@ -295,19 +307,19 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
|
||||
<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 . data-refresh-window-days=13</code><ul>
|
||||
<li><code>-r . data-refresh-window-days=95</code><ul>
|
||||
<li>The number of days to look back to automatically refresh the data. For example, if <code>data_refresh_window_days = 10</code>, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>data-source-id=stet</code><ul>
|
||||
<li><code>data-source-id=diam</code><ul>
|
||||
<li>Data source id. Cannot be changed once data transfer is created.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>dataset-region=vero</code><ul>
|
||||
<li><code>dataset-region=no</code><ul>
|
||||
<li>Output only. Region in which BigQuery dataset is located.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>destination-dataset-id=elitr</code><ul>
|
||||
<li><code>destination-dataset-id=ipsum</code><ul>
|
||||
<li>The BigQuery target dataset id.</li>
|
||||
</ul>
|
||||
</li>
|
||||
@@ -315,59 +327,67 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
<li>Is this config disabled. When set to true, no runs are scheduled for a given transfer.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>display-name=ipsum</code><ul>
|
||||
<li><code>display-name=consetetur</code><ul>
|
||||
<li>User specified display name for the data transfer.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>email-preferences enable-failure-email=true</code></p>
|
||||
<p><code>email-preferences enable-failure-email=false</code></p>
|
||||
<ul>
|
||||
<li>If true, email notifications will be sent on transfer run failures.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>.. name=consetetur</code></p>
|
||||
<p><code>.. name=erat</code></p>
|
||||
<ul>
|
||||
<li>The resource name of the transfer config. Transfer config names have the form <code>projects/{project_id}/locations/{region}/transferConfigs/{config_id}</code>. Where <code>config_id</code> is usually a uuid, even though it is not guaranteed or required. The name is ignored when creating a transfer config.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>next-run-time=voluptua.</code><ul>
|
||||
<li><code>next-run-time=consetetur</code><ul>
|
||||
<li>Output only. Next time when data transfer will run.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>notification-pubsub-topic=et</code><ul>
|
||||
<li>Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish.</li>
|
||||
<li><code>notification-pubsub-topic=amet.</code><ul>
|
||||
<li>Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish. The format for specifying a pubsub topic is: <code>projects/{project}/topics/{topic}</code></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>schedule=erat</code><ul>
|
||||
<li>Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: <code>1st,3rd monday of month 15:30</code>, <code>every wed,fri of jan,jun 13:15</code>, and <code>first sunday of quarter 00:00</code>. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: the granularity should be at least 8 hours, or less frequent.</li>
|
||||
<li>
|
||||
<p><code>owner-info email=sed</code></p>
|
||||
<ul>
|
||||
<li>E-mail address of the user.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>schedule-options disable-auto-scheduling=false</code><ul>
|
||||
<li>
|
||||
<p><code>.. schedule=takimata</code></p>
|
||||
<ul>
|
||||
<li>Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: <code>1st,3rd monday of month 15:30</code>, <code>every wed,fri of jan,jun 13:15</code>, and <code>first sunday of quarter 00:00</code>. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: The minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>schedule-options disable-auto-scheduling=true</code><ul>
|
||||
<li>If true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using StartManualTransferRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>end-time=amet.</code><ul>
|
||||
<li><code>end-time=et</code><ul>
|
||||
<li>Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>start-time=sed</code></p>
|
||||
<p><code>start-time=accusam</code></p>
|
||||
<ul>
|
||||
<li>Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>.. state=takimata</code></p>
|
||||
<p><code>.. state=voluptua.</code></p>
|
||||
<ul>
|
||||
<li>Output only. State of the most recently updated transfer run.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>update-time=dolores</code><ul>
|
||||
<li><code>update-time=dolore</code><ul>
|
||||
<li>Output only. Data transfer modification time. Ignored by server on input.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>user-id=gubergren</code><ul>
|
||||
<li><code>user-id=dolore</code><ul>
|
||||
<li>Deprecated. Unique ID of the user on whose behalf transfer is done.</li>
|
||||
</ul>
|
||||
</li>
|
||||
@@ -399,13 +419,13 @@ or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> eve
|
||||
<li>
|
||||
<p><strong>-p authorization-code=string</strong></p>
|
||||
<ul>
|
||||
<li>Optional OAuth2 authorization code to use with this transfer configuration. If it is provided, the transfer configuration will be associated with the authorizing user. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.</li>
|
||||
<li>Optional OAuth2 authorization code to use with this transfer configuration. This is required only if <code>transferConfig.dataSourceId</code> is 'youtube_channel' and new credentials are needed, as indicated by <code>CheckValidCreds</code>. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when <code>service_account_name</code> is used to create the transfer config.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><strong>-p service-account-name=string</strong></p>
|
||||
<ul>
|
||||
<li>Optional service account name. If this field is set and "service_account_name" is set in update_mask, transfer config will be updated to use this service account credentials. It requires that requesting user calling this API has permissions to act as this service account.</li>
|
||||
<li>Optional service account name. If this field is set and "service_account_name" is set in update_mask, transfer config will be created with this service account credential. It requires that requesting user calling this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating transfer config. Please refer to this public guide for the latest list of data sources with service account support: https://cloud.google.com/bigquery-transfer/docs/use-service-accounts</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
@@ -417,7 +437,7 @@ or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> eve
|
||||
<li>
|
||||
<p><strong>-p version-info=string</strong></p>
|
||||
<ul>
|
||||
<li>Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.</li>
|
||||
<li>Optional version info. This is required only if <code>transferConfig.dataSourceId</code> is anything else but 'youtube_channel' and new credentials are needed, as indicated by <code>CheckValidCreds</code>. In order to obtain version info, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when <code>service_account_name</code> is used to create the transfer config.</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Transfer Configs Runs Delete - BigQuery Data Transfer v2.0.4+20210324</title>
|
||||
<title>Transfer Configs Runs Delete - BigQuery Data Transfer v3.0.0+20220225</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v2.0.4+20210324</a>
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v3.0.0+20220225</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -59,6 +59,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_enroll-data-sources">Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-data-sources-check-valid-creds">Locations Data Sources Check Valid Creds</a>
|
||||
|
||||
@@ -74,6 +79,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-enroll-data-sources">Locations Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-get">Locations Get</a>
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Transfer Configs Runs Get - BigQuery Data Transfer v2.0.4+20210324</title>
|
||||
<title>Transfer Configs Runs Get - BigQuery Data Transfer v3.0.0+20220225</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v2.0.4+20210324</a>
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v3.0.0+20220225</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -59,6 +59,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_enroll-data-sources">Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-data-sources-check-valid-creds">Locations Data Sources Check Valid Creds</a>
|
||||
|
||||
@@ -74,6 +79,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-enroll-data-sources">Locations Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-get">Locations Get</a>
|
||||
|
||||
@@ -251,11 +261,10 @@
|
||||
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
|
||||
<ul>
|
||||
<li><em>https://www.googleapis.com/auth/bigquery</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/bigquery.readonly</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/cloud-platform</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/cloud-platform.read-only</em></li>
|
||||
</ul>
|
||||
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/bigquery.readonly</em>.
|
||||
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/bigquery</em>.
|
||||
You can set the scope for this method like this: <code>bigquerydatatransfer1 --scope <scope> projects transfer-configs-runs-get ...</code></p>
|
||||
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
||||
<ul>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Transfer Configs Runs List - BigQuery Data Transfer v2.0.4+20210324</title>
|
||||
<title>Transfer Configs Runs List - BigQuery Data Transfer v3.0.0+20220225</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v2.0.4+20210324</a>
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v3.0.0+20220225</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -59,6 +59,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_enroll-data-sources">Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-data-sources-check-valid-creds">Locations Data Sources Check Valid Creds</a>
|
||||
|
||||
@@ -74,6 +79,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-enroll-data-sources">Locations Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-get">Locations Get</a>
|
||||
|
||||
@@ -249,16 +259,15 @@
|
||||
</div>
|
||||
<div role="main">
|
||||
<div class="section">
|
||||
<p>Returns information about running and completed jobs.</p>
|
||||
<p>Returns information about running and completed transfer runs.</p>
|
||||
<h1 id="scopes">Scopes</h1>
|
||||
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
|
||||
<ul>
|
||||
<li><em>https://www.googleapis.com/auth/bigquery</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/bigquery.readonly</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/cloud-platform</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/cloud-platform.read-only</em></li>
|
||||
</ul>
|
||||
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/bigquery.readonly</em>.
|
||||
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/bigquery</em>.
|
||||
You can set the scope for this method like this: <code>bigquerydatatransfer1 --scope <scope> projects transfer-configs-runs-list ...</code></p>
|
||||
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
||||
<ul>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Transfer Configs Runs Transfer Logs List - BigQuery Data Transfer v2.0.4+20210324</title>
|
||||
<title>Transfer Configs Runs Transfer Logs List - BigQuery Data Transfer v3.0.0+20220225</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v2.0.4+20210324</a>
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v3.0.0+20220225</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -59,6 +59,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_enroll-data-sources">Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-data-sources-check-valid-creds">Locations Data Sources Check Valid Creds</a>
|
||||
|
||||
@@ -74,6 +79,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-enroll-data-sources">Locations Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-get">Locations Get</a>
|
||||
|
||||
@@ -249,16 +259,15 @@
|
||||
</div>
|
||||
<div role="main">
|
||||
<div class="section">
|
||||
<p>Returns user facing log messages for the data transfer run.</p>
|
||||
<p>Returns log messages for the transfer run.</p>
|
||||
<h1 id="scopes">Scopes</h1>
|
||||
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
|
||||
<ul>
|
||||
<li><em>https://www.googleapis.com/auth/bigquery</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/bigquery.readonly</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/cloud-platform</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/cloud-platform.read-only</em></li>
|
||||
</ul>
|
||||
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/bigquery.readonly</em>.
|
||||
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/bigquery</em>.
|
||||
You can set the scope for this method like this: <code>bigquerydatatransfer1 --scope <scope> projects transfer-configs-runs-transfer-logs-list ...</code></p>
|
||||
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
||||
<ul>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Transfer Configs Schedule Runs - BigQuery Data Transfer v2.0.4+20210324</title>
|
||||
<title>Transfer Configs Schedule Runs - BigQuery Data Transfer v3.0.0+20220225</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v2.0.4+20210324</a>
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v3.0.0+20220225</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -59,6 +59,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_enroll-data-sources">Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-data-sources-check-valid-creds">Locations Data Sources Check Valid Creds</a>
|
||||
|
||||
@@ -74,6 +79,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-enroll-data-sources">Locations Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-get">Locations Get</a>
|
||||
|
||||
@@ -279,11 +289,11 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
|
||||
<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 . end-time=et</code><ul>
|
||||
<li><code>-r . end-time=dolore</code><ul>
|
||||
<li>Required. End time of the range of transfer runs. For example, <code>&#34;2017-05-30T00:00:00+00:00&#34;</code>.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>start-time=accusam</code><ul>
|
||||
<li><code>start-time=voluptua.</code><ul>
|
||||
<li>Required. Start time of the range of transfer runs. For example, <code>&#34;2017-05-25T00:00:00+00:00&#34;</code>.</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Transfer Configs Start Manual Runs - BigQuery Data Transfer v2.0.4+20210324</title>
|
||||
<title>Transfer Configs Start Manual Runs - BigQuery Data Transfer v3.0.0+20220225</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v2.0.4+20210324</a>
|
||||
<a href=".." class="icon icon-home"> BigQuery Data Transfer v3.0.0+20220225</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -59,6 +59,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_enroll-data-sources">Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-data-sources-check-valid-creds">Locations Data Sources Check Valid Creds</a>
|
||||
|
||||
@@ -74,6 +79,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-enroll-data-sources">Locations Enroll Data Sources</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_locations-get">Locations Get</a>
|
||||
|
||||
@@ -281,15 +291,15 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
|
||||
<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 . requested-run-time=voluptua.</code><ul>
|
||||
<li><code>-r . requested-run-time=amet.</code><ul>
|
||||
<li>Specific run_time for a transfer run to be started. The requested_run_time must not be in the future.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>requested-time-range end-time=dolore</code><ul>
|
||||
<li><code>requested-time-range end-time=ea</code><ul>
|
||||
<li>End time of the range of transfer runs. For example, <code>&#34;2017-05-30T00:00:00+00:00&#34;</code>. The end_time must not be in the future. Creates transfer runs where run_time is in the range between start_time (inclusive) and end_time (exclusive).</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>start-time=dolore</code><ul>
|
||||
<li><code>start-time=sadipscing</code><ul>
|
||||
<li>Start time of the range of transfer runs. For example, <code>&#34;2017-05-25T00:00:00+00:00&#34;</code>. The start_time must be strictly less than the end_time. Creates transfer runs where run_time is in the range between start_time (inclusive) and end_time (exclusive).</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
Reference in New Issue
Block a user