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
276
277
278
279
280
281
282
283
284
285
286
|
<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="drivelabels_v2.html">Drive Labels API</a> . <a href="drivelabels_v2.labels.html">labels</a> . <a href="drivelabels_v2.labels.permissions.html">permissions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#batchDelete">batchDelete(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes label permissions. Permissions affect the label resource as a whole, aren't revisioned, and don't require publishing.</p>
<p class="toc_element">
<code><a href="#batchUpdate">batchUpdate(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates label permissions. If a permission for the indicated principal doesn't exist, a label permission is created, otherwise the existing permission is updated. Permissions affect the label resource as a whole, aren't revisioned, and don't require publishing.</p>
<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="#create">create(parent, body=None, useAdminAccess=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a label's permissions. If a permission for the indicated principal doesn't exist, a label permission is created, otherwise the existing permission is updated. Permissions affect the label resource as a whole, aren't revisioned, and don't require publishing.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, useAdminAccess=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a label's permission. Permissions affect the label resource as a whole, aren't revisioned, and don't require publishing.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, useAdminAccess=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists a label's permissions.</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>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="batchDelete">batchDelete(parent, body=None, x__xgafv=None)</code>
<pre>Deletes label permissions. Permissions affect the label resource as a whole, aren't revisioned, and don't require publishing.
Args:
parent: string, Required. The parent label resource name shared by all permissions being deleted. Format: `labels/{label}`. If this is set, the parent field in the `UpdateLabelPermissionRequest` messages must either be empty or match this field. (required)
body: object, The request body.
The object takes the form of:
{ # Deletes one or more label permissions.
"requests": [ # Required. The request message specifying the resources to update.
{ # Deletes a label permission. Permissions affect the label resource as a whole, aren't revisioned, and don't require publishing.
"name": "A String", # Required. Label permission resource name.
"useAdminAccess": True or False, # Set to `true` in order to use the user's admin credentials. The server will verify the user is an admin for the label before allowing access.
},
],
"useAdminAccess": True or False, # Set to `true` in order to use the user's admin credentials. The server will verify the user is an admin for the label before allowing access. If this is set, the `use_admin_access` field in the `DeleteLabelPermissionRequest` messages must either be empty or match this field.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
<div class="method">
<code class="details" id="batchUpdate">batchUpdate(parent, body=None, x__xgafv=None)</code>
<pre>Updates label permissions. If a permission for the indicated principal doesn't exist, a label permission is created, otherwise the existing permission is updated. Permissions affect the label resource as a whole, aren't revisioned, and don't require publishing.
Args:
parent: string, Required. The parent label resource name shared by all permissions being updated. Format: `labels/{label}`. If this is set, the parent field in the `UpdateLabelPermissionRequest` messages must either be empty or match this field. (required)
body: object, The request body.
The object takes the form of:
{ # Updates one or more label permissions.
"requests": [ # Required. The request message specifying the resources to update.
{ # Updates a label permission. Permissions affect the label resource as a whole, aren't revisioned, and don't require publishing.
"labelPermission": { # The permission that applies to a principal (user, group, audience) on a label. # Required. The permission to create or update on the label.
"audience": "A String", # Audience to grant a role to. The magic value of `audiences/default` may be used to apply the role to the default audience in the context of the organization that owns the label.
"email": "A String", # Specifies the email address for a user or group principal. Not populated for audience principals. User and group permissions may only be inserted using an email address. On update requests, if email address is specified, no principal should be specified.
"group": "A String", # Group resource name.
"name": "A String", # Resource name of this permission.
"person": "A String", # Person resource name.
"role": "A String", # The role the principal should have.
},
"parent": "A String", # Required. The parent label resource name.
"useAdminAccess": True or False, # Set to `true` in order to use the user's admin credentials. The server will verify the user is an admin for the label before allowing access.
},
],
"useAdminAccess": True or False, # Set to `true` in order to use the user's admin credentials. The server will verify the user is an admin for the label before allowing access. If this is set, the `use_admin_access` field in the `UpdateLabelPermissionRequest` messages must either be empty or match this field.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for updating one or more label permissions.
"permissions": [ # Required. Permissions updated.
{ # The permission that applies to a principal (user, group, audience) on a label.
"audience": "A String", # Audience to grant a role to. The magic value of `audiences/default` may be used to apply the role to the default audience in the context of the organization that owns the label.
"email": "A String", # Specifies the email address for a user or group principal. Not populated for audience principals. User and group permissions may only be inserted using an email address. On update requests, if email address is specified, no principal should be specified.
"group": "A String", # Group resource name.
"name": "A String", # Resource name of this permission.
"person": "A String", # Person resource name.
"role": "A String", # The role the principal should have.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, useAdminAccess=None, x__xgafv=None)</code>
<pre>Updates a label's permissions. If a permission for the indicated principal doesn't exist, a label permission is created, otherwise the existing permission is updated. Permissions affect the label resource as a whole, aren't revisioned, and don't require publishing.
Args:
parent: string, Required. The parent label resource name on the label permission is created. Format: `labels/{label}`. (required)
body: object, The request body.
The object takes the form of:
{ # The permission that applies to a principal (user, group, audience) on a label.
"audience": "A String", # Audience to grant a role to. The magic value of `audiences/default` may be used to apply the role to the default audience in the context of the organization that owns the label.
"email": "A String", # Specifies the email address for a user or group principal. Not populated for audience principals. User and group permissions may only be inserted using an email address. On update requests, if email address is specified, no principal should be specified.
"group": "A String", # Group resource name.
"name": "A String", # Resource name of this permission.
"person": "A String", # Person resource name.
"role": "A String", # The role the principal should have.
}
useAdminAccess: boolean, Set to `true` in order to use the user's admin credentials. The server will verify the user is an admin for the label before allowing access.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The permission that applies to a principal (user, group, audience) on a label.
"audience": "A String", # Audience to grant a role to. The magic value of `audiences/default` may be used to apply the role to the default audience in the context of the organization that owns the label.
"email": "A String", # Specifies the email address for a user or group principal. Not populated for audience principals. User and group permissions may only be inserted using an email address. On update requests, if email address is specified, no principal should be specified.
"group": "A String", # Group resource name.
"name": "A String", # Resource name of this permission.
"person": "A String", # Person resource name.
"role": "A String", # The role the principal should have.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, useAdminAccess=None, x__xgafv=None)</code>
<pre>Deletes a label's permission. Permissions affect the label resource as a whole, aren't revisioned, and don't require publishing.
Args:
name: string, Required. Label permission resource name. (required)
useAdminAccess: boolean, Set to `true` in order to use the user's admin credentials. The server will verify the user is an admin for the label before allowing access.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, useAdminAccess=None, x__xgafv=None)</code>
<pre>Lists a label's permissions.
Args:
parent: string, Required. The parent label resource name on which label permissions are listed. Format: `labels/{label}`. (required)
pageSize: integer, Maximum number of permissions to return per page. Default: 50. Max: 200.
pageToken: string, The token of the page to return.
useAdminAccess: boolean, Set to `true` in order to use the user's admin credentials. The server will verify the user is an admin for the label before allowing access.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for listing the permissions on a label.
"labelPermissions": [ # Label permissions.
{ # The permission that applies to a principal (user, group, audience) on a label.
"audience": "A String", # Audience to grant a role to. The magic value of `audiences/default` may be used to apply the role to the default audience in the context of the organization that owns the label.
"email": "A String", # Specifies the email address for a user or group principal. Not populated for audience principals. User and group permissions may only be inserted using an email address. On update requests, if email address is specified, no principal should be specified.
"group": "A String", # Group resource name.
"name": "A String", # Resource name of this permission.
"person": "A String", # Person resource name.
"role": "A String", # The role the principal should have.
},
],
"nextPageToken": "A String", # The token of the next page in the response.
}</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>
</body></html>
|
