OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-01-25 12:44:07 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
a20241b2412723b0062d1c19a8ec792837b145a4
google-apis-rs/google_cloudkms1_cli/projects_locations-generate-random-bytes/index.html
Sebastian Thiel a20241b241 Update documentation
2022-03-08 15:36:16 +08:00

493 lines
20 KiB
HTML
Raw Blame History

<!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 Generate Random Bytes - Cloud KMS 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"> Cloud KMS 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_locations-ekm-connections-create">Locations Ekm Connections Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-ekm-connections-get">Locations Ekm Connections Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-ekm-connections-get-iam-policy">Locations Ekm Connections Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-ekm-connections-list">Locations Ekm Connections List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-ekm-connections-patch">Locations Ekm Connections Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-ekm-connections-set-iam-policy">Locations Ekm Connections Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-ekm-connections-test-iam-permissions">Locations Ekm Connections Test Iam Permissions</a>
</li>
<li class="toctree-l1 current">
<a class="current" href=".">Locations Generate Random Bytes</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-key-rings-create">Locations Key Rings Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-key-rings-crypto-keys-create">Locations Key Rings Crypto Keys Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-key-rings-crypto-keys-crypto-key-versions-asymmetric-decrypt">Locations Key Rings Crypto Keys Crypto Key Versions Asymmetric Decrypt</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-key-rings-crypto-keys-crypto-key-versions-asymmetric-sign">Locations Key Rings Crypto Keys Crypto Key Versions Asymmetric Sign</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-key-rings-crypto-keys-crypto-key-versions-create">Locations Key Rings Crypto Keys Crypto Key Versions Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-key-rings-crypto-keys-crypto-key-versions-destroy">Locations Key Rings Crypto Keys Crypto Key Versions Destroy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-key-rings-crypto-keys-crypto-key-versions-get">Locations Key Rings Crypto Keys Crypto Key Versions Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-key-rings-crypto-keys-crypto-key-versions-get-public-key">Locations Key Rings Crypto Keys Crypto Key Versions Get Public Key</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-key-rings-crypto-keys-crypto-key-versions-import">Locations Key Rings Crypto Keys Crypto Key Versions Import</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-key-rings-crypto-keys-crypto-key-versions-list">Locations Key Rings Crypto Keys Crypto Key Versions List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-key-rings-crypto-keys-crypto-key-versions-mac-sign">Locations Key Rings Crypto Keys Crypto Key Versions Mac Sign</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-key-rings-crypto-keys-crypto-key-versions-mac-verify">Locations Key Rings Crypto Keys Crypto Key Versions Mac Verify</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-key-rings-crypto-keys-crypto-key-versions-patch">Locations Key Rings Crypto Keys Crypto Key Versions Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-key-rings-crypto-keys-crypto-key-versions-restore">Locations Key Rings Crypto Keys Crypto Key Versions Restore</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-key-rings-crypto-keys-decrypt">Locations Key Rings Crypto Keys Decrypt</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-key-rings-crypto-keys-encrypt">Locations Key Rings Crypto Keys Encrypt</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-key-rings-crypto-keys-get">Locations Key Rings Crypto Keys Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-key-rings-crypto-keys-get-iam-policy">Locations Key Rings Crypto Keys Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-key-rings-crypto-keys-list">Locations Key Rings Crypto Keys List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-key-rings-crypto-keys-patch">Locations Key Rings Crypto Keys Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-key-rings-crypto-keys-set-iam-policy">Locations Key Rings Crypto Keys Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-key-rings-crypto-keys-test-iam-permissions">Locations Key Rings Crypto Keys Test Iam Permissions</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-key-rings-crypto-keys-update-primary-version">Locations Key Rings Crypto Keys Update Primary Version</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-key-rings-get">Locations Key Rings Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-key-rings-get-iam-policy">Locations Key Rings Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-key-rings-import-jobs-create">Locations Key Rings Import Jobs Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-key-rings-import-jobs-get">Locations Key Rings Import Jobs Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-key-rings-import-jobs-get-iam-policy">Locations Key Rings Import Jobs Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-key-rings-import-jobs-list">Locations Key Rings Import Jobs List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-key-rings-import-jobs-set-iam-policy">Locations Key Rings Import Jobs Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-key-rings-import-jobs-test-iam-permissions">Locations Key Rings Import Jobs Test Iam Permissions</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-key-rings-list">Locations Key Rings List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-key-rings-set-iam-policy">Locations Key Rings Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-key-rings-test-iam-permissions">Locations Key Rings Test Iam Permissions</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-list">Locations List</a>
</li>
</ul>
</div>
&nbsp;
</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> &raquo;</li>
<li>Locations Generate Random Bytes</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/cloudkms1-cli" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<p>Generate random bytes using the Cloud KMS randomness source in the provided 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/cloud-platform</em></li>
<li><em>https://www.googleapis.com/auth/cloudkms</em></li>
</ul>
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/cloud-platform</em>.
You can set the scope for this method like this: <code>cloudkms1 --scope &lt;scope&gt; projects locations-generate-random-bytes ...</code></p>
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
<ul>
<li><strong>&lt;location&gt;</strong> <em>(string)</em><ul>
<li>The project-specific location in which to generate random bytes. For example, &#34;projects/my-project/locations/us-central1&#34;.</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>GenerateRandomBytesRequest:
length-bytes: integer
protection-level: 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 . length-bytes=49</code><ul>
<li>The length in bytes of the amount of randomness to retrieve. Minimum 8 bytes, maximum 1024 bytes.</li>
</ul>
</li>
<li><code>protection-level=duo</code><ul>
<li>The ProtectionLevel to use when generating the random data. Currently, only HSM protection level is supported.</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. &#34;media&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
<li>
<p><strong>-p upload-protocol=string</strong></p>
<ul>
<li>Upload protocol for media (e.g. &#34;raw&#34;, &#34;multipart&#34;).</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-ekm-connections-test-iam-permissions" class="btn btn-neutral" title="Locations Ekm Connections Test Iam Permissions"><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-ekm-connections-test-iam-permissions" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../projects_locations-get" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink