1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="storage_v1.html">Cloud Storage JSON API</a> . <a href="storage_v1.folders.html">folders</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#delete">delete(bucket, folder, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None)</a></code></p>
<p class="firstline">Permanently deletes a folder. Only applicable to buckets with hierarchical namespace enabled.</p>
<p class="toc_element">
<code><a href="#get">get(bucket, folder, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None)</a></code></p>
<p class="firstline">Returns metadata for the specified folder. Only applicable to buckets with hierarchical namespace enabled.</p>
<p class="toc_element">
<code><a href="#insert">insert(bucket, body=None, recursive=None)</a></code></p>
<p class="firstline">Creates a new folder. Only applicable to buckets with hierarchical namespace enabled.</p>
<p class="toc_element">
<code><a href="#list">list(bucket, delimiter=None, endOffset=None, pageSize=None, pageToken=None, prefix=None, startOffset=None)</a></code></p>
<p class="firstline">Retrieves a list of folders matching the criteria. Only applicable to buckets with hierarchical namespace enabled.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#rename">rename(bucket, sourceFolder, destinationFolder, ifSourceMetagenerationMatch=None, ifSourceMetagenerationNotMatch=None)</a></code></p>
<p class="firstline">Renames a source folder to a destination folder. Only applicable to buckets with hierarchical namespace enabled.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(bucket, folder, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None)</code>
<pre>Permanently deletes a folder. Only applicable to buckets with hierarchical namespace enabled.
Args:
bucket: string, Name of the bucket in which the folder resides. (required)
folder: string, Name of a folder. (required)
ifMetagenerationMatch: string, If set, only deletes the folder if its metageneration matches this value.
ifMetagenerationNotMatch: string, If set, only deletes the folder if its metageneration does not match this value.
</pre>
</div>
<div class="method">
<code class="details" id="get">get(bucket, folder, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None)</code>
<pre>Returns metadata for the specified folder. Only applicable to buckets with hierarchical namespace enabled.
Args:
bucket: string, Name of the bucket in which the folder resides. (required)
folder: string, Name of a folder. (required)
ifMetagenerationMatch: string, Makes the return of the folder metadata conditional on whether the folder's current metageneration matches the given value.
ifMetagenerationNotMatch: string, Makes the return of the folder metadata conditional on whether the folder's current metageneration does not match the given value.
Returns:
An object of the form:
{ # A folder. Only available in buckets with hierarchical namespace enabled.
"bucket": "A String", # The name of the bucket containing this folder.
"createTime": "A String", # The creation time of the folder in RFC 3339 format.
"id": "A String", # The ID of the folder, including the bucket name, folder name.
"kind": "storage#folder", # The kind of item this is. For folders, this is always storage#folder.
"metageneration": "A String", # The version of the metadata for this folder. Used for preconditions and for detecting changes in metadata.
"name": "A String", # The name of the folder. Required if not specified by URL parameter.
"pendingRenameInfo": { # Only present if the folder is part of an ongoing rename folder operation. Contains information which can be used to query the operation status.
"operationId": "A String", # The ID of the rename folder operation.
},
"selfLink": "A String", # The link to this folder.
"updateTime": "A String", # The modification time of the folder metadata in RFC 3339 format.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(bucket, body=None, recursive=None)</code>
<pre>Creates a new folder. Only applicable to buckets with hierarchical namespace enabled.
Args:
bucket: string, Name of the bucket in which the folder resides. (required)
body: object, The request body.
The object takes the form of:
{ # A folder. Only available in buckets with hierarchical namespace enabled.
"bucket": "A String", # The name of the bucket containing this folder.
"createTime": "A String", # The creation time of the folder in RFC 3339 format.
"id": "A String", # The ID of the folder, including the bucket name, folder name.
"kind": "storage#folder", # The kind of item this is. For folders, this is always storage#folder.
"metageneration": "A String", # The version of the metadata for this folder. Used for preconditions and for detecting changes in metadata.
"name": "A String", # The name of the folder. Required if not specified by URL parameter.
"pendingRenameInfo": { # Only present if the folder is part of an ongoing rename folder operation. Contains information which can be used to query the operation status.
"operationId": "A String", # The ID of the rename folder operation.
},
"selfLink": "A String", # The link to this folder.
"updateTime": "A String", # The modification time of the folder metadata in RFC 3339 format.
}
recursive: boolean, If true, any parent folder which doesn't exist will be created automatically.
Returns:
An object of the form:
{ # A folder. Only available in buckets with hierarchical namespace enabled.
"bucket": "A String", # The name of the bucket containing this folder.
"createTime": "A String", # The creation time of the folder in RFC 3339 format.
"id": "A String", # The ID of the folder, including the bucket name, folder name.
"kind": "storage#folder", # The kind of item this is. For folders, this is always storage#folder.
"metageneration": "A String", # The version of the metadata for this folder. Used for preconditions and for detecting changes in metadata.
"name": "A String", # The name of the folder. Required if not specified by URL parameter.
"pendingRenameInfo": { # Only present if the folder is part of an ongoing rename folder operation. Contains information which can be used to query the operation status.
"operationId": "A String", # The ID of the rename folder operation.
},
"selfLink": "A String", # The link to this folder.
"updateTime": "A String", # The modification time of the folder metadata in RFC 3339 format.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(bucket, delimiter=None, endOffset=None, pageSize=None, pageToken=None, prefix=None, startOffset=None)</code>
<pre>Retrieves a list of folders matching the criteria. Only applicable to buckets with hierarchical namespace enabled.
Args:
bucket: string, Name of the bucket in which to look for folders. (required)
delimiter: string, Returns results in a directory-like mode. The only supported value is '/'. If set, items will only contain folders that either exactly match the prefix, or are one level below the prefix.
endOffset: string, Filter results to folders whose names are lexicographically before endOffset. If startOffset is also set, the folders listed will have names between startOffset (inclusive) and endOffset (exclusive).
pageSize: integer, Maximum number of items to return in a single page of responses.
pageToken: string, A previously-returned page token representing part of the larger set of results to view.
prefix: string, Filter results to folders whose paths begin with this prefix. If set, the value must either be an empty string or end with a '/'.
startOffset: string, Filter results to folders whose names are lexicographically equal to or after startOffset. If endOffset is also set, the folders listed will have names between startOffset (inclusive) and endOffset (exclusive).
Returns:
An object of the form:
{ # A list of folders.
"items": [ # The list of items.
{ # A folder. Only available in buckets with hierarchical namespace enabled.
"bucket": "A String", # The name of the bucket containing this folder.
"createTime": "A String", # The creation time of the folder in RFC 3339 format.
"id": "A String", # The ID of the folder, including the bucket name, folder name.
"kind": "storage#folder", # The kind of item this is. For folders, this is always storage#folder.
"metageneration": "A String", # The version of the metadata for this folder. Used for preconditions and for detecting changes in metadata.
"name": "A String", # The name of the folder. Required if not specified by URL parameter.
"pendingRenameInfo": { # Only present if the folder is part of an ongoing rename folder operation. Contains information which can be used to query the operation status.
"operationId": "A String", # The ID of the rename folder operation.
},
"selfLink": "A String", # The link to this folder.
"updateTime": "A String", # The modification time of the folder metadata in RFC 3339 format.
},
],
"kind": "storage#folders", # The kind of item this is. For lists of folders, this is always storage#folders.
"nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="rename">rename(bucket, sourceFolder, destinationFolder, ifSourceMetagenerationMatch=None, ifSourceMetagenerationNotMatch=None)</code>
<pre>Renames a source folder to a destination folder. Only applicable to buckets with hierarchical namespace enabled.
Args:
bucket: string, Name of the bucket in which the folders are in. (required)
sourceFolder: string, Name of the source folder. (required)
destinationFolder: string, Name of the destination folder. (required)
ifSourceMetagenerationMatch: string, Makes the operation conditional on whether the source object's current metageneration matches the given value.
ifSourceMetagenerationNotMatch: string, Makes the operation conditional on whether the source object's current metageneration does not match the given value.
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is "false", it means the operation is still in progress. If "true", the operation is completed, and either "error" or "response" is available.
"error": { # The "Status" type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each "Status" message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English.
},
"kind": "storage#operation", # The kind of item this is. For operations, this is always storage#operation.
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the "name" should be a resource name ending with "operations/{operationId}".
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as "Delete", the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type "XxxResponse", where "Xxx" is the original method name. For example, if the original method name is "TakeSnapshot()", the inferred response type is "TakeSnapshotResponse".
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"selfLink": "A String", # The link to this long running operation.
}</pre>
</div>
</body></html>
|
