Skip to content

Commit 667799e

Browse files
feat(storage): update the api
#### storage:v1 The following keys were added: - resources.objects.methods.get.parameters.restoreToken (Total Keys: 2) - resources.objects.methods.restore.parameters.restoreToken (Total Keys: 2) - schemas.Object.properties.restoreToken.type (Total Keys: 1) The following keys were changed: - endpoints (Total Keys: 1)
1 parent 4c728c2 commit 667799e

File tree

2 files changed

+90
-8
lines changed

2 files changed

+90
-8
lines changed

docs/dyn/storage_v1.objects.html

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -90,13 +90,13 @@ <h2>Instance Methods</h2>
9090
<code><a href="#delete">delete(bucket, object, generation=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None, userProject=None)</a></code></p>
9191
<p class="firstline">Deletes an object and its metadata. Deletions are permanent if versioning is not enabled for the bucket, or if the generation parameter is used.</p>
9292
<p class="toc_element">
93-
<code><a href="#get">get(bucket, object, generation=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None, projection=None, softDeleted=None, userProject=None)</a></code></p>
93+
<code><a href="#get">get(bucket, object, generation=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None, projection=None, restoreToken=None, softDeleted=None, userProject=None)</a></code></p>
9494
<p class="firstline">Retrieves an object or its metadata.</p>
9595
<p class="toc_element">
9696
<code><a href="#getIamPolicy">getIamPolicy(bucket, object, generation=None, userProject=None)</a></code></p>
9797
<p class="firstline">Returns an IAM policy for the specified object.</p>
9898
<p class="toc_element">
99-
<code><a href="#get_media">get_media(bucket, object, generation=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None, projection=None, softDeleted=None, userProject=None)</a></code></p>
99+
<code><a href="#get_media">get_media(bucket, object, generation=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None, projection=None, restoreToken=None, softDeleted=None, userProject=None)</a></code></p>
100100
<p class="firstline">Retrieves an object or its metadata.</p>
101101
<p class="toc_element">
102102
<code><a href="#insert">insert(bucket, body=None, contentEncoding=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None, kmsKeyName=None, media_body=None, media_mime_type=None, name=None, predefinedAcl=None, projection=None, userProject=None)</a></code></p>
@@ -111,7 +111,7 @@ <h2>Instance Methods</h2>
111111
<code><a href="#patch">patch(bucket, object, body=None, generation=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None, overrideUnlockedRetention=None, predefinedAcl=None, projection=None, userProject=None)</a></code></p>
112112
<p class="firstline">Patches an object's metadata.</p>
113113
<p class="toc_element">
114-
<code><a href="#restore">restore(bucket, object, generation, copySourceAcl=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None, projection=None, userProject=None)</a></code></p>
114+
<code><a href="#restore">restore(bucket, object, generation, copySourceAcl=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None, projection=None, restoreToken=None, userProject=None)</a></code></p>
115115
<p class="firstline">Restores a soft-deleted object.</p>
116116
<p class="toc_element">
117117
<code><a href="#rewrite">rewrite(sourceBucket, sourceObject, destinationBucket, destinationObject, body=None, destinationKmsKeyName=None, destinationPredefinedAcl=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None, ifSourceGenerationMatch=None, ifSourceGenerationNotMatch=None, ifSourceMetagenerationMatch=None, ifSourceMetagenerationNotMatch=None, maxBytesRewrittenPerCall=None, projection=None, rewriteToken=None, sourceGeneration=None, userProject=None)</a></code></p>
@@ -254,6 +254,7 @@ <h3>Method Details</h3>
254254
&quot;entity&quot;: &quot;A String&quot;, # The entity, in the form user-userId.
255255
&quot;entityId&quot;: &quot;A String&quot;, # The ID for the entity.
256256
},
257+
&quot;restoreToken&quot;: &quot;A String&quot;, # Restore token used to differentiate deleted objects with the same name and generation. This field is only returned for deleted objects in hierarchical namespace buckets.
257258
&quot;retention&quot;: { # A collection of object level retention parameters.
258259
&quot;mode&quot;: &quot;A String&quot;, # The bucket&#x27;s object retention mode, can only be Unlocked or Locked.
259260
&quot;retainUntilTime&quot;: &quot;A String&quot;, # A time in RFC 3339 format until which object retention protects this object.
@@ -360,6 +361,7 @@ <h3>Method Details</h3>
360361
&quot;entity&quot;: &quot;A String&quot;, # The entity, in the form user-userId.
361362
&quot;entityId&quot;: &quot;A String&quot;, # The ID for the entity.
362363
},
364+
&quot;restoreToken&quot;: &quot;A String&quot;, # Restore token used to differentiate deleted objects with the same name and generation. This field is only returned for deleted objects in hierarchical namespace buckets.
363365
&quot;retention&quot;: { # A collection of object level retention parameters.
364366
&quot;mode&quot;: &quot;A String&quot;, # The bucket&#x27;s object retention mode, can only be Unlocked or Locked.
365367
&quot;retainUntilTime&quot;: &quot;A String&quot;, # A time in RFC 3339 format until which object retention protects this object.
@@ -452,6 +454,7 @@ <h3>Method Details</h3>
452454
&quot;entity&quot;: &quot;A String&quot;, # The entity, in the form user-userId.
453455
&quot;entityId&quot;: &quot;A String&quot;, # The ID for the entity.
454456
},
457+
&quot;restoreToken&quot;: &quot;A String&quot;, # Restore token used to differentiate deleted objects with the same name and generation. This field is only returned for deleted objects in hierarchical namespace buckets.
455458
&quot;retention&quot;: { # A collection of object level retention parameters.
456459
&quot;mode&quot;: &quot;A String&quot;, # The bucket&#x27;s object retention mode, can only be Unlocked or Locked.
457460
&quot;retainUntilTime&quot;: &quot;A String&quot;, # A time in RFC 3339 format until which object retention protects this object.
@@ -558,6 +561,7 @@ <h3>Method Details</h3>
558561
&quot;entity&quot;: &quot;A String&quot;, # The entity, in the form user-userId.
559562
&quot;entityId&quot;: &quot;A String&quot;, # The ID for the entity.
560563
},
564+
&quot;restoreToken&quot;: &quot;A String&quot;, # Restore token used to differentiate deleted objects with the same name and generation. This field is only returned for deleted objects in hierarchical namespace buckets.
561565
&quot;retention&quot;: { # A collection of object level retention parameters.
562566
&quot;mode&quot;: &quot;A String&quot;, # The bucket&#x27;s object retention mode, can only be Unlocked or Locked.
563567
&quot;retainUntilTime&quot;: &quot;A String&quot;, # A time in RFC 3339 format until which object retention protects this object.
@@ -592,7 +596,7 @@ <h3>Method Details</h3>
592596
</div>
593597

594598
<div class="method">
595-
<code class="details" id="get">get(bucket, object, generation=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None, projection=None, softDeleted=None, userProject=None)</code>
599+
<code class="details" id="get">get(bucket, object, generation=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None, projection=None, restoreToken=None, softDeleted=None, userProject=None)</code>
596600
<pre>Retrieves an object or its metadata.
597601

598602
Args:
@@ -607,6 +611,7 @@ <h3>Method Details</h3>
607611
Allowed values
608612
full - Include all properties.
609613
noAcl - Omit the owner, acl property.
614+
restoreToken: string, Restore token used to differentiate soft-deleted objects with the same name and generation. Only applicable for hierarchical namespace buckets and if softDeleted is set to true. This parameter is optional, and is only required in the rare case when there are multiple soft-deleted objects with the same name and generation.
610615
softDeleted: boolean, If true, only soft-deleted object versions will be listed. The default is false. For more information, see [Soft Delete](https://cloud.google.com/storage/docs/soft-delete).
611616
userProject: string, The project to be billed for this request. Required for Requester Pays buckets.
612617

@@ -676,6 +681,7 @@ <h3>Method Details</h3>
676681
&quot;entity&quot;: &quot;A String&quot;, # The entity, in the form user-userId.
677682
&quot;entityId&quot;: &quot;A String&quot;, # The ID for the entity.
678683
},
684+
&quot;restoreToken&quot;: &quot;A String&quot;, # Restore token used to differentiate deleted objects with the same name and generation. This field is only returned for deleted objects in hierarchical namespace buckets.
679685
&quot;retention&quot;: { # A collection of object level retention parameters.
680686
&quot;mode&quot;: &quot;A String&quot;, # The bucket&#x27;s object retention mode, can only be Unlocked or Locked.
681687
&quot;retainUntilTime&quot;: &quot;A String&quot;, # A time in RFC 3339 format until which object retention protects this object.
@@ -748,7 +754,7 @@ <h3>Method Details</h3>
748754
</div>
749755

750756
<div class="method">
751-
<code class="details" id="get_media">get_media(bucket, object, generation=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None, projection=None, softDeleted=None, userProject=None)</code>
757+
<code class="details" id="get_media">get_media(bucket, object, generation=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None, projection=None, restoreToken=None, softDeleted=None, userProject=None)</code>
752758
<pre>Retrieves an object or its metadata.
753759

754760
Args:
@@ -763,6 +769,7 @@ <h3>Method Details</h3>
763769
Allowed values
764770
full - Include all properties.
765771
noAcl - Omit the owner, acl property.
772+
restoreToken: string, Restore token used to differentiate soft-deleted objects with the same name and generation. Only applicable for hierarchical namespace buckets and if softDeleted is set to true. This parameter is optional, and is only required in the rare case when there are multiple soft-deleted objects with the same name and generation.
766773
softDeleted: boolean, If true, only soft-deleted object versions will be listed. The default is false. For more information, see [Soft Delete](https://cloud.google.com/storage/docs/soft-delete).
767774
userProject: string, The project to be billed for this request. Required for Requester Pays buckets.
768775

@@ -844,6 +851,7 @@ <h3>Method Details</h3>
844851
&quot;entity&quot;: &quot;A String&quot;, # The entity, in the form user-userId.
845852
&quot;entityId&quot;: &quot;A String&quot;, # The ID for the entity.
846853
},
854+
&quot;restoreToken&quot;: &quot;A String&quot;, # Restore token used to differentiate deleted objects with the same name and generation. This field is only returned for deleted objects in hierarchical namespace buckets.
847855
&quot;retention&quot;: { # A collection of object level retention parameters.
848856
&quot;mode&quot;: &quot;A String&quot;, # The bucket&#x27;s object retention mode, can only be Unlocked or Locked.
849857
&quot;retainUntilTime&quot;: &quot;A String&quot;, # A time in RFC 3339 format until which object retention protects this object.
@@ -949,6 +957,7 @@ <h3>Method Details</h3>
949957
&quot;entity&quot;: &quot;A String&quot;, # The entity, in the form user-userId.
950958
&quot;entityId&quot;: &quot;A String&quot;, # The ID for the entity.
951959
},
960+
&quot;restoreToken&quot;: &quot;A String&quot;, # Restore token used to differentiate deleted objects with the same name and generation. This field is only returned for deleted objects in hierarchical namespace buckets.
952961
&quot;retention&quot;: { # A collection of object level retention parameters.
953962
&quot;mode&quot;: &quot;A String&quot;, # The bucket&#x27;s object retention mode, can only be Unlocked or Locked.
954963
&quot;retainUntilTime&quot;: &quot;A String&quot;, # A time in RFC 3339 format until which object retention protects this object.
@@ -1057,6 +1066,7 @@ <h3>Method Details</h3>
10571066
&quot;entity&quot;: &quot;A String&quot;, # The entity, in the form user-userId.
10581067
&quot;entityId&quot;: &quot;A String&quot;, # The ID for the entity.
10591068
},
1069+
&quot;restoreToken&quot;: &quot;A String&quot;, # Restore token used to differentiate deleted objects with the same name and generation. This field is only returned for deleted objects in hierarchical namespace buckets.
10601070
&quot;retention&quot;: { # A collection of object level retention parameters.
10611071
&quot;mode&quot;: &quot;A String&quot;, # The bucket&#x27;s object retention mode, can only be Unlocked or Locked.
10621072
&quot;retainUntilTime&quot;: &quot;A String&quot;, # A time in RFC 3339 format until which object retention protects this object.
@@ -1168,6 +1178,7 @@ <h3>Method Details</h3>
11681178
&quot;entity&quot;: &quot;A String&quot;, # The entity, in the form user-userId.
11691179
&quot;entityId&quot;: &quot;A String&quot;, # The ID for the entity.
11701180
},
1181+
&quot;restoreToken&quot;: &quot;A String&quot;, # Restore token used to differentiate deleted objects with the same name and generation. This field is only returned for deleted objects in hierarchical namespace buckets.
11711182
&quot;retention&quot;: { # A collection of object level retention parameters.
11721183
&quot;mode&quot;: &quot;A String&quot;, # The bucket&#x27;s object retention mode, can only be Unlocked or Locked.
11731184
&quot;retainUntilTime&quot;: &quot;A String&quot;, # A time in RFC 3339 format until which object retention protects this object.
@@ -1270,6 +1281,7 @@ <h3>Method Details</h3>
12701281
&quot;entity&quot;: &quot;A String&quot;, # The entity, in the form user-userId.
12711282
&quot;entityId&quot;: &quot;A String&quot;, # The ID for the entity.
12721283
},
1284+
&quot;restoreToken&quot;: &quot;A String&quot;, # Restore token used to differentiate deleted objects with the same name and generation. This field is only returned for deleted objects in hierarchical namespace buckets.
12731285
&quot;retention&quot;: { # A collection of object level retention parameters.
12741286
&quot;mode&quot;: &quot;A String&quot;, # The bucket&#x27;s object retention mode, can only be Unlocked or Locked.
12751287
&quot;retainUntilTime&quot;: &quot;A String&quot;, # A time in RFC 3339 format until which object retention protects this object.
@@ -1288,7 +1300,7 @@ <h3>Method Details</h3>
12881300
</div>
12891301

12901302
<div class="method">
1291-
<code class="details" id="restore">restore(bucket, object, generation, copySourceAcl=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None, projection=None, userProject=None)</code>
1303+
<code class="details" id="restore">restore(bucket, object, generation, copySourceAcl=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None, projection=None, restoreToken=None, userProject=None)</code>
12921304
<pre>Restores a soft-deleted object.
12931305

12941306
Args:
@@ -1304,6 +1316,7 @@ <h3>Method Details</h3>
13041316
Allowed values
13051317
full - Include all properties.
13061318
noAcl - Omit the owner, acl property.
1319+
restoreToken: string, Restore token used to differentiate sof-deleted objects with the same name and generation. Only applicable for hierarchical namespace buckets. This parameter is optional, and is only required in the rare case when there are multiple soft-deleted objects with the same name and generation.
13071320
userProject: string, The project to be billed for this request. Required for Requester Pays buckets.
13081321

13091322
Returns:
@@ -1372,6 +1385,7 @@ <h3>Method Details</h3>
13721385
&quot;entity&quot;: &quot;A String&quot;, # The entity, in the form user-userId.
13731386
&quot;entityId&quot;: &quot;A String&quot;, # The ID for the entity.
13741387
},
1388+
&quot;restoreToken&quot;: &quot;A String&quot;, # Restore token used to differentiate deleted objects with the same name and generation. This field is only returned for deleted objects in hierarchical namespace buckets.
13751389
&quot;retention&quot;: { # A collection of object level retention parameters.
13761390
&quot;mode&quot;: &quot;A String&quot;, # The bucket&#x27;s object retention mode, can only be Unlocked or Locked.
13771391
&quot;retainUntilTime&quot;: &quot;A String&quot;, # A time in RFC 3339 format until which object retention protects this object.
@@ -1464,6 +1478,7 @@ <h3>Method Details</h3>
14641478
&quot;entity&quot;: &quot;A String&quot;, # The entity, in the form user-userId.
14651479
&quot;entityId&quot;: &quot;A String&quot;, # The ID for the entity.
14661480
},
1481+
&quot;restoreToken&quot;: &quot;A String&quot;, # Restore token used to differentiate deleted objects with the same name and generation. This field is only returned for deleted objects in hierarchical namespace buckets.
14671482
&quot;retention&quot;: { # A collection of object level retention parameters.
14681483
&quot;mode&quot;: &quot;A String&quot;, # The bucket&#x27;s object retention mode, can only be Unlocked or Locked.
14691484
&quot;retainUntilTime&quot;: &quot;A String&quot;, # A time in RFC 3339 format until which object retention protects this object.
@@ -1576,6 +1591,7 @@ <h3>Method Details</h3>
15761591
&quot;entity&quot;: &quot;A String&quot;, # The entity, in the form user-userId.
15771592
&quot;entityId&quot;: &quot;A String&quot;, # The ID for the entity.
15781593
},
1594+
&quot;restoreToken&quot;: &quot;A String&quot;, # Restore token used to differentiate deleted objects with the same name and generation. This field is only returned for deleted objects in hierarchical namespace buckets.
15791595
&quot;retention&quot;: { # A collection of object level retention parameters.
15801596
&quot;mode&quot;: &quot;A String&quot;, # The bucket&#x27;s object retention mode, can only be Unlocked or Locked.
15811597
&quot;retainUntilTime&quot;: &quot;A String&quot;, # A time in RFC 3339 format until which object retention protects this object.
@@ -1808,6 +1824,7 @@ <h3>Method Details</h3>
18081824
&quot;entity&quot;: &quot;A String&quot;, # The entity, in the form user-userId.
18091825
&quot;entityId&quot;: &quot;A String&quot;, # The ID for the entity.
18101826
},
1827+
&quot;restoreToken&quot;: &quot;A String&quot;, # Restore token used to differentiate deleted objects with the same name and generation. This field is only returned for deleted objects in hierarchical namespace buckets.
18111828
&quot;retention&quot;: { # A collection of object level retention parameters.
18121829
&quot;mode&quot;: &quot;A String&quot;, # The bucket&#x27;s object retention mode, can only be Unlocked or Locked.
18131830
&quot;retainUntilTime&quot;: &quot;A String&quot;, # A time in RFC 3339 format until which object retention protects this object.
@@ -1910,6 +1927,7 @@ <h3>Method Details</h3>
19101927
&quot;entity&quot;: &quot;A String&quot;, # The entity, in the form user-userId.
19111928
&quot;entityId&quot;: &quot;A String&quot;, # The ID for the entity.
19121929
},
1930+
&quot;restoreToken&quot;: &quot;A String&quot;, # Restore token used to differentiate deleted objects with the same name and generation. This field is only returned for deleted objects in hierarchical namespace buckets.
19131931
&quot;retention&quot;: { # A collection of object level retention parameters.
19141932
&quot;mode&quot;: &quot;A String&quot;, # The bucket&#x27;s object retention mode, can only be Unlocked or Locked.
19151933
&quot;retainUntilTime&quot;: &quot;A String&quot;, # A time in RFC 3339 format until which object retention protects this object.

0 commit comments

Comments
 (0)