@ondewo/csi-client-angular 2.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (200) hide show
  1. package/LICENSE +191 -0
  2. package/README.md +27 -0
  3. package/api/google/api/annotations.pb.d.ts +1 -0
  4. package/api/google/api/http.pb.d.ts +275 -0
  5. package/api/google/rpc/status.pb.d.ts +82 -0
  6. package/api/google/type/latlng.pb.d.ts +76 -0
  7. package/api/ondewo/csi/conversation.pb.d.ts +1312 -0
  8. package/api/ondewo/csi/conversation.pbconf.d.ts +6 -0
  9. package/api/ondewo/csi/conversation.pbsc.d.ts +167 -0
  10. package/api/ondewo/nlu/agent.pb.d.ts +3536 -0
  11. package/api/ondewo/nlu/agent.pbconf.d.ts +6 -0
  12. package/api/ondewo/nlu/agent.pbsc.d.ts +472 -0
  13. package/api/ondewo/nlu/aiservices.pb.d.ts +2472 -0
  14. package/api/ondewo/nlu/aiservices.pbconf.d.ts +6 -0
  15. package/api/ondewo/nlu/aiservices.pbsc.d.ts +150 -0
  16. package/api/ondewo/nlu/common.pb.d.ts +75 -0
  17. package/api/ondewo/nlu/context.pb.d.ts +756 -0
  18. package/api/ondewo/nlu/context.pbconf.d.ts +6 -0
  19. package/api/ondewo/nlu/context.pbsc.d.ts +119 -0
  20. package/api/ondewo/nlu/entity-type.pb.d.ts +2014 -0
  21. package/api/ondewo/nlu/entity-type.pbconf.d.ts +6 -0
  22. package/api/ondewo/nlu/entity-type.pbsc.d.ts +216 -0
  23. package/api/ondewo/nlu/intent.pb.d.ts +6236 -0
  24. package/api/ondewo/nlu/intent.pbconf.d.ts +6 -0
  25. package/api/ondewo/nlu/intent.pbsc.d.ts +456 -0
  26. package/api/ondewo/nlu/operation-metadata.pb.d.ts +166 -0
  27. package/api/ondewo/nlu/operations.pb.d.ts +578 -0
  28. package/api/ondewo/nlu/operations.pbconf.d.ts +6 -0
  29. package/api/ondewo/nlu/operations.pbsc.d.ts +87 -0
  30. package/api/ondewo/nlu/project-role.pb.d.ts +576 -0
  31. package/api/ondewo/nlu/project-role.pbconf.d.ts +6 -0
  32. package/api/ondewo/nlu/project-role.pbsc.d.ts +103 -0
  33. package/api/ondewo/nlu/project-statistics.pb.d.ts +295 -0
  34. package/api/ondewo/nlu/project-statistics.pbconf.d.ts +6 -0
  35. package/api/ondewo/nlu/project-statistics.pbsc.d.ts +151 -0
  36. package/api/ondewo/nlu/server-statistics.pb.d.ts +71 -0
  37. package/api/ondewo/nlu/server-statistics.pbconf.d.ts +6 -0
  38. package/api/ondewo/nlu/server-statistics.pbsc.d.ts +72 -0
  39. package/api/ondewo/nlu/session.pb.d.ts +2892 -0
  40. package/api/ondewo/nlu/session.pbconf.d.ts +6 -0
  41. package/api/ondewo/nlu/session.pbsc.d.ts +247 -0
  42. package/api/ondewo/nlu/user.pb.d.ts +1577 -0
  43. package/api/ondewo/nlu/user.pbconf.d.ts +6 -0
  44. package/api/ondewo/nlu/user.pbsc.d.ts +263 -0
  45. package/api/ondewo/nlu/utility.pb.d.ts +1814 -0
  46. package/api/ondewo/nlu/utility.pbconf.d.ts +6 -0
  47. package/api/ondewo/nlu/utility.pbsc.d.ts +150 -0
  48. package/api/ondewo/nlu/webhook.pb.d.ts +401 -0
  49. package/api/ondewo/nlu/webhook.pbconf.d.ts +6 -0
  50. package/api/ondewo/nlu/webhook.pbsc.d.ts +70 -0
  51. package/api/ondewo/s2t/speech-to-text.pb.d.ts +3710 -0
  52. package/api/ondewo/s2t/speech-to-text.pbconf.d.ts +6 -0
  53. package/api/ondewo/s2t/speech-to-text.pbsc.d.ts +263 -0
  54. package/api/ondewo/t2s/text-to-speech.pb.d.ts +3302 -0
  55. package/api/ondewo/t2s/text-to-speech.pbconf.d.ts +11 -0
  56. package/api/ondewo/t2s/text-to-speech.pbsc.d.ts +296 -0
  57. package/esm2020/api/google/api/annotations.pb.mjs +2 -0
  58. package/esm2020/api/google/api/http.pb.mjs +524 -0
  59. package/esm2020/api/google/rpc/status.pb.mjs +138 -0
  60. package/esm2020/api/google/type/latlng.pb.mjs +119 -0
  61. package/esm2020/api/ondewo/csi/conversation.pb.mjs +2232 -0
  62. package/esm2020/api/ondewo/csi/conversation.pbconf.mjs +13 -0
  63. package/esm2020/api/ondewo/csi/conversation.pbsc.mjs +315 -0
  64. package/esm2020/api/ondewo/nlu/agent.pb.mjs +6077 -0
  65. package/esm2020/api/ondewo/nlu/agent.pbconf.mjs +13 -0
  66. package/esm2020/api/ondewo/nlu/agent.pbsc.mjs +886 -0
  67. package/esm2020/api/ondewo/nlu/aiservices.pb.mjs +4371 -0
  68. package/esm2020/api/ondewo/nlu/aiservices.pbconf.mjs +13 -0
  69. package/esm2020/api/ondewo/nlu/aiservices.pbsc.mjs +284 -0
  70. package/esm2020/api/ondewo/nlu/common.pb.mjs +108 -0
  71. package/esm2020/api/ondewo/nlu/context.pb.mjs +1233 -0
  72. package/esm2020/api/ondewo/nlu/context.pbconf.mjs +13 -0
  73. package/esm2020/api/ondewo/nlu/context.pbsc.mjs +225 -0
  74. package/esm2020/api/ondewo/nlu/entity-type.pb.mjs +3466 -0
  75. package/esm2020/api/ondewo/nlu/entity-type.pbconf.mjs +13 -0
  76. package/esm2020/api/ondewo/nlu/entity-type.pbsc.mjs +406 -0
  77. package/esm2020/api/ondewo/nlu/intent.pb.mjs +10809 -0
  78. package/esm2020/api/ondewo/nlu/intent.pbconf.mjs +13 -0
  79. package/esm2020/api/ondewo/nlu/intent.pbsc.mjs +856 -0
  80. package/esm2020/api/ondewo/nlu/operation-metadata.pb.mjs +382 -0
  81. package/esm2020/api/ondewo/nlu/operations.pb.mjs +1003 -0
  82. package/esm2020/api/ondewo/nlu/operations.pbconf.mjs +13 -0
  83. package/esm2020/api/ondewo/nlu/operations.pbsc.mjs +165 -0
  84. package/esm2020/api/ondewo/nlu/project-role.pb.mjs +988 -0
  85. package/esm2020/api/ondewo/nlu/project-role.pbconf.mjs +13 -0
  86. package/esm2020/api/ondewo/nlu/project-role.pbsc.mjs +195 -0
  87. package/esm2020/api/ondewo/nlu/project-statistics.pb.mjs +460 -0
  88. package/esm2020/api/ondewo/nlu/project-statistics.pbconf.mjs +13 -0
  89. package/esm2020/api/ondewo/nlu/project-statistics.pbsc.mjs +285 -0
  90. package/esm2020/api/ondewo/nlu/server-statistics.pb.mjs +103 -0
  91. package/esm2020/api/ondewo/nlu/server-statistics.pbconf.mjs +13 -0
  92. package/esm2020/api/ondewo/nlu/server-statistics.pbsc.mjs +136 -0
  93. package/esm2020/api/ondewo/nlu/session.pb.mjs +5351 -0
  94. package/esm2020/api/ondewo/nlu/session.pbconf.mjs +13 -0
  95. package/esm2020/api/ondewo/nlu/session.pbsc.mjs +465 -0
  96. package/esm2020/api/ondewo/nlu/user.pb.mjs +2536 -0
  97. package/esm2020/api/ondewo/nlu/user.pbconf.mjs +13 -0
  98. package/esm2020/api/ondewo/nlu/user.pbsc.mjs +495 -0
  99. package/esm2020/api/ondewo/nlu/utility.pb.mjs +3302 -0
  100. package/esm2020/api/ondewo/nlu/utility.pbconf.mjs +13 -0
  101. package/esm2020/api/ondewo/nlu/utility.pbsc.mjs +284 -0
  102. package/esm2020/api/ondewo/nlu/webhook.pb.mjs +705 -0
  103. package/esm2020/api/ondewo/nlu/webhook.pbconf.mjs +13 -0
  104. package/esm2020/api/ondewo/nlu/webhook.pbsc.mjs +134 -0
  105. package/esm2020/api/ondewo/s2t/speech-to-text.pb.mjs +6452 -0
  106. package/esm2020/api/ondewo/s2t/speech-to-text.pbconf.mjs +13 -0
  107. package/esm2020/api/ondewo/s2t/speech-to-text.pbsc.mjs +495 -0
  108. package/esm2020/api/ondewo/t2s/text-to-speech.pb.mjs +5779 -0
  109. package/esm2020/api/ondewo/t2s/text-to-speech.pbconf.mjs +18 -0
  110. package/esm2020/api/ondewo/t2s/text-to-speech.pbsc.mjs +555 -0
  111. package/esm2020/ondewo-csi-client-angular.mjs +5 -0
  112. package/esm2020/public-api.mjs +55 -0
  113. package/fesm2015/ondewo-csi-client-angular.mjs +62142 -0
  114. package/fesm2015/ondewo-csi-client-angular.mjs.map +1 -0
  115. package/fesm2020/ondewo-csi-client-angular.mjs +62135 -0
  116. package/fesm2020/ondewo-csi-client-angular.mjs.map +1 -0
  117. package/index.d.ts +5 -0
  118. package/ondewo-csi-api/README.md +91 -0
  119. package/ondewo-csi-api/google/ads/googleads/README.md +21 -0
  120. package/ondewo-csi-api/google/api/README.md +5 -0
  121. package/ondewo-csi-api/google/api/servicecontrol/README.md +126 -0
  122. package/ondewo-csi-api/google/api/servicemanagement/README.md +102 -0
  123. package/ondewo-csi-api/google/appengine/README.md +12 -0
  124. package/ondewo-csi-api/google/assistant/embedded/README.md +3 -0
  125. package/ondewo-csi-api/google/cloud/functions/README.md +2 -0
  126. package/ondewo-csi-api/google/cloud/language/README.md +0 -0
  127. package/ondewo-csi-api/google/cloud/runtimeconfig/README.md +39 -0
  128. package/ondewo-csi-api/google/cloud/speech/README.md +3 -0
  129. package/ondewo-csi-api/google/container/README.md +0 -0
  130. package/ondewo-csi-api/google/datastore/README.md +0 -0
  131. package/ondewo-csi-api/google/devtools/cloudbuild/README.md +1 -0
  132. package/ondewo-csi-api/google/devtools/clouderrorreporting/README.md +1 -0
  133. package/ondewo-csi-api/google/example/library/README.md +4 -0
  134. package/ondewo-csi-api/google/firestore/README.md +0 -0
  135. package/ondewo-csi-api/google/genomics/README.md +14 -0
  136. package/ondewo-csi-api/google/iam/README.md +14 -0
  137. package/ondewo-csi-api/google/logging/README.md +3 -0
  138. package/ondewo-csi-api/google/longrunning/README.md +5 -0
  139. package/ondewo-csi-api/google/privacy/dlp/README.md +7 -0
  140. package/ondewo-csi-api/google/pubsub/v1beta2/README.md +136 -0
  141. package/ondewo-csi-api/google/rpc/README.md +5 -0
  142. package/ondewo-csi-api/google/streetview/publish/README.md +1 -0
  143. package/ondewo-csi-api/google/type/README.md +16 -0
  144. package/ondewo-csi-api/googleapis/README.md +87 -0
  145. package/ondewo-csi-api/googleapis/google/ads/googleads/README.md +21 -0
  146. package/ondewo-csi-api/googleapis/google/api/README.md +5 -0
  147. package/ondewo-csi-api/googleapis/google/api/servicecontrol/README.md +126 -0
  148. package/ondewo-csi-api/googleapis/google/api/servicemanagement/README.md +102 -0
  149. package/ondewo-csi-api/googleapis/google/appengine/README.md +12 -0
  150. package/ondewo-csi-api/googleapis/google/assistant/embedded/README.md +3 -0
  151. package/ondewo-csi-api/googleapis/google/cloud/functions/README.md +2 -0
  152. package/ondewo-csi-api/googleapis/google/cloud/language/README.md +0 -0
  153. package/ondewo-csi-api/googleapis/google/cloud/runtimeconfig/README.md +39 -0
  154. package/ondewo-csi-api/googleapis/google/cloud/speech/README.md +3 -0
  155. package/ondewo-csi-api/googleapis/google/container/README.md +0 -0
  156. package/ondewo-csi-api/googleapis/google/datastore/README.md +0 -0
  157. package/ondewo-csi-api/googleapis/google/devtools/cloudbuild/README.md +1 -0
  158. package/ondewo-csi-api/googleapis/google/devtools/clouderrorreporting/README.md +1 -0
  159. package/ondewo-csi-api/googleapis/google/example/library/README.md +4 -0
  160. package/ondewo-csi-api/googleapis/google/firestore/README.md +0 -0
  161. package/ondewo-csi-api/googleapis/google/genomics/README.md +14 -0
  162. package/ondewo-csi-api/googleapis/google/iam/README.md +14 -0
  163. package/ondewo-csi-api/googleapis/google/logging/README.md +3 -0
  164. package/ondewo-csi-api/googleapis/google/longrunning/README.md +5 -0
  165. package/ondewo-csi-api/googleapis/google/privacy/dlp/README.md +7 -0
  166. package/ondewo-csi-api/googleapis/google/pubsub/v1beta2/README.md +136 -0
  167. package/ondewo-csi-api/googleapis/google/rpc/README.md +5 -0
  168. package/ondewo-csi-api/googleapis/google/streetview/publish/README.md +1 -0
  169. package/ondewo-csi-api/googleapis/google/type/README.md +16 -0
  170. package/ondewo-csi-api/ondewo-nlu-api/README.md +117 -0
  171. package/ondewo-csi-api/ondewo-nlu-api/googleapis/README.md +87 -0
  172. package/ondewo-csi-api/ondewo-nlu-api/googleapis/google/ads/googleads/README.md +21 -0
  173. package/ondewo-csi-api/ondewo-nlu-api/googleapis/google/api/README.md +5 -0
  174. package/ondewo-csi-api/ondewo-nlu-api/googleapis/google/api/servicecontrol/README.md +126 -0
  175. package/ondewo-csi-api/ondewo-nlu-api/googleapis/google/api/servicemanagement/README.md +102 -0
  176. package/ondewo-csi-api/ondewo-nlu-api/googleapis/google/appengine/README.md +12 -0
  177. package/ondewo-csi-api/ondewo-nlu-api/googleapis/google/assistant/embedded/README.md +3 -0
  178. package/ondewo-csi-api/ondewo-nlu-api/googleapis/google/cloud/functions/README.md +2 -0
  179. package/ondewo-csi-api/ondewo-nlu-api/googleapis/google/cloud/language/README.md +0 -0
  180. package/ondewo-csi-api/ondewo-nlu-api/googleapis/google/cloud/runtimeconfig/README.md +39 -0
  181. package/ondewo-csi-api/ondewo-nlu-api/googleapis/google/cloud/speech/README.md +3 -0
  182. package/ondewo-csi-api/ondewo-nlu-api/googleapis/google/container/README.md +0 -0
  183. package/ondewo-csi-api/ondewo-nlu-api/googleapis/google/datastore/README.md +0 -0
  184. package/ondewo-csi-api/ondewo-nlu-api/googleapis/google/devtools/cloudbuild/README.md +1 -0
  185. package/ondewo-csi-api/ondewo-nlu-api/googleapis/google/devtools/clouderrorreporting/README.md +1 -0
  186. package/ondewo-csi-api/ondewo-nlu-api/googleapis/google/example/library/README.md +4 -0
  187. package/ondewo-csi-api/ondewo-nlu-api/googleapis/google/firestore/README.md +0 -0
  188. package/ondewo-csi-api/ondewo-nlu-api/googleapis/google/genomics/README.md +14 -0
  189. package/ondewo-csi-api/ondewo-nlu-api/googleapis/google/iam/README.md +14 -0
  190. package/ondewo-csi-api/ondewo-nlu-api/googleapis/google/logging/README.md +3 -0
  191. package/ondewo-csi-api/ondewo-nlu-api/googleapis/google/longrunning/README.md +5 -0
  192. package/ondewo-csi-api/ondewo-nlu-api/googleapis/google/privacy/dlp/README.md +7 -0
  193. package/ondewo-csi-api/ondewo-nlu-api/googleapis/google/pubsub/v1beta2/README.md +136 -0
  194. package/ondewo-csi-api/ondewo-nlu-api/googleapis/google/rpc/README.md +5 -0
  195. package/ondewo-csi-api/ondewo-nlu-api/googleapis/google/streetview/publish/README.md +1 -0
  196. package/ondewo-csi-api/ondewo-nlu-api/googleapis/google/type/README.md +16 -0
  197. package/ondewo-csi-api/ondewo-s2t-api/README.md +89 -0
  198. package/ondewo-csi-api/ondewo-t2s-api/README.md +89 -0
  199. package/package.json +49 -0
  200. package/public-api.d.ts +54 -0
