OLD | NEW |
1 // This is a generated file (see the discoveryapis_generator project). | 1 // This is a generated file (see the discoveryapis_generator project). |
2 | 2 |
3 library googleapis.servicecontrol.v1; | 3 library googleapis.servicecontrol.v1; |
4 | 4 |
5 import 'dart:core' as core; | 5 import 'dart:core' as core; |
6 import 'dart:async' as async; | 6 import 'dart:async' as async; |
7 import 'dart:convert' as convert; | 7 import 'dart:convert' as convert; |
8 | 8 |
9 import 'package:_discoveryapis_commons/_discoveryapis_commons.dart' as commons; | 9 import 'package:_discoveryapis_commons/_discoveryapis_commons.dart' as commons; |
10 import 'package:http/http.dart' as http; | 10 import 'package:http/http.dart' as http; |
(...skipping 28 matching lines...) Expand all Loading... |
39 final commons.ApiRequester _requester; | 39 final commons.ApiRequester _requester; |
40 | 40 |
41 ServicesResourceApi(commons.ApiRequester client) : | 41 ServicesResourceApi(commons.ApiRequester client) : |
42 _requester = client; | 42 _requester = client; |
43 | 43 |
44 /** | 44 /** |
45 * Checks an operation with Google Service Control to decide whether | 45 * Checks an operation with Google Service Control to decide whether |
46 * the given operation should proceed. It should be called before the | 46 * the given operation should proceed. It should be called before the |
47 * operation is executed. | 47 * operation is executed. |
48 * | 48 * |
| 49 * If feasible, the client should cache the check results and reuse them for |
| 50 * up to 60s. In case of server errors, the client may rely on the cached |
| 51 * results for longer time. |
| 52 * |
49 * This method requires the `servicemanagement.services.check` permission | 53 * This method requires the `servicemanagement.services.check` permission |
50 * on the specified service. For more information, see | 54 * on the specified service. For more information, see |
51 * [Google Cloud IAM](https://cloud.google.com/iam). | 55 * [Google Cloud IAM](https://cloud.google.com/iam). |
52 * | 56 * |
53 * [request] - The metadata request object. | 57 * [request] - The metadata request object. |
54 * | 58 * |
55 * Request parameters: | 59 * Request parameters: |
56 * | 60 * |
57 * [serviceName] - The service name as specified in its service configuration. | 61 * [serviceName] - The service name as specified in its service configuration. |
58 * For example, | 62 * For example, |
(...skipping 33 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
92 uploadOptions: _uploadOptions, | 96 uploadOptions: _uploadOptions, |
93 uploadMedia: _uploadMedia, | 97 uploadMedia: _uploadMedia, |
94 downloadOptions: _downloadOptions); | 98 downloadOptions: _downloadOptions); |
95 return _response.then((data) => new CheckResponse.fromJson(data)); | 99 return _response.then((data) => new CheckResponse.fromJson(data)); |
96 } | 100 } |
97 | 101 |
98 /** | 102 /** |
99 * Reports operations to Google Service Control. It should be called | 103 * Reports operations to Google Service Control. It should be called |
100 * after the operation is completed. | 104 * after the operation is completed. |
101 * | 105 * |
| 106 * If feasible, the client should aggregate reporting data for up to 5s to |
| 107 * reduce API traffic. Limiting aggregation to 5s is to reduce data loss |
| 108 * during client crashes. Clients should carefully choose the aggregation |
| 109 * window to avoid data loss risk more than 0.01% for business and |
| 110 * compliance reasons. |
| 111 * |
102 * This method requires the `servicemanagement.services.report` permission | 112 * This method requires the `servicemanagement.services.report` permission |
103 * on the specified service. For more information, see | 113 * on the specified service. For more information, see |
104 * [Google Cloud IAM](https://cloud.google.com/iam). | 114 * [Google Cloud IAM](https://cloud.google.com/iam). |
105 * | 115 * |
106 * [request] - The metadata request object. | 116 * [request] - The metadata request object. |
107 * | 117 * |
108 * Request parameters: | 118 * Request parameters: |
109 * | 119 * |
110 * [serviceName] - The service name as specified in its service configuration. | 120 * [serviceName] - The service name as specified in its service configuration. |
111 * For example, | 121 * For example, |
(...skipping 107 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
219 _json["detail"] = detail; | 229 _json["detail"] = detail; |
220 } | 230 } |
221 return _json; | 231 return _json; |
222 } | 232 } |
223 } | 233 } |
224 | 234 |
225 /** Request message for the Check method. */ | 235 /** Request message for the Check method. */ |
226 class CheckRequest { | 236 class CheckRequest { |
227 /** The operation to be checked. */ | 237 /** The operation to be checked. */ |
228 Operation operation; | 238 Operation operation; |
| 239 /** |
| 240 * Specifies which version of service configuration should be used to process |
| 241 * the request. |
| 242 * |
| 243 * If unspecified or no matching version can be found, the |
| 244 * latest one will be used. |
| 245 */ |
| 246 core.String serviceConfigId; |
229 | 247 |
230 CheckRequest(); | 248 CheckRequest(); |
231 | 249 |
232 CheckRequest.fromJson(core.Map _json) { | 250 CheckRequest.fromJson(core.Map _json) { |
233 if (_json.containsKey("operation")) { | 251 if (_json.containsKey("operation")) { |
234 operation = new Operation.fromJson(_json["operation"]); | 252 operation = new Operation.fromJson(_json["operation"]); |
235 } | 253 } |
| 254 if (_json.containsKey("serviceConfigId")) { |
| 255 serviceConfigId = _json["serviceConfigId"]; |
| 256 } |
236 } | 257 } |
237 | 258 |
238 core.Map toJson() { | 259 core.Map toJson() { |
239 var _json = new core.Map(); | 260 var _json = new core.Map(); |
240 if (operation != null) { | 261 if (operation != null) { |
241 _json["operation"] = (operation).toJson(); | 262 _json["operation"] = (operation).toJson(); |
242 } | 263 } |
| 264 if (serviceConfigId != null) { |
| 265 _json["serviceConfigId"] = serviceConfigId; |
| 266 } |
243 return _json; | 267 return _json; |
244 } | 268 } |
245 } | 269 } |
246 | 270 |
247 /** Response message for the Check method. */ | 271 /** Response message for the Check method. */ |
248 class CheckResponse { | 272 class CheckResponse { |
249 /** | 273 /** |
250 * Indicate the decision of the check. | 274 * Indicate the decision of the check. |
251 * | 275 * |
252 * If no check errors are present, the service should process the operation. | 276 * If no check errors are present, the service should process the operation. |
(...skipping 317 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
570 * values that belong to a set of approved types. | 594 * values that belong to a set of approved types. |
571 * | 595 * |
572 * The values for Object must be JSON objects. It can consist of `num`, | 596 * The values for Object must be JSON objects. It can consist of `num`, |
573 * `String`, `bool` and `null` as well as `Map` and `List` values. | 597 * `String`, `bool` and `null` as well as `Map` and `List` values. |
574 */ | 598 */ |
575 core.Map<core.String, core.Object> protoPayload; | 599 core.Map<core.String, core.Object> protoPayload; |
576 /** | 600 /** |
577 * The severity of the log entry. The default value is | 601 * The severity of the log entry. The default value is |
578 * `LogSeverity.DEFAULT`. | 602 * `LogSeverity.DEFAULT`. |
579 * Possible string values are: | 603 * Possible string values are: |
580 * - "DEFAULT" : The log entry has no assigned severity level. | 604 * - "DEFAULT" : (0) The log entry has no assigned severity level. |
581 * - "DEBUG" : Debug or trace information. | 605 * - "DEBUG" : (100) Debug or trace information. |
582 * - "INFO" : Routine information, such as ongoing status or performance. | 606 * - "INFO" : (200) Routine information, such as ongoing status or |
583 * - "NOTICE" : Normal but significant events, such as start up, shut down, or | 607 * performance. |
584 * configuration. | 608 * - "NOTICE" : (300) Normal but significant events, such as start up, shut |
585 * - "WARNING" : Warning events might cause problems. | 609 * down, or |
586 * - "ERROR" : Error events are likely to cause problems. | 610 * a configuration change. |
587 * - "CRITICAL" : Critical events cause more severe problems or brief outages. | 611 * - "WARNING" : (400) Warning events might cause problems. |
588 * - "ALERT" : A person must take an action immediately. | 612 * - "ERROR" : (500) Error events are likely to cause problems. |
589 * - "EMERGENCY" : One or more systems are unusable. | 613 * - "CRITICAL" : (600) Critical events cause more severe problems or outages. |
| 614 * - "ALERT" : (700) A person must take an action immediately. |
| 615 * - "EMERGENCY" : (800) One or more systems are unusable. |
590 */ | 616 */ |
591 core.String severity; | 617 core.String severity; |
592 /** | 618 /** |
593 * The log entry payload, represented as a structure that | 619 * The log entry payload, represented as a structure that |
594 * is expressed as a JSON object. | 620 * is expressed as a JSON object. |
595 * | 621 * |
596 * The values for Object must be JSON objects. It can consist of `num`, | 622 * The values for Object must be JSON objects. It can consist of `num`, |
597 * `String`, `bool` and `null` as well as `Map` and `List` values. | 623 * `String`, `bool` and `null` as well as `Map` and `List` values. |
598 */ | 624 */ |
599 core.Map<core.String, core.Object> structPayload; | 625 core.Map<core.String, core.Object> structPayload; |
(...skipping 371 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
971 * Typically the service should report one operation per request. | 997 * Typically the service should report one operation per request. |
972 * Putting multiple operations into a single request is allowed, but should | 998 * Putting multiple operations into a single request is allowed, but should |
973 * be used only when multiple operations are natually available at the time | 999 * be used only when multiple operations are natually available at the time |
974 * of the report. | 1000 * of the report. |
975 * | 1001 * |
976 * If multiple operations are in a single request, the total request size | 1002 * If multiple operations are in a single request, the total request size |
977 * should be no larger than 1MB. See ReportResponse.report_errors for | 1003 * should be no larger than 1MB. See ReportResponse.report_errors for |
978 * partial failure behavior. | 1004 * partial failure behavior. |
979 */ | 1005 */ |
980 core.List<Operation> operations; | 1006 core.List<Operation> operations; |
| 1007 /** |
| 1008 * Specifies which version of service config should be used to process the |
| 1009 * request. |
| 1010 * |
| 1011 * If unspecified or no matching version can be found, the |
| 1012 * latest one will be used. |
| 1013 */ |
| 1014 core.String serviceConfigId; |
981 | 1015 |
982 ReportRequest(); | 1016 ReportRequest(); |
983 | 1017 |
984 ReportRequest.fromJson(core.Map _json) { | 1018 ReportRequest.fromJson(core.Map _json) { |
985 if (_json.containsKey("operations")) { | 1019 if (_json.containsKey("operations")) { |
986 operations = _json["operations"].map((value) => new Operation.fromJson(val
ue)).toList(); | 1020 operations = _json["operations"].map((value) => new Operation.fromJson(val
ue)).toList(); |
987 } | 1021 } |
| 1022 if (_json.containsKey("serviceConfigId")) { |
| 1023 serviceConfigId = _json["serviceConfigId"]; |
| 1024 } |
988 } | 1025 } |
989 | 1026 |
990 core.Map toJson() { | 1027 core.Map toJson() { |
991 var _json = new core.Map(); | 1028 var _json = new core.Map(); |
992 if (operations != null) { | 1029 if (operations != null) { |
993 _json["operations"] = operations.map((value) => (value).toJson()).toList()
; | 1030 _json["operations"] = operations.map((value) => (value).toJson()).toList()
; |
994 } | 1031 } |
| 1032 if (serviceConfigId != null) { |
| 1033 _json["serviceConfigId"] = serviceConfigId; |
| 1034 } |
995 return _json; | 1035 return _json; |
996 } | 1036 } |
997 } | 1037 } |
998 | 1038 |
999 /** Response message for the Report method. */ | 1039 /** Response message for the Report method. */ |
1000 class ReportResponse { | 1040 class ReportResponse { |
1001 /** | 1041 /** |
1002 * Partial failures, one for each `Operation` in the request that failed | 1042 * Partial failures, one for each `Operation` in the request that failed |
1003 * processing. There are three possible combinations of the RPC status: | 1043 * processing. There are three possible combinations of the RPC status: |
1004 * | 1044 * |
1005 * 1. The combination of a successful RPC status and an empty `report_errors` | 1045 * 1. The combination of a successful RPC status and an empty `report_errors` |
1006 * list indicates a complete success where all `Operations` in the | 1046 * list indicates a complete success where all `Operations` in the |
1007 * request are processed successfully. | 1047 * request are processed successfully. |
1008 * 2. The combination of a successful RPC status and a non-empty | 1048 * 2. The combination of a successful RPC status and a non-empty |
1009 * `report_errors` list indicates a partial success where some | 1049 * `report_errors` list indicates a partial success where some |
1010 * `Operations` in the request succeeded. Each | 1050 * `Operations` in the request succeeded. Each |
1011 * `Operation` that failed processing has a corresponding item | 1051 * `Operation` that failed processing has a corresponding item |
1012 * in this list. | 1052 * in this list. |
1013 * 3. A failed RPC status indicates a complete failure where none of the | 1053 * 3. A failed RPC status indicates a general non-deterministic failure. |
1014 * `Operations` in the request succeeded. | 1054 * When this happens, it's impossible to know which of the |
| 1055 * 'Operations' in the request succeeded or failed. |
1015 */ | 1056 */ |
1016 core.List<ReportError> reportErrors; | 1057 core.List<ReportError> reportErrors; |
1017 /** The actual config id used to process the request. */ | 1058 /** The actual config id used to process the request. */ |
1018 core.String serviceConfigId; | 1059 core.String serviceConfigId; |
1019 | 1060 |
1020 ReportResponse(); | 1061 ReportResponse(); |
1021 | 1062 |
1022 ReportResponse.fromJson(core.Map _json) { | 1063 ReportResponse.fromJson(core.Map _json) { |
1023 if (_json.containsKey("reportErrors")) { | 1064 if (_json.containsKey("reportErrors")) { |
1024 reportErrors = _json["reportErrors"].map((value) => new ReportError.fromJs
on(value)).toList(); | 1065 reportErrors = _json["reportErrors"].map((value) => new ReportError.fromJs
on(value)).toList(); |
(...skipping 110 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1135 } | 1176 } |
1136 if (details != null) { | 1177 if (details != null) { |
1137 _json["details"] = details; | 1178 _json["details"] = details; |
1138 } | 1179 } |
1139 if (message != null) { | 1180 if (message != null) { |
1140 _json["message"] = message; | 1181 _json["message"] = message; |
1141 } | 1182 } |
1142 return _json; | 1183 return _json; |
1143 } | 1184 } |
1144 } | 1185 } |
OLD | NEW |