/
chromepolicy_v1.customers.policySchemas.html
415 lines (388 loc) 路 29.3 KB
/
chromepolicy_v1.customers.policySchemas.html
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
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
<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="chromepolicy_v1.html">Chrome Policy API</a> . <a href="chromepolicy_v1.customers.html">customers</a> . <a href="chromepolicy_v1.customers.policySchemas.html">policySchemas</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="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Get a specific policy schema for a customer by its resource name.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a list of policy schemas that match a specified filter value for a given customer.</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="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Get a specific policy schema for a customer by its resource name.
Args:
name: string, Required. The policy schema resource name to query. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Resource representing a policy schema.
"accessRestrictions": [ # Output only. Specific access restrictions related to this policy.
"A String",
],
"additionalTargetKeyNames": [ # Output only. Additional key names that will be used to identify the target of the policy value. When specifying a `policyTargetKey`, each of the additional keys specified here will have to be included in the `additionalTargetKeys` map.
{ # Additional key names that will be used to identify the target of the policy value.
"key": "A String", # Key name.
"keyDescription": "A String", # Key description.
},
],
"categoryTitle": "A String", # Title of the category in which a setting belongs.
"definition": { # Describes a complete .proto file. # Schema definition using proto descriptor.
"enumType": [
{ # Describes an enum type.
"name": "A String",
"value": [
{ # Describes a value within an enum.
"name": "A String",
"number": 42,
},
],
},
],
"messageType": [ # All top-level definitions in this file.
{ # Describes a message type.
"enumType": [
{ # Describes an enum type.
"name": "A String",
"value": [
{ # Describes a value within an enum.
"name": "A String",
"number": 42,
},
],
},
],
"field": [
{ # Describes a field within a message.
"defaultValue": "A String", # For numeric types, contains the original text representation of the value. For booleans, "true" or "false". For strings, contains the default text contents (not escaped in any way). For bytes, contains the C escaped value. All bytes >= 128 are escaped.
"jsonName": "A String", # JSON name of this field. The value is set by protocol compiler. If the user has set a "json_name" option on this field, that option's value will be used. Otherwise, it's deduced from the field's name by converting it to camelCase.
"label": "A String",
"name": "A String",
"number": 42,
"oneofIndex": 42, # If set, gives the index of a oneof in the containing type's oneof_decl list. This field is a member of that oneof.
"proto3Optional": True or False, # If true, this is a proto3 "optional". When a proto3 field is optional, it tracks presence regardless of field type. When proto3_optional is true, this field must be belong to a oneof to signal to old proto3 clients that presence is tracked for this field. This oneof is known as a "synthetic" oneof, and this field must be its sole member (each proto3 optional field gets its own synthetic oneof). Synthetic oneofs exist in the descriptor only, and do not generate any API. Synthetic oneofs must be ordered after all "real" oneofs. For message fields, proto3_optional doesn't create any semantic change, since non-repeated message fields always track presence. However it still indicates the semantic detail of whether the user wrote "optional" or not. This can be useful for round-tripping the .proto file. For consistency we give message fields a synthetic oneof also, even though it is not required to track presence. This is especially important because the parser can't tell if a field is a message or an enum, so it must always create a synthetic oneof. Proto2 optional fields do not set this flag, because they already indicate optional with `LABEL_OPTIONAL`.
"type": "A String", # If type_name is set, this need not be set. If both this and type_name are set, this must be one of TYPE_ENUM, TYPE_MESSAGE or TYPE_GROUP.
"typeName": "A String", # For message and enum types, this is the name of the type. If the name starts with a '.', it is fully-qualified. Otherwise, C++-like scoping rules are used to find the type (i.e. first the nested types within this message are searched, then within the parent, on up to the root namespace).
},
],
"name": "A String",
"nestedType": [
# Object with schema name: Proto2DescriptorProto
],
"oneofDecl": [
{ # Describes a oneof.
"name": "A String",
},
],
},
],
"name": "A String", # file name, relative to root of source tree
"package": "A String", # e.g. "foo", "foo.bar", etc.
"syntax": "A String", # The syntax of the proto file. The supported values are "proto2", "proto3", and "editions". If `edition` is present, this value must be "editions".
},
"fieldDescriptions": [ # Output only. Detailed description of each field that is part of the schema.
{ # Provides detailed information for a particular field that is part of a PolicySchema.
"defaultValue": "", # Output only. Client default if the policy is unset.
"description": "A String", # Deprecated. Use name and field_description instead. The description for the field.
"field": "A String", # Output only. The name of the field for associated with this description.
"fieldDependencies": [ # Output only. Provides a list of fields and values. At least one of the fields must have the corresponding value in order for this field to be allowed to be set.
{ # The field and the value it must have for another field to be allowed to be set.
"sourceField": "A String", # The source field which this field depends on.
"sourceFieldValue": "A String", # The value which the source field must have for this field to be allowed to be set.
},
],
"fieldDescription": "A String", # Output only. The description of the field.
"inputConstraint": "A String", # Output only. Any input constraints associated on the values for the field.
"knownValueDescriptions": [ # Output only. If the field has a set of known values, this field will provide a description for these values.
{ # Provides detailed information about a known value that is allowed for a particular field in a PolicySchema.
"description": "A String", # Output only. Additional description for this value.
"value": "A String", # Output only. The string represenstation of the value that can be set for the field.
},
],
"name": "A String", # Output only. The name of the field.
"nestedFieldDescriptions": [ # Output only. Provides the description of the fields nested in this field, if the field is a message type that defines multiple fields.
# Object with schema name: GoogleChromePolicyVersionsV1PolicySchemaFieldDescription
],
"requiredItems": [ # Output only. Provides a list of fields that are required to be set if this field has a certain value.
{ # The fields that will become required based on the value of this field.
"fieldConditions": [ # The value(s) of the field that provoke required field enforcement. An empty field_conditions implies that any value assigned to this field will provoke required field enforcement.
"A String",
],
"requiredFields": [ # The fields that are required as a consequence of the field conditions.
"A String",
],
},
],
},
],
"name": "A String", # Format: name=customers/{customer}/policySchemas/{schema_namespace}
"notices": [ # Output only. Special notice messages related to setting certain values in certain fields in the schema.
{ # Provides special notice messages related to a particular value in a field that is part of a PolicySchema.
"acknowledgementRequired": True or False, # Output only. Whether the user needs to acknowledge the notice message before the value can be set.
"field": "A String", # Output only. The field name associated with the notice.
"noticeMessage": "A String", # Output only. The notice message associate with the value of the field.
"noticeValue": "A String", # Output only. The value of the field that has a notice. When setting the field to this value, the user may be required to acknowledge the notice message in order for the value to be set.
},
],
"policyApiLifecycle": { # Output only. Current lifecycle information.
"description": "A String", # Description about current life cycle.
"endSupport": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # End supporting date for current policy.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
"policyApiLifecycleStage": "A String", # Indicate current life cycle stage of the policy API.
},
"policyApiLifeycle": { # Deprecated field because of typo.
"description": "A String", # Description about current life cycle.
"endSupport": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # End supporting date for current policy.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
"policyApiLifecycleStage": "A String", # Indicate current life cycle stage of the policy API.
},
"policyDescription": "A String", # Output only. Description about the policy schema for user consumption.
"schemaName": "A String", # Output only. The fully qualified name of the policy schema. This value is used to fill the field `policy_schema` in PolicyValue when calling BatchInheritOrgUnitPolicies BatchModifyOrgUnitPolicies BatchModifyGroupPolicies or BatchDeleteGroupPolicies.
"supportUri": "A String", # Output only. URI to related support article for this schema.
"validTargetResources": [ # Output only. Information about applicable target resources for the policy.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Gets a list of policy schemas that match a specified filter value for a given customer.
Args:
parent: string, Required. The customer for which the listing request will apply. (required)
filter: string, The schema filter used to find a particular schema based on fields like its resource name, description and `additionalTargetKeyNames`.
pageSize: integer, The maximum number of policy schemas to return, defaults to 100 and has a maximum of 1000.
pageToken: string, The page token used to retrieve a specific page of the listing request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for listing policy schemas that match a filter.
"nextPageToken": "A String", # The page token used to get the next page of policy schemas.
"policySchemas": [ # The list of policy schemas that match the query.
{ # Resource representing a policy schema.
"accessRestrictions": [ # Output only. Specific access restrictions related to this policy.
"A String",
],
"additionalTargetKeyNames": [ # Output only. Additional key names that will be used to identify the target of the policy value. When specifying a `policyTargetKey`, each of the additional keys specified here will have to be included in the `additionalTargetKeys` map.
{ # Additional key names that will be used to identify the target of the policy value.
"key": "A String", # Key name.
"keyDescription": "A String", # Key description.
},
],
"categoryTitle": "A String", # Title of the category in which a setting belongs.
"definition": { # Describes a complete .proto file. # Schema definition using proto descriptor.
"enumType": [
{ # Describes an enum type.
"name": "A String",
"value": [
{ # Describes a value within an enum.
"name": "A String",
"number": 42,
},
],
},
],
"messageType": [ # All top-level definitions in this file.
{ # Describes a message type.
"enumType": [
{ # Describes an enum type.
"name": "A String",
"value": [
{ # Describes a value within an enum.
"name": "A String",
"number": 42,
},
],
},
],
"field": [
{ # Describes a field within a message.
"defaultValue": "A String", # For numeric types, contains the original text representation of the value. For booleans, "true" or "false". For strings, contains the default text contents (not escaped in any way). For bytes, contains the C escaped value. All bytes >= 128 are escaped.
"jsonName": "A String", # JSON name of this field. The value is set by protocol compiler. If the user has set a "json_name" option on this field, that option's value will be used. Otherwise, it's deduced from the field's name by converting it to camelCase.
"label": "A String",
"name": "A String",
"number": 42,
"oneofIndex": 42, # If set, gives the index of a oneof in the containing type's oneof_decl list. This field is a member of that oneof.
"proto3Optional": True or False, # If true, this is a proto3 "optional". When a proto3 field is optional, it tracks presence regardless of field type. When proto3_optional is true, this field must be belong to a oneof to signal to old proto3 clients that presence is tracked for this field. This oneof is known as a "synthetic" oneof, and this field must be its sole member (each proto3 optional field gets its own synthetic oneof). Synthetic oneofs exist in the descriptor only, and do not generate any API. Synthetic oneofs must be ordered after all "real" oneofs. For message fields, proto3_optional doesn't create any semantic change, since non-repeated message fields always track presence. However it still indicates the semantic detail of whether the user wrote "optional" or not. This can be useful for round-tripping the .proto file. For consistency we give message fields a synthetic oneof also, even though it is not required to track presence. This is especially important because the parser can't tell if a field is a message or an enum, so it must always create a synthetic oneof. Proto2 optional fields do not set this flag, because they already indicate optional with `LABEL_OPTIONAL`.
"type": "A String", # If type_name is set, this need not be set. If both this and type_name are set, this must be one of TYPE_ENUM, TYPE_MESSAGE or TYPE_GROUP.
"typeName": "A String", # For message and enum types, this is the name of the type. If the name starts with a '.', it is fully-qualified. Otherwise, C++-like scoping rules are used to find the type (i.e. first the nested types within this message are searched, then within the parent, on up to the root namespace).
},
],
"name": "A String",
"nestedType": [
# Object with schema name: Proto2DescriptorProto
],
"oneofDecl": [
{ # Describes a oneof.
"name": "A String",
},
],
},
],
"name": "A String", # file name, relative to root of source tree
"package": "A String", # e.g. "foo", "foo.bar", etc.
"syntax": "A String", # The syntax of the proto file. The supported values are "proto2", "proto3", and "editions". If `edition` is present, this value must be "editions".
},
"fieldDescriptions": [ # Output only. Detailed description of each field that is part of the schema.
{ # Provides detailed information for a particular field that is part of a PolicySchema.
"defaultValue": "", # Output only. Client default if the policy is unset.
"description": "A String", # Deprecated. Use name and field_description instead. The description for the field.
"field": "A String", # Output only. The name of the field for associated with this description.
"fieldDependencies": [ # Output only. Provides a list of fields and values. At least one of the fields must have the corresponding value in order for this field to be allowed to be set.
{ # The field and the value it must have for another field to be allowed to be set.
"sourceField": "A String", # The source field which this field depends on.
"sourceFieldValue": "A String", # The value which the source field must have for this field to be allowed to be set.
},
],
"fieldDescription": "A String", # Output only. The description of the field.
"inputConstraint": "A String", # Output only. Any input constraints associated on the values for the field.
"knownValueDescriptions": [ # Output only. If the field has a set of known values, this field will provide a description for these values.
{ # Provides detailed information about a known value that is allowed for a particular field in a PolicySchema.
"description": "A String", # Output only. Additional description for this value.
"value": "A String", # Output only. The string represenstation of the value that can be set for the field.
},
],
"name": "A String", # Output only. The name of the field.
"nestedFieldDescriptions": [ # Output only. Provides the description of the fields nested in this field, if the field is a message type that defines multiple fields.
# Object with schema name: GoogleChromePolicyVersionsV1PolicySchemaFieldDescription
],
"requiredItems": [ # Output only. Provides a list of fields that are required to be set if this field has a certain value.
{ # The fields that will become required based on the value of this field.
"fieldConditions": [ # The value(s) of the field that provoke required field enforcement. An empty field_conditions implies that any value assigned to this field will provoke required field enforcement.
"A String",
],
"requiredFields": [ # The fields that are required as a consequence of the field conditions.
"A String",
],
},
],
},
],
"name": "A String", # Format: name=customers/{customer}/policySchemas/{schema_namespace}
"notices": [ # Output only. Special notice messages related to setting certain values in certain fields in the schema.
{ # Provides special notice messages related to a particular value in a field that is part of a PolicySchema.
"acknowledgementRequired": True or False, # Output only. Whether the user needs to acknowledge the notice message before the value can be set.
"field": "A String", # Output only. The field name associated with the notice.
"noticeMessage": "A String", # Output only. The notice message associate with the value of the field.
"noticeValue": "A String", # Output only. The value of the field that has a notice. When setting the field to this value, the user may be required to acknowledge the notice message in order for the value to be set.
},
],
"policyApiLifecycle": { # Output only. Current lifecycle information.
"description": "A String", # Description about current life cycle.
"endSupport": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # End supporting date for current policy.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
"policyApiLifecycleStage": "A String", # Indicate current life cycle stage of the policy API.
},
"policyApiLifeycle": { # Deprecated field because of typo.
"description": "A String", # Description about current life cycle.
"endSupport": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # End supporting date for current policy.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
"policyApiLifecycleStage": "A String", # Indicate current life cycle stage of the policy API.
},
"policyDescription": "A String", # Output only. Description about the policy schema for user consumption.
"schemaName": "A String", # Output only. The fully qualified name of the policy schema. This value is used to fill the field `policy_schema` in PolicyValue when calling BatchInheritOrgUnitPolicies BatchModifyOrgUnitPolicies BatchModifyGroupPolicies or BatchDeleteGroupPolicies.
"supportUri": "A String", # Output only. URI to related support article for this schema.
"validTargetResources": [ # Output only. Information about applicable target resources for the policy.
"A String",
],
},
],
}</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>