@@ -0,0 +1,117 @@
1
+ <p align="center">
2
+ <a href="https://www.ondewo.com">
3
+ <img alt="ONDEWO Logo" src="https://raw.githubusercontent.com/ondewo/ondewo-logos/master/github/ondewo_logo_github_2.png"/>
4
+ </a>
5
+ </p>
6
+
7
+ # ONDEWO NLU APIs
8
+
9
+ This repository contains the original interface definitions of public ONDEWO APIs that support gRPC protocols. Reading the original interface definitions can provide a better understanding of ONDEWO APIs and help you to utilize them more efficiently. You can also use these definitions with open source tools to generate client libraries, documentation, and other artifacts.
10
+
11
+ The API documentation is generated from files using [protoc-gen-doc](https://github.com/pseudomuto/protoc-gen-doc) in formats:
12
+ * [html](https://htmlpreview.github.io/?https://github.com/ondewo/ondewo-nlu-api/blob/feature/OND211-380-generate-documentation/doc/index.html)
13
+ * [markdown](doc/index.md)
14
+
15
+ The core components of all the client libraries are built directly from files in this repo using [the proto compiler](https://github.com/ondewo/ondewo-proto-compiler).
16
+
17
+ For an end-user, the APIs in this repo function mostly as documentation for the endpoints. For specific implementations, look in the following repos for working implementations:
18
+ * [Python](https://github.com/ondewo/ondewo-nlu-client-python)
19
+ * [Angular](https://github.com/ondewo/ondewo-nlu-client-angular)
20
+ * [JavaScript](https://github.com/ondewo/ondewo-nlu-client-javascript)
21
+ * [TypeScript](https://github.com/ondewo/ondewo-nlu-client-typescript)
22
+
23
+ Please note that some of these implementations are works-in-progress. The repo will make clear the status of the implementation.
24
+
25
+ ## Overview
26
+
27
+ ONDEWO APIs use [Protocol Buffers](https://github.com/google/protobuf) version 3 (proto3) as their Interface Definition Language (IDL) to define the API interface and the structure of the payload messages. The same interface definition is used for gRPC versions of the API in all languages.
28
+
29
+ There are several ways of accessing APIs:
30
+
31
+ 1. Protocol Buffers over gRPC: You can access APIs published in this repository through [GRPC](https://github.com/grpc), which is a high-performance binary RPC protocol over HTTP/2. It offers many useful features, including request/response multiplex and full-duplex streaming.
32
+
33
+ 2. ONDEWO Client Libraries:
34
+ You can use these libraries to access ONDEWO Cloud APIs. They are based on gRPC for better performance and provide idiomatic client surface for better developer experience.
35
+
36
+ ## Discussions
37
+
38
+ Please use the issue tracker in this repo for discussions about this API, or the issue tracker in the relevant client if it is language-specific.
39
+
40
+ ## Repository Structure
41
+
42
+ ```
43
+ .
44
+ ├── CONTRIBUTING.md
45
+ ├── doc
46
+ │   ├── index.html
47
+ │   ├── index.md
48
+ │   ├── style.css
49
+ ├── googleapis
50
+ │   └── (clone of https://github.com/googleapis/googleapis.git on commit hash == 79ab27f3b70ebc221e265d2e8ab30a8cc2d21fa2)
51
+ ├── LICENSE
52
+ ├── ondewo
53
+ │   ├── nlu
54
+ │   │   ├── agent.proto
55
+ │   │   ├── aiservices.proto
56
+ │   │   ├── common.proto
57
+ │   │   ├── context.proto
58
+ │   │   ├── entity_type.proto
59
+ │   │   ├── intent.proto
60
+ │   │   ├── operation_metadata.proto
61
+ │   │   ├── project_role.proto
62
+ │   │   ├── project_statistics.proto
63
+ │   │   ├── server_statistics.proto
64
+ │   │   ├── session.proto
65
+ │   │   ├── user.proto
66
+ │   │   └── webhook.proto
67
+ │   └── qa
68
+ │   └── qa.proto
69
+ ├── README.md
70
+ └── RELEASE.md
71
+ ```
72
+
73
+ ## Generate gRPC Source Code
74
+
75
+ API client libraries can be built directly from files in this repo using [the proto compiler.](https://github.com/ondewo/ondewo-proto-compiler)
76
+
77
+ Automatic Release Process
78
+ ------------------
79
+ The entire process is automated to make development easier. The actual steps are simple:
80
+
81
+ TODOs in Pull Request before the release:
82
+
83
+ - Update the Version number inside the Makefile
84
+
85
+ - Check if RELEASE.md is up-to-date
86
+
87
+ TODOs after Pull Request was merged in:
88
+
89
+ - Checkout master:
90
+ ```bash
91
+ git checkout master
92
+ ```
93
+ - Pull the new stuff:
94
+ ```bash
95
+ git pull
96
+ ```
97
+ - Release:
98
+ ```bash
99
+ make ondewo_release
100
+ ```
101
+
102
+ The ``` make ondewo_release``` command can be divided into 5 steps:
103
+
104
+ - cloning the devops-accounts repository and extracting the credentials
105
+ - creating and pushing the release branch
106
+ - creating and pushing the release tag
107
+ - creating the GitHub release
108
+
109
+ The variable for the GitHub Access Token is inside the Makefile,
110
+ but the value is overwritten during ``` make ondewo_release```, because
111
+ it is passed from the devops-accounts repo as an argument to the actual ```release``` command.
112
+
113
+ Proto Documentation
114
+ -------------------
115
+
116
+ Documentation for the .proto files is generated automatically when there is a pullrequest or push
117
+ to master. It is located in the branch [gh-pages](https://github.com/ondewo/ondewo-nlu-api/tree/gh-pages).
@@ -0,0 +1,87 @@
1
+ # Google APIs
2
+
3
+ This repository contains the original interface definitions of public
4
+ Google APIs that support both REST and gRPC protocols. Reading the
5
+ original interface definitions can provide a better understanding of
6
+ Google APIs and help you to utilize them more efficiently. You can also
7
+ use these definitions with open source tools to generate client
8
+ libraries, documentation, and other artifacts.
9
+
10
+ API client libraries can be built directly from files in this repo using
11
+ [Artman](https://github.com/googleapis/artman). The latest generation status can
12
+ be tracked [here](https://circleci.com/gh/googleapis/googleapis) which currently
13
+ has status [![CircleCI](https://circleci.com/gh/googleapis/googleapis.svg?style=svg)](https://circleci.com/gh/googleapis/googleapis).
14
+
15
+ For more details on all Google APIs and developer tools, see the [Google
16
+ Developers](https://developers.google.com/products/) site.
17
+
18
+ ## Overview
19
+
20
+ Google APIs are typically deployed as API services that are hosted
21
+ under different DNS names. One API service may implement multiple APIs
22
+ and multiple versions of the same API.
23
+
24
+ Google APIs use [Protocol Buffers](https://github.com/google/protobuf)
25
+ version 3 (proto3) as their Interface Definition Language (IDL) to
26
+ define the API interface and the structure of the payload messages. The
27
+ same interface definition is used for both REST and RPC versions of the
28
+ API, which can be accessed over different wire protocols.
29
+
30
+ There are several ways of accessing Google APIs:
31
+
32
+ 1. JSON over HTTP: You can access all Google APIs directly using JSON
33
+ over HTTP, using
34
+ [Google API client library](https://developers.google.com/api-client-library)
35
+ or third-party API client libraries.
36
+
37
+ 2. Protocol Buffers over gRPC: You can access Google APIs published
38
+ in this repository through [GRPC](https://github.com/grpc), which is
39
+ a high-performance binary RPC protocol over HTTP/2. It offers many
40
+ useful features, including request/response multiplex and full-duplex
41
+ streaming.
42
+
43
+ 3. [Google Cloud Client Libraries](https://cloud.google.com/apis/docs/cloud-client-libraries):
44
+ You can use these libraries to access Google Cloud APIs. They are based
45
+ on gRPC for better performance and provide idiomatic client surface for
46
+ better developer experience.
47
+
48
+ ## Discussions
49
+
50
+ This repo contains copies of Google API definitions and related files. For
51
+ discussions or to raise issues about
52
+ [Google API client libraries](https://github.com/googleapis),
53
+ [GRPC](https://github.com/grpc) or
54
+ [Google Cloud Client Libraries](https://github.com/googlecloudplatform) please
55
+ refer to the repos associated with each area.
56
+
57
+ ## Repository Structure
58
+
59
+ This repository uses a directory hierarchy that reflects the Google
60
+ API product structure. In general, every API has its own root
61
+ directory, and each major version of the API has its own subdirectory.
62
+ The proto package names exactly match the directory: this makes it
63
+ easy to locate the proto definitions and ensures that the generated
64
+ client libraries have idiomatic namespaces in most programming
65
+ languages. Alongside the API directories live the configuration files
66
+ for the [GAPIC toolkit](https://github.com/googleapis/toolkit).
67
+
68
+ **NOTE:** The major version of an API is used to indicate breaking
69
+ change to the API.
70
+
71
+ ## Generate gRPC Source Code
72
+
73
+ To generate gRPC source code for Google APIs in this repository, you
74
+ first need to install both Protocol Buffers and gRPC on your local
75
+ machine, then you can run `make LANGUAGE=xxx all` to generate the
76
+ source code. You need to integrated the generated source code into
77
+ your application build system.
78
+
79
+ **NOTE:** The Makefile is only intended to generate source code for the
80
+ entire repository. It is not for generating linkable client library
81
+ for a specific API. Please see other repositories under
82
+ https://github.com/googleapis for generating linkable client libraries.
83
+
84
+ ### Go gRPC Source Code
85
+ It is difficult to generate Go gRPC source code from this repository,
86
+ since Go has different directory structure.
87
+ Please use [this repository](https://github.com/google/go-genproto) instead.
@@ -0,0 +1,21 @@
1
+ # Google Ads API - proto definitions
2
+
3
+ This folder contains the [protocol
4
+ buffer](https://developers.google.com/protocol-buffers/) definitions for the
5
+ [Google Ads API](https://developers.google.com/google-ads/api/). To use this
6
+ API, we encourage you to take a look at our [official client
7
+ libraries](https://developers.google.com/google-ads/api/docs/client-libs) for
8
+ Java, Ruby, PHP, or .NET. Refer to the
9
+ [Quickstart](https://developers.google.com/google-ads/api/docs/first-call/overview)
10
+ to learn how to make your first API call.
11
+
12
+ To develop in a programming language without an official client library, refer
13
+ to the [API Concepts
14
+ Guide](https://developers.google.com/google-ads/api/docs/concepts/overview) and
15
+ consult these protocol buffer definitions as a reference when constructing API
16
+ requests.
17
+
18
+ Use [the official Google Ads API
19
+ forum](https://groups.google.com/d/forum/adwords-api) to request an official
20
+ client library in another programming language, report bugs, request new
21
+ features in the Google Ads API, or provide feedback.
@@ -0,0 +1,5 @@
1
+ This folder contains the schema of the configuration model for the API services
2
+ platform.
3
+
4
+ **Note**: Protos under this directory are in Alpha status, and therefore are
5
+ subject to breaking changes.
@@ -0,0 +1,126 @@
1
+ Google Service Control provides control plane functionality to managed services,
2
+ such as logging, monitoring, and status checks. This page provides an overview
3
+ of what it does and how it works.
4
+
5
+ ## Why use Service Control?
6
+
7
+ When you develop a cloud service, you typically start with the business
8
+ requirements and the architecture design, then proceed with API definition
9
+ and implementation. Before you put your service into production, you
10
+ need to deal with many control plane issues:
11
+
12
+ * How to control access to your service.
13
+ * How to send logging and monitoring data to both consumers and producers.
14
+ * How to create and manage dashboards to visualize this data.
15
+ * How to automatically scale the control plane components with your service.
16
+
17
+ Service Control is a mature and feature-rich control plane provider
18
+ that addresses these needs with high efficiency, high scalability,
19
+ and high availability. It provides a simple public API that can be accessed
20
+ from anywhere using JSON REST and gRPC clients, so when you move your service
21
+ from on-premise to a cloud provider, or from one cloud provider to another,
22
+ you don't need to change the control plane provider.
23
+
24
+ Services built using Google Cloud Endpoints already take advantage of
25
+ Service Control. Cloud Endpoints sends logging and monitoring data
26
+ through Google Service Control for every request arriving at its
27
+ proxy. If you need to report any additional logging and monitoring data for
28
+ your Cloud Endpoints service, you can call the Service Control API directly
29
+ from your service.
30
+
31
+ The Service Control API definition is open sourced and available on
32
+ [GitHub](https://github.com/googleapis/googleapis/tree/master/google/api/servicecontrol).
33
+ By changing the DNS name, you can easily use alternative implementations of
34
+ the Service Control API.
35
+
36
+ ## Architecture
37
+
38
+ Google Service Control works with a set of *managed services* and their
39
+ *operations* (activities), *checks* whether an operation is allowed to proceed,
40
+ and *reports* completed operations. Behind the scenes, it leverages other
41
+ Google Cloud services, such as
42
+ [Google Service Management](/service-management),
43
+ [Stackdriver Logging](/logging), and [Stackdriver Monitoring](/monitoring),
44
+ while hiding their complexity from service producers. It enables service
45
+ producers to send telemetry data to their consumers. It uses caching,
46
+ batching, aggregation, and retries to deliver higher performance and
47
+ availability than the individual backend systems it encapsulates.
48
+
49
+ <figure id="fig-arch" class="center">
50
+ <div style="width: 70%;margin: auto">
51
+ <img src="/service-control/images/arch.svg"
52
+ alt="The overall architecture of a service that uses Google Service Control.">
53
+ </div>
54
+ <figcaption><b>Figure 1</b>: Using Google Service Control.</figcaption>
55
+ </figure>
56
+
57
+ The Service Control API provides two methods:
58
+
59
+ * [`services.check`](/service-control/reference/rest/v1/services/check), used for:
60
+ * Ensuring valid consumer status
61
+ * Validating API keys
62
+ * [`services.report`](/service-control/reference/rest/v1/services/report), used for:
63
+ * Sending logs to Stackdriver Logging
64
+ * Sending metrics to Stackdriver Monitoring
65
+
66
+ We’ll look at these in more detail in the rest of this overview.
67
+
68
+ ## Managed services
69
+
70
+ A [managed service](/service-management/reference/rest/v1/services) is
71
+ a network service managed by
72
+ [Google Service Management](/service-management). Each managed service has a
73
+ unique name, such as `example.googleapis.com`, which must be a valid
74
+ fully-qualified DNS name, as per RFC 1035.
75
+
76
+ For example:
77
+
78
+ * Google Cloud Pub/Sub (`pubsub.googleapis.com`)
79
+ * Google Cloud Vision (`vision.googleapis.com`)
80
+ * Google Cloud Bigtable (`bigtable.googleapis.com`)
81
+ * Google Cloud Datastore (`datastore.googleapis.com`)
82
+
83
+ Google Service Management manages the lifecycle of each service’s
84
+ configuration, which is used to customize Google Service Control's behavior.
85
+ Service configurations are also used by Google Cloud Console
86
+ for displaying APIs and their settings, enabling/disabling APIs, and more.
87
+
88
+ ## Operations
89
+
90
+ Google Service Control uses the generic concept of an *operation*
91
+ to represent the
92
+ activities of a managed service, such as API calls and resource usage. Each
93
+ operation is associated with a managed service and a specific service
94
+ consumer, and has a set of properties that describe the operation, such as
95
+ the API method name and resource usage amount. For more information, see the
96
+ [Operation definition](/service-control/rest/v1/Operation).
97
+
98
+ ## Check
99
+
100
+ The [`services.check`](/service-control/reference/rest/v1/services/check)
101
+ method determines whether an operation should be allowed to proceed
102
+ for a managed service.
103
+
104
+ For example:
105
+
106
+ * Check if the consumer is still active.
107
+ * Check if the consumer has enabled the service.
108
+ * Check if the API key is still valid.
109
+
110
+ By performing multiple checks within a single method call, it provides
111
+ better performance, higher reliability, and reduced development cost to
112
+ service producers compared to checking with multiple backend systems.
113
+
114
+ ## Report
115
+
116
+ The [`services.report`](/service-control/reference/rest/v1/services/report)
117
+ method reports completed operations for
118
+ a managed service to backend systems, such as logging and monitoring. The
119
+ reported data can be seen in Google API Console and Google Cloud Console,
120
+ and retrieved with appropriate APIs, such as the Stackdriver Logging and
121
+ Stackdriver Monitoring APIs.
122
+
123
+ ## Next steps
124
+
125
+ * Read our [Getting Started guide](/service-control/getting-started) to find out
126
+ how to set up and use the Google Service Control API.
@@ -0,0 +1,102 @@
1
+ Google Service Management manages a set of *services*. Service
2
+ Management allows *service producers* to
3
+ publish their services on Google Cloud Platform so that they can be discovered
4
+ and used by *service consumers*. It also handles the tasks of tracking
5
+ service lifecycle and programming various backend systems -- such as
6
+ [Stackdriver Logging](https://cloud.google.com/stackdriver),
7
+ [Stackdriver Monitoring](https://cloud.google.com/stackdriver) -- to support
8
+ the managed services.
9
+
10
+ If you are a service producer, you can use the Google Service Management API
11
+ and [Google Cloud SDK (gcloud)](/sdk) to publish and manage your services.
12
+ Each managed service has a service configuration which declares various aspects
13
+ of the service such as its API surface, along with parameters to configure the
14
+ supporting backend
15
+ systems, such as logging and monitoring. If you build your service using
16
+ [Google Cloud Endpoints](https://cloud.google.com/endpoints/), the service
17
+ configuration will be handled automatically.
18
+
19
+ If you are a service consumer and want to use a managed service, you can use the
20
+ Google Service Management API or [Google Cloud Console](https://console.cloud.google.com)
21
+ to activate the
22
+ service for your [Google developer project](https://developers.google.com/console/help/new/),
23
+ then start using its APIs and functions.
24
+
25
+ ## Managed services
26
+
27
+ REST URL: `https://servicemanagement.googleapis.com/v1/services/{service-name}` <br />
28
+ REST schema is defined [here](/service-management/reference/rest/v1/services).
29
+
30
+ A managed service refers to a network service managed by
31
+ Service Management. Each managed service has a unique name, such as
32
+ `example.googleapis.com`, which must be a valid fully-qualified DNS name, as per
33
+ RFC 1035.
34
+
35
+ A managed service typically provides some REST APIs and/or other
36
+ functions to their service consumers, such as mobile apps or cloud services.
37
+
38
+ Service producers can use methods, such as
39
+ [services.create](/service-management/reference/rest/v1/services/create),
40
+ [services.delete](/service-management/reference/rest/v1/services/delete),
41
+ [services.undelete](/service-management/reference/rest/v1/services/undelete),
42
+ to manipulate their managed services.
43
+
44
+ ## Service producers
45
+
46
+ A service producer is the Google developer project responsible for publishing
47
+ and maintaining a managed service. Each managed service is owned by exactly one
48
+ service producer.
49
+
50
+ ## Service consumers
51
+
52
+ A service consumer is a Google developer project that has enabled and can
53
+ invoke APIs on a managed service. A managed service can have many service
54
+ consumers.
55
+
56
+ ## Service configuration
57
+
58
+ REST URL: `https://servicemanagement.googleapis.com/v1/services/{service-name}/configs/{config_id}` <br />
59
+ REST schema is defined [here](/service-management/reference/rest/v1/services.configs).
60
+
61
+ Each managed service is described by a service configuration which covers a wide
62
+ range of features, including its name, title, RPC API definitions,
63
+ REST API definitions, documentation, authentication, and more.
64
+
65
+ To change the configuration of a managed service, the service producer needs to
66
+ publish an updated service configuration to Service Management.
67
+ Service Management keeps a history of published
68
+ service configurations, making it possible to easily retrace how a service's
69
+ configuration evolved over time. Service configurations can be published using
70
+ the
71
+ [services.configs.create](/service-management/reference/rest/v1/services.configs/create)
72
+ or [services.configs.submit](/service-management/reference/rest/v1/services.configs/submit)
73
+ methods.
74
+
75
+ Alternatively, `services.configs.submit` allows publishing an
76
+ [OpenAPI](https://github.com/OAI/OpenAPI-Specification) specification, formerly
77
+ known as the Swagger Specification, which is automatically converted to a
78
+ corresponding service configuration.
79
+
80
+ ## Service rollout
81
+
82
+ REST URL: `https://servicemanagement.googleapis.com/v1/services/{service-name}/rollouts/{rollout-id}` <br />
83
+ REST schema is defined [here](/service-management/reference/rest/v1/services.rollouts).
84
+
85
+ A `Rollout` defines how Google Service Management should deploy service
86
+ configurations to backend systems and how the configurations take effect at
87
+ runtime. It lets service producers specify multiple service configuration
88
+ versions to be deployed together, and a strategy that indicates how they
89
+ should be used.
90
+
91
+ Updating a managed service's configuration can be dangerous, as a configuration
92
+ error can lead to a service outage. To mitigate risks, Service Management
93
+ supports gradual rollout of service configuration changes. This feature gives
94
+ service producers time to identity potential issues and rollback service
95
+ configuration changes in case of errors, thus minimizing the customer
96
+ impact of bad configurations. For example, you could specify that 5% of traffic
97
+ uses configuration 1, while the remaining 95% uses configuration 2.
98
+
99
+ Service Management keeps a history of rollouts so that service
100
+ producers can undo to previous configuration versions. You can rollback a configuration
101
+ by initiating a new `Rollout` that clones a previously submitted
102
+ rollout record.
@@ -0,0 +1,12 @@
1
+ # Google App Engine Admin API
2
+
3
+ ## Overview
4
+
5
+ The Google App Engine Admin API is a RESTful API for managing App Engine
6
+ applications. The Admin API provides programmatic access to several of the App
7
+ Engine administrative operations that are found in the
8
+ [Google Cloud Platform Console](https://cloud.google.com/appengine/docs/developers-console).
9
+
10
+ ## Documentation
11
+
12
+ [Google App Engine Admin API Documentation](https://cloud.google.com/appengine/docs/admin-api/)
@@ -0,0 +1,3 @@
1
+ The `Google Assistant API` allows developers to embed the Google Assistant into
2
+ their devices. It provides an audio-in (spoken user query) and
3
+ audio-out (Assistant spoken response).
@@ -0,0 +1,2 @@
1
+ API for managing lightweight user-provided functions executed in response to
2
+ events.
@@ -0,0 +1,39 @@
1
+ [TOC]
2
+
3
+ # Introduction
4
+
5
+ The RuntimeConfig service provides Google Cloud Platform users the ability to
6
+ dynamically configure your service.
7
+
8
+ The RuntimConfig service creates and manages RuntimeConfig resources
9
+ within a Google Cloud Project and various variables within said resource.
10
+
11
+ ## Details
12
+
13
+ Each cloud project can create multiple **Config** objects. A **Config** object
14
+ by itself does not contain any configuration information, but rather is a
15
+ logical grouping of variables. Variable names are hierarchical and follow file
16
+ system style, where only leaf nodes can contain values.
17
+
18
+ For example, you can have a configuration called *Flags*. Within that
19
+ configuration object, you can create the following variables.
20
+
21
+ * `/ports/service_port`
22
+ * `/ports/monitoring_port`
23
+ * `/ports/admin_port`
24
+
25
+ This creates three variables: `/ports/serve_port`, `/ports/monitoring_port`,
26
+ `/ports/admin_port`. Note that `/ports` cannot have a value but it can be
27
+ listed.
28
+
29
+ ### Setup
30
+
31
+ In order to make requests to RuntimeConfig service, you need to enable the API
32
+ for your project.
33
+
34
+ To achieve that, go to the
35
+ [Google Cloud Console](https://console.cloud.google.com/apis/api/runtimeconfig.googleapis.com/overview)
36
+ and enable *Google Cloud RuntimeConfig API* for your project.
37
+
38
+ The documentation for this service is located
39
+ [here](https://cloud.google.com/deployment-manager/runtime-configurator/reference/rest/).
@@ -0,0 +1,3 @@
1
+ # Introduction
2
+
3
+ Google Cloud Speech API provides speech recognition as a service.
@@ -0,0 +1 @@
1
+ The Google Cloud Container Builder API lets you to build an application or part of an application from source code stored in Google Cloud Storage or a Google Cloud Source Repository and package it into container images. The container images are then stored in Google Container Registry. You can optionally copy the images to another container registry as required.
@@ -0,0 +1 @@
1
+ Read more about the Stackdriver Error Reporting API [here](https://cloud.google.com/error-reporting/reference/)
@@ -0,0 +1,4 @@
1
+ # Introduction
2
+ This is a Google example service representing a simple digital library.
3
+ It manages a collection of shelf resources, and each shelf owns a collection
4
+ of book resources.
@@ -0,0 +1,14 @@
1
+ Stores, processes, explores and shares genomic data. This API implements
2
+ the Global Alliance for Genomics and Health (GA4GH) v0.5.1 API as well as
3
+ several extensions.
4
+
5
+ The Google Genomics API supports access via both
6
+ [JSON/REST](https://cloud.google.com/genomics/reference/rest) and
7
+ [gRPC](https://cloud.google.com/genomics/reference/rpc). JSON/REST is more
8
+ broadly available and is easier for getting started with Google Genomics; it
9
+ works well for small metadata resources (datasets, variant sets, read group
10
+ sets) and for browsing small genomic regions for datasets of any size. For
11
+ performant bulk data access (reads and variants), use gRPC.
12
+
13
+ See also an [overview of genomic resources](https://cloud.google.com/genomics/v1/users-guide)
14
+ and an overview of [Genomics on Google Cloud](https://cloud.google.com/genomics/overview).
@@ -0,0 +1,14 @@
1
+ # Introduction
2
+
3
+ # Key Concepts
4
+
5
+ ## Service Account
6
+
7
+ A Service Account is an account used to identify services (non-humans) to Google.
8
+ A Service Account has a list of Service Account Keys, which can be used to authenticate to Google.
9
+
10
+ ## Service Account Keys
11
+
12
+ A Service Account Key is a public/private keypair generated by Google. Google retains the public
13
+ key, while the customer is given the private key. The private key can be used to [sign JWTs and
14
+ authenticate Service Accounts to Google](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#authorizingrequests).
@@ -0,0 +1,3 @@
1
+ # Introduction
2
+
3
+ The Stackdriver Logging service.
@@ -0,0 +1,5 @@
1
+ # Google Long Running Operations API
2
+
3
+ This package contains the definition of an abstract interface that
4
+ manages long running operations with API services. See
5
+ [google.longrunning.Operations][] for details.
@@ -0,0 +1,7 @@
1
+ # Google Data Loss Prevention (DLP) API
2
+
3
+ The Google Data Loss Prevention API provides methods for detection
4
+ of privacy-sensitive fragments in text, images, and Google Cloud
5
+ Platform storage repositories.
6
+
7
+ Documentation: https://cloud.google.com/dlp/docs