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
|
<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="workloadmanager_v1.html">Workload Manager API</a> . <a href="workloadmanager_v1.projects.html">projects</a> . <a href="workloadmanager_v1.projects.locations.html">locations</a> . <a href="workloadmanager_v1.projects.locations.evaluations.html">evaluations</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="workloadmanager_v1.projects.locations.evaluations.executions.html">executions()</a></code>
</p>
<p class="firstline">Returns the executions Resource.</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, evaluationId=None, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new Evaluation in a given project and location.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, force=None, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a single Evaluation.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets details of a single Evaluation.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists Evaluations in a given project and location.</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="create">create(parent, body=None, evaluationId=None, requestId=None, x__xgafv=None)</code>
<pre>Creates a new Evaluation in a given project and location.
Args:
parent: string, Required. The resource prefix of the evaluation location using the form: `projects/{project_id}/locations/{location_id}` (required)
body: object, The request body.
The object takes the form of:
{ # Message describing Evaluation object
"bigQueryDestination": { # Message describing big query destination # Optional. BigQuery destination
"createNewResultsTable": True or False, # Optional. determine if results will be saved in a new table
"destinationDataset": "A String", # Optional. destination dataset to save evaluation results
},
"createTime": "A String", # Output only. [Output only] Create time stamp
"customRulesBucket": "A String", # The Cloud Storage bucket name for custom rules.
"description": "A String", # Description of the Evaluation
"evaluationType": "A String", # Evaluation type
"kmsKey": "A String", # Optional. Immutable. Customer-managed encryption key name, in the format projects/*/locations/*/keyRings/*/cryptoKeys/*.
"labels": { # Labels as key value pairs
"a_key": "A String",
},
"name": "A String", # name of resource names have the form 'projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}'
"resourceFilter": { # Message describing resource filters # annotations as key value pairs
"gceInstanceFilter": { # Message describing compute engine instance filter # Filter compute engine resource
"serviceAccounts": [ # Service account of compute engine
"A String",
],
},
"inclusionLabels": { # The label used for filter resource
"a_key": "A String",
},
"resourceIdPatterns": [ # The id pattern for filter resource
"A String",
],
"scopes": [ # The scopes of evaluation resource
"A String",
],
},
"resourceStatus": { # Message describing resource status # Output only. [Output only] The updated rule ids if exist.
"rulesNewerVersions": [ # Historical: Used before 2023-05-22 the new version of rule id if exists
"A String",
],
"state": "A String", # State of the resource
},
"ruleNames": [ # the name of the rule
"A String",
],
"ruleVersions": [ # Output only. [Output only] The updated rule ids if exist.
"A String",
],
"schedule": "A String", # crontab format schedule for scheduled evaluation, currently only support the following schedule: "0 */1 * * *", "0 */6 * * *", "0 */12 * * *", "0 0 */1 * *", "0 0 */7 * *",
"updateTime": "A String", # Output only. [Output only] Update time stamp
}
evaluationId: string, Required. Id of the requesting object
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
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. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"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/{unique_id}`.
"response": { # The normal, successful response of the operation. 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.
},
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, force=None, requestId=None, x__xgafv=None)</code>
<pre>Deletes a single Evaluation.
Args:
name: string, Required. Name of the resource (required)
force: boolean, Optional. Followed the best practice from https://aip.dev/135#cascading-delete
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
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. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"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/{unique_id}`.
"response": { # The normal, successful response of the operation. 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.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets details of a single Evaluation.
Args:
name: string, Required. Name of the resource (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Message describing Evaluation object
"bigQueryDestination": { # Message describing big query destination # Optional. BigQuery destination
"createNewResultsTable": True or False, # Optional. determine if results will be saved in a new table
"destinationDataset": "A String", # Optional. destination dataset to save evaluation results
},
"createTime": "A String", # Output only. [Output only] Create time stamp
"customRulesBucket": "A String", # The Cloud Storage bucket name for custom rules.
"description": "A String", # Description of the Evaluation
"evaluationType": "A String", # Evaluation type
"kmsKey": "A String", # Optional. Immutable. Customer-managed encryption key name, in the format projects/*/locations/*/keyRings/*/cryptoKeys/*.
"labels": { # Labels as key value pairs
"a_key": "A String",
},
"name": "A String", # name of resource names have the form 'projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}'
"resourceFilter": { # Message describing resource filters # annotations as key value pairs
"gceInstanceFilter": { # Message describing compute engine instance filter # Filter compute engine resource
"serviceAccounts": [ # Service account of compute engine
"A String",
],
},
"inclusionLabels": { # The label used for filter resource
"a_key": "A String",
},
"resourceIdPatterns": [ # The id pattern for filter resource
"A String",
],
"scopes": [ # The scopes of evaluation resource
"A String",
],
},
"resourceStatus": { # Message describing resource status # Output only. [Output only] The updated rule ids if exist.
"rulesNewerVersions": [ # Historical: Used before 2023-05-22 the new version of rule id if exists
"A String",
],
"state": "A String", # State of the resource
},
"ruleNames": [ # the name of the rule
"A String",
],
"ruleVersions": [ # Output only. [Output only] The updated rule ids if exist.
"A String",
],
"schedule": "A String", # crontab format schedule for scheduled evaluation, currently only support the following schedule: "0 */1 * * *", "0 */6 * * *", "0 */12 * * *", "0 0 */1 * *", "0 0 */7 * *",
"updateTime": "A String", # Output only. [Output only] Update time stamp
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists Evaluations in a given project and location.
Args:
parent: string, Required. Parent value for ListEvaluationsRequest (required)
filter: string, Filter to be applied when listing the evaluation results.
orderBy: string, Hint for how to order the results
pageSize: integer, Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
pageToken: string, A token identifying a page of results the server should return.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Message for response to listing Evaluations
"evaluations": [ # The list of Evaluation
{ # Message describing Evaluation object
"bigQueryDestination": { # Message describing big query destination # Optional. BigQuery destination
"createNewResultsTable": True or False, # Optional. determine if results will be saved in a new table
"destinationDataset": "A String", # Optional. destination dataset to save evaluation results
},
"createTime": "A String", # Output only. [Output only] Create time stamp
"customRulesBucket": "A String", # The Cloud Storage bucket name for custom rules.
"description": "A String", # Description of the Evaluation
"evaluationType": "A String", # Evaluation type
"kmsKey": "A String", # Optional. Immutable. Customer-managed encryption key name, in the format projects/*/locations/*/keyRings/*/cryptoKeys/*.
"labels": { # Labels as key value pairs
"a_key": "A String",
},
"name": "A String", # name of resource names have the form 'projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}'
"resourceFilter": { # Message describing resource filters # annotations as key value pairs
"gceInstanceFilter": { # Message describing compute engine instance filter # Filter compute engine resource
"serviceAccounts": [ # Service account of compute engine
"A String",
],
},
"inclusionLabels": { # The label used for filter resource
"a_key": "A String",
},
"resourceIdPatterns": [ # The id pattern for filter resource
"A String",
],
"scopes": [ # The scopes of evaluation resource
"A String",
],
},
"resourceStatus": { # Message describing resource status # Output only. [Output only] The updated rule ids if exist.
"rulesNewerVersions": [ # Historical: Used before 2023-05-22 the new version of rule id if exists
"A String",
],
"state": "A String", # State of the resource
},
"ruleNames": [ # the name of the rule
"A String",
],
"ruleVersions": [ # Output only. [Output only] The updated rule ids if exist.
"A String",
],
"schedule": "A String", # crontab format schedule for scheduled evaluation, currently only support the following schedule: "0 */1 * * *", "0 */6 * * *", "0 */12 * * *", "0 0 */1 * *", "0 0 */7 * *",
"updateTime": "A String", # Output only. [Output only] Update time stamp
},
],
"nextPageToken": "A String", # A token identifying a page of results the server should return.
"unreachable": [ # Locations that could not be reached.
"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>
|
