mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-25 12:44:07 +01:00
817 lines
28 KiB
HTML
817 lines
28 KiB
HTML
<!DOCTYPE html>
|
|
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
|
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
<title>Insert - storage v3.0.0+20220228</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"> storage v3.0.0+20220228</a>
|
|
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|
<ul class="current">
|
|
|
|
|
|
<span>Bucket Access Controls</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../bucket-access-controls_delete">Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../bucket-access-controls_get">Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../bucket-access-controls_insert">Insert</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../bucket-access-controls_list">List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../bucket-access-controls_patch">Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../bucket-access-controls_update">Update</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<span>Buckets</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../buckets_delete">Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../buckets_get">Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../buckets_get-iam-policy">Get Iam Policy</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 current">
|
|
<a class="current" href=".">Insert</a>
|
|
|
|
<ul>
|
|
|
|
<li class="toctree-l2"><a href="#scopes">Scopes</a></li>
|
|
|
|
|
|
<li class="toctree-l2"><a href="#required-scalar-argument">Required Scalar Argument</a></li>
|
|
|
|
|
|
<li class="toctree-l2"><a href="#required-request-value">Required Request Value</a></li>
|
|
|
|
<li><a class="toctree-l3" href="#about-cursors">About Cursors</a></li>
|
|
|
|
|
|
<li class="toctree-l2"><a href="#optional-output-flags">Optional Output Flags</a></li>
|
|
|
|
|
|
<li class="toctree-l2"><a href="#optional-method-properties">Optional Method Properties</a></li>
|
|
|
|
|
|
<li class="toctree-l2"><a href="#optional-general-properties">Optional General Properties</a></li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../buckets_list">List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../buckets_lock-retention-policy">Lock Retention Policy</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../buckets_patch">Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../buckets_set-iam-policy">Set Iam Policy</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../buckets_test-iam-permissions">Test Iam Permissions</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../buckets_update">Update</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<span>Channels</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../channels_stop">Stop</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<span>Default Object Access Controls</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../default-object-access-controls_delete">Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../default-object-access-controls_get">Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../default-object-access-controls_insert">Insert</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../default-object-access-controls_list">List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../default-object-access-controls_patch">Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../default-object-access-controls_update">Update</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<span>Notifications</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../notifications_delete">Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../notifications_get">Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../notifications_insert">Insert</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../notifications_list">List</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<span>Object Access Controls</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../object-access-controls_delete">Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../object-access-controls_get">Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../object-access-controls_insert">Insert</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../object-access-controls_list">List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../object-access-controls_patch">Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../object-access-controls_update">Update</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<span>Objects</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../objects_compose">Compose</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../objects_copy">Copy</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../objects_delete">Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../objects_get">Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../objects_get-iam-policy">Get Iam Policy</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../objects_insert">Insert</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../objects_list">List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../objects_patch">Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../objects_rewrite">Rewrite</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../objects_set-iam-policy">Set Iam Policy</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../objects_test-iam-permissions">Test Iam Permissions</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../objects_update">Update</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../objects_watch-all">Watch All</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<span>Projects</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_hmac-keys-create">Hmac Keys Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_hmac-keys-delete">Hmac Keys Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_hmac-keys-get">Hmac Keys Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_hmac-keys-list">Hmac Keys List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_hmac-keys-update">Hmac Keys Update</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_service-account-get">Service Account Get</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>Insert</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/storage1-cli" class="icon icon-github"> Edit on GitHub</a>
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main">
|
|
<div class="section">
|
|
<p>Creates a new bucket.</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/devstorage.full_control</em></li>
|
|
<li><em>https://www.googleapis.com/auth/devstorage.read_write</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>storage1 --scope <scope> buckets insert ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><project></strong> <em>(string)</em><ul>
|
|
<li>A valid API project identifier.</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>Bucket:
|
|
autoclass:
|
|
enabled: boolean
|
|
toggle-time: string
|
|
billing:
|
|
requester-pays: boolean
|
|
custom-placement-config:
|
|
data-locations: [string]
|
|
default-event-based-hold: boolean
|
|
encryption:
|
|
default-kms-key-name: string
|
|
etag: string
|
|
iam-configuration:
|
|
bucket-policy-only:
|
|
enabled: boolean
|
|
locked-time: string
|
|
public-access-prevention: string
|
|
uniform-bucket-level-access:
|
|
enabled: boolean
|
|
locked-time: string
|
|
id: string
|
|
kind: string
|
|
labels: { string: string }
|
|
location: string
|
|
location-type: string
|
|
logging:
|
|
log-bucket: string
|
|
log-object-prefix: string
|
|
metageneration: string
|
|
name: string
|
|
owner:
|
|
entity: string
|
|
entity-id: string
|
|
project-number: string
|
|
retention-policy:
|
|
effective-time: string
|
|
is-locked: boolean
|
|
retention-period: string
|
|
rpo: string
|
|
satisfies-pzs: boolean
|
|
self-link: string
|
|
storage-class: string
|
|
time-created: string
|
|
updated: string
|
|
versioning:
|
|
enabled: boolean
|
|
website:
|
|
main-page-suffix: string
|
|
not-found-page: 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 .autoclass enabled=false</code><ul>
|
|
<li>Whether or not Autoclass is enabled on this bucket</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>toggle-time=sed</code></p>
|
|
<ul>
|
|
<li>A date and time in RFC 3339 format representing the instant at which "enabled" was last toggled.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..billing requester-pays=false</code></p>
|
|
<ul>
|
|
<li>When set to true, Requester Pays is enabled for this bucket.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..custom-placement-config data-locations=sed</code></p>
|
|
<ul>
|
|
<li>The list of regional locations in which data is placed.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. default-event-based-hold=true</code></p>
|
|
<ul>
|
|
<li>The default value for event-based hold on newly created objects in this bucket. Event-based hold is a way to retain objects indefinitely until an event occurs, signified by the hold's release. After being released, such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false. Objects under event-based hold cannot be deleted, overwritten or archived until the hold is removed.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>encryption default-kms-key-name=stet</code></p>
|
|
<ul>
|
|
<li>A Cloud KMS key that will be used to encrypt objects inserted into this bucket, if no encryption method is specified.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. etag=kasd</code></p>
|
|
<ul>
|
|
<li>HTTP 1.1 Entity tag for the bucket.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>iam-configuration.bucket-policy-only enabled=true</code><ul>
|
|
<li>If set, access is controlled only by bucket-level or above IAM policies.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>locked-time=et</code></p>
|
|
<ul>
|
|
<li>The deadline for changing iamConfiguration.bucketPolicyOnly.enabled from true to false in RFC 3339 format. iamConfiguration.bucketPolicyOnly.enabled may be changed from true to false until the locked time, after which the field is immutable.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. public-access-prevention=et</code></p>
|
|
<ul>
|
|
<li>The bucket's Public Access Prevention configuration. Currently, 'inherited' and 'enforced' are supported.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>uniform-bucket-level-access enabled=false</code><ul>
|
|
<li>If set, access is controlled only by bucket-level or above IAM policies.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>locked-time=erat</code></p>
|
|
<ul>
|
|
<li>The deadline for changing iamConfiguration.uniformBucketLevelAccess.enabled from true to false in RFC 3339 format. iamConfiguration.uniformBucketLevelAccess.enabled may be changed from true to false until the locked time, after which the field is immutable.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>... id=sed</code></p>
|
|
<ul>
|
|
<li>The ID of the bucket. For buckets, the id and name properties are the same.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>kind=duo</code><ul>
|
|
<li>The kind of item this is. For buckets, this is always storage#bucket.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>labels=key=dolore</code><ul>
|
|
<li>User-provided labels, in key/value pairs.</li>
|
|
<li>the value will be associated with the given <code>key</code></li>
|
|
</ul>
|
|
</li>
|
|
<li><code>location=et</code><ul>
|
|
<li>The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See the developer's guide for the authoritative list.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>location-type=voluptua.</code><ul>
|
|
<li>The type of the bucket location.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>logging log-bucket=amet.</code><ul>
|
|
<li>The destination bucket where the current bucket's logs should be placed.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>log-object-prefix=consetetur</code></p>
|
|
<ul>
|
|
<li>A prefix for log object names.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. metageneration=diam</code></p>
|
|
<ul>
|
|
<li>The metadata generation of this bucket.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>name=dolor</code><ul>
|
|
<li>The name of the bucket.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>owner entity=et</code><ul>
|
|
<li>The entity, in the form project-owner-projectId.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>entity-id=et</code></p>
|
|
<ul>
|
|
<li>The ID for the entity.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. project-number=sadipscing</code></p>
|
|
<ul>
|
|
<li>The project number of the project the bucket belongs to.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>retention-policy effective-time=stet</code><ul>
|
|
<li>Server-determined value that indicates the time from which policy was enforced and effective. This value is in RFC 3339 format.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>is-locked=false</code><ul>
|
|
<li>Once locked, an object retention policy cannot be modified.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>retention-period=duo</code></p>
|
|
<ul>
|
|
<li>The duration in seconds that objects need to be retained. Retention duration must be greater than zero and less than 100 years. Note that enforcement of retention periods less than a day is not guaranteed. Such periods should only be used for testing purposes.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. rpo=vero</code></p>
|
|
<ul>
|
|
<li>The Recovery Point Objective (RPO) of this bucket. Set to ASYNC_TURBO to turn on Turbo Replication on a bucket.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>satisfies-pzs=false</code><ul>
|
|
<li>Reserved for future use.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>self-link=invidunt</code><ul>
|
|
<li>The URI of this bucket.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>storage-class=stet</code><ul>
|
|
<li>The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, ARCHIVE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>time-created=vero</code><ul>
|
|
<li>The creation time of the bucket in RFC 3339 format.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>updated=elitr</code><ul>
|
|
<li>The modification time of the bucket in RFC 3339 format.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>versioning enabled=true</code></p>
|
|
<ul>
|
|
<li>While set to true, versioning is fully enabled for this bucket.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..website main-page-suffix=ipsum</code></p>
|
|
<ul>
|
|
<li>If the requested object path is missing, the service will ensure the path has a trailing '/', append this suffix, and attempt to retrieve the resulting object. This allows the creation of index.html objects to represent directory pages.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>not-found-page=accusam</code><ul>
|
|
<li>If the requested object path is missing, and any mainPageSuffix object is missing, if applicable, the service will return the named object from this bucket as the content for a 404 Not Found result.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h3 id="about-cursors">About Cursors</h3>
|
|
<p>The cursor position is key to comfortably set complex nested structures. The following rules apply:</p>
|
|
<ul>
|
|
<li>The cursor position is always set relative to the current one, unless the field name starts with the <code>.</code> character. Fields can be nested such as in <code>-r f.s.o</code> .</li>
|
|
<li>The cursor position is set relative to the top-level structure if it starts with <code>.</code>, e.g. <code>-r .s.s</code></li>
|
|
<li>You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify <code>-r struct.sub_struct=bar</code>.</li>
|
|
<li>You can move the cursor one level up by using <code>..</code>. Each additional <code>.</code> moves it up one additional level. E.g. <code>...</code> would go three levels up.</li>
|
|
</ul>
|
|
<h1 id="optional-output-flags">Optional Output Flags</h1>
|
|
<p>The method's return value a JSON encoded structure, which will be written to standard output by default.</p>
|
|
<ul>
|
|
<li><strong>-o out</strong><ul>
|
|
<li><em>out</em> specifies the <em>destination</em> to which to write the server's result to.
|
|
It will be a JSON-encoded structure.
|
|
The <em>destination</em> may be <code>-</code> to indicate standard output, or a filepath that is to contain the received bytes.
|
|
If unset, it defaults to standard output.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="optional-method-properties">Optional Method Properties</h1>
|
|
<p>You may set the following properties to further configure the call. Please note that <code>-p</code> is followed by one
|
|
or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> even though the listing below repeats the
|
|
<code>-p</code> for completeness.</p>
|
|
<ul>
|
|
<li>
|
|
<p><strong>-p predefined-acl=string</strong></p>
|
|
<ul>
|
|
<li>Apply a predefined set of access controls to this bucket.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p predefined-default-object-acl=string</strong></p>
|
|
<ul>
|
|
<li>Apply a predefined set of default object access controls to this bucket.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p projection=string</strong></p>
|
|
<ul>
|
|
<li>Set of properties to return. Defaults to noAcl, unless the bucket resource specifies acl or defaultObjectAcl properties, when it defaults to full.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p provisional-user-project=string</strong></p>
|
|
<ul>
|
|
<li>The project to be billed for this request if the target bucket is requester-pays bucket.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p user-project=string</strong></p>
|
|
<ul>
|
|
<li>The project to be billed for this request.</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 alt=string</strong></p>
|
|
<ul>
|
|
<li>Data format for the response.</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>An opaque string that represents a user for quota purposes. Must not exceed 40 characters.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p upload-type=string</strong></p>
|
|
<ul>
|
|
<li>Upload protocol for media (e.g. "media", "multipart", "resumable").</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p user-ip=string</strong></p>
|
|
<ul>
|
|
<li>Deprecated. Please use quotaUser instead.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|
|
|
<a href="../buckets_list" class="btn btn-neutral float-right" title="List"/>Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
|
|
|
|
<a href="../buckets_get-iam-policy" class="btn btn-neutral" title="Get Iam Policy"><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="../buckets_get-iam-policy" style="color: #fcfcfc;">« Previous</a></span>
|
|
<span style="margin-left: 15px"><a href="../buckets_list" style="color: #fcfcfc">Next »</a></span>
|
|
</span>
|
|
</div>
|
|
</body>
|
|
</html> |