Skip to content

Commit 2e4b1cb

Browse files
yoshi-automationJustinBeckwith
yoshi-automation
authored and
JustinBeckwith
committed
docs: update docstrings and metadata (#294)
1 parent c183147 commit 2e4b1cb

File tree

2 files changed

+302
-59
lines changed

2 files changed

+302
-59
lines changed

‎packages/google-cloud-bigquery-datatransfer/src/v1/doc/google/rpc/doc_status.js

+6-54
Original file line numberDiff line numberDiff line change
@@ -18,67 +18,19 @@
1818
/**
1919
* The `Status` type defines a logical error model that is suitable for
2020
* different programming environments, including REST APIs and RPC APIs. It is
21-
* used by [gRPC](https://github.com/grpc). The error model is designed to be:
21+
* used by [gRPC](https://github.com/grpc). Each `Status` message contains
22+
* three pieces of data: error code, error message, and error details.
2223
*
23-
* - Simple to use and understand for most users
24-
* - Flexible enough to meet unexpected needs
25-
*
26-
* # Overview
27-
*
28-
* The `Status` message contains three pieces of data: error code, error
29-
* message, and error details. The error code should be an enum value of
30-
* google.rpc.Code, but it may accept additional error codes
31-
* if needed. The error message should be a developer-facing English message
32-
* that helps developers *understand* and *resolve* the error. If a localized
33-
* user-facing error message is needed, put the localized message in the error
34-
* details or localize it in the client. The optional error details may contain
35-
* arbitrary information about the error. There is a predefined set of error
36-
* detail types in the package `google.rpc` that can be used for common error
37-
* conditions.
38-
*
39-
* # Language mapping
40-
*
41-
* The `Status` message is the logical representation of the error model, but it
42-
* is not necessarily the actual wire format. When the `Status` message is
43-
* exposed in different client libraries and different wire protocols, it can be
44-
* mapped differently. For example, it will likely be mapped to some exceptions
45-
* in Java, but more likely mapped to some error codes in C.
46-
*
47-
* # Other uses
48-
*
49-
* The error model and the `Status` message can be used in a variety of
50-
* environments, either with or without APIs, to provide a
51-
* consistent developer experience across different environments.
52-
*
53-
* Example uses of this error model include:
54-
*
55-
* - Partial errors. If a service needs to return partial errors to the client,
56-
* it may embed the `Status` in the normal response to indicate the partial
57-
* errors.
58-
*
59-
* - Workflow errors. A typical workflow has multiple steps. Each step may
60-
* have a `Status` message for error reporting.
61-
*
62-
* - Batch operations. If a client uses batch request and batch response, the
63-
* `Status` message should be used directly inside batch response, one for
64-
* each error sub-response.
65-
*
66-
* - Asynchronous operations. If an API call embeds asynchronous operation
67-
* results in its response, the status of those operations should be
68-
* represented directly using the `Status` message.
69-
*
70-
* - Logging. If some API errors are stored in logs, the message `Status` could
71-
* be used directly after any stripping needed for security/privacy reasons.
24+
* You can find out more about this error model and how to work with it in the
25+
* [API Design Guide](https://cloud.google.com/apis/design/errors).
7226
*
7327
* @property {number} code
74-
* The status code, which should be an enum value of
75-
* google.rpc.Code.
28+
* The status code, which should be an enum value of google.rpc.Code.
7629
*
7730
* @property {string} message
7831
* A developer-facing error message, which should be in English. Any
7932
* user-facing error message should be localized and sent in the
80-
* google.rpc.Status.details field, or localized
81-
* by the client.
33+
* google.rpc.Status.details field, or localized by the client.
8234
*
8335
* @property {Object[]} details
8436
* A list of messages that carry the error details. There is a common set of

‎packages/google-cloud-bigquery-datatransfer/synth.metadata

+296-5
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,20 @@
11
{
2-
"updateTime": "2020-01-15T12:11:44.383850Z",
2+
"updateTime": "2020-01-22T12:11:59.042949Z",
33
"sources": [
44
{
55
"generator": {
66
"name": "artman",
7-
"version": "0.44.0",
8-
"dockerImage": "googleapis/artman@sha256:10a6d0342b8d62544810ac5ad86c3b21049ec0696608ac60175da8e513234344"
7+
"version": "0.44.1",
8+
"dockerImage": "googleapis/artman@sha256:5599b61e56a372d21b671969ee915fbca0f6c3a0daaeb898d01f8f685f1bbc8b"
99
}
1010
},
1111
{
1212
"git": {
1313
"name": "googleapis",
1414
"remote": "https://github.com/googleapis/googleapis.git",
15-
"sha": "d99df0d67057a233c711187e0689baa4f8e6333d",
16-
"internalRef": "289709813"
15+
"sha": "cda99c1f7dc5e4ca9b1caeae1dc330838cbc1461",
16+
"internalRef": "290800639",
17+
"log": "cda99c1f7dc5e4ca9b1caeae1dc330838cbc1461\nChange api_name to 'asset' for v1p1beta1\n\nPiperOrigin-RevId: 290800639\n\n94e9e90c303a820ce40643d9129e7f0d2054e8a1\nAdds Google Maps Road service\n\nPiperOrigin-RevId: 290795667\n\na3b23dcb2eaecce98c600c7d009451bdec52dbda\nrpc: new message ErrorInfo, other comment updates\n\nPiperOrigin-RevId: 290781668\n\n26420ef4e46c37f193c0fbe53d6ebac481de460e\nAdd proto definition for Org Policy v1.\n\nPiperOrigin-RevId: 290771923\n\n7f0dab8177cf371ae019a082e2512de7ac102888\nPublish Routes Preferred API v1 service definitions.\n\nPiperOrigin-RevId: 290326986\n\nad6e508d0728e1d1bca6e3f328cd562718cb772d\nFix: Qualify resource type references with \"jobs.googleapis.com/\"\n\nPiperOrigin-RevId: 290285762\n\n58e770d568a2b78168ddc19a874178fee8265a9d\ncts client library\n\nPiperOrigin-RevId: 290146169\n\naf9daa4c3b4c4a8b7133b81588dd9ffd37270af2\nAdd more programming language options to public proto\n\nPiperOrigin-RevId: 290144091\n\nd9f2bbf2df301ef84641d4cec7c828736a0bd907\ntalent: add missing resource.proto dep to Bazel build target\n\nPiperOrigin-RevId: 290143164\n\n3b3968237451d027b42471cd28884a5a1faed6c7\nAnnotate Talent API.\nAdd gRPC service config for retry.\nUpdate bazel file with google.api.resource dependency.\n\nPiperOrigin-RevId: 290125172\n\n0735b4b096872960568d1f366bfa75b7b0e1f1a3\nWeekly library update.\n\nPiperOrigin-RevId: 289939042\n\n8760d3d9a4543d7f9c0d1c7870aca08b116e4095\nWeekly library update.\n\nPiperOrigin-RevId: 289939020\n\n8607df842f782a901805187e02fff598145b0b0e\nChange Talent API timeout to 30s.\n\nPiperOrigin-RevId: 289912621\n\n908155991fe32570653bcb72ecfdcfc896642f41\nAdd Recommendations AI V1Beta1\n\nPiperOrigin-RevId: 289901914\n\n5c9a8c2bebd8b71aa66d1cc473edfaac837a2c78\nAdding no-arg method signatures for ListBillingAccounts and ListServices\n\nPiperOrigin-RevId: 289891136\n\n50b0e8286ac988b0593bd890eb31fef6ea2f5767\nlongrunning: add grpc service config and default_host annotation to operations.proto\n\nPiperOrigin-RevId: 289876944\n\n6cac27dabe51c54807b0401698c32d34998948a9\n Updating default deadline for Cloud Security Command Center's v1 APIs.\n\nPiperOrigin-RevId: 289875412\n\n"
1718
}
1819
},
1920
{
@@ -35,5 +36,295 @@
3536
"config": "google/cloud/bigquery/datatransfer/artman_bigquerydatatransfer.yaml"
3637
}
3738
}
39+
],
40+
"newFiles": [
41+
{
42+
"path": ".eslintignore"
43+
},
44+
{
45+
"path": ".eslintrc.yml"
46+
},
47+
{
48+
"path": ".github/ISSUE_TEMPLATE/bug_report.md"
49+
},
50+
{
51+
"path": ".github/ISSUE_TEMPLATE/feature_request.md"
52+
},
53+
{
54+
"path": ".github/ISSUE_TEMPLATE/support_request.md"
55+
},
56+
{
57+
"path": ".github/PULL_REQUEST_TEMPLATE.md"
58+
},
59+
{
60+
"path": ".github/release-please.yml"
61+
},
62+
{
63+
"path": ".gitignore"
64+
},
65+
{
66+
"path": ".jsdoc.js"
67+
},
68+
{
69+
"path": ".kokoro/.gitattributes"
70+
},
71+
{
72+
"path": ".kokoro/common.cfg"
73+
},
74+
{
75+
"path": ".kokoro/continuous/node10/common.cfg"
76+
},
77+
{
78+
"path": ".kokoro/continuous/node10/docs.cfg"
79+
},
80+
{
81+
"path": ".kokoro/continuous/node10/lint.cfg"
82+
},
83+
{
84+
"path": ".kokoro/continuous/node10/samples-test.cfg"
85+
},
86+
{
87+
"path": ".kokoro/continuous/node10/system-test.cfg"
88+
},
89+
{
90+
"path": ".kokoro/continuous/node10/test.cfg"
91+
},
92+
{
93+
"path": ".kokoro/continuous/node12/common.cfg"
94+
},
95+
{
96+
"path": ".kokoro/continuous/node12/test.cfg"
97+
},
98+
{
99+
"path": ".kokoro/continuous/node8/common.cfg"
100+
},
101+
{
102+
"path": ".kokoro/continuous/node8/test.cfg"
103+
},
104+
{
105+
"path": ".kokoro/docs.sh"
106+
},
107+
{
108+
"path": ".kokoro/lint.sh"
109+
},
110+
{
111+
"path": ".kokoro/presubmit/node10/common.cfg"
112+
},
113+
{
114+
"path": ".kokoro/presubmit/node10/docs.cfg"
115+
},
116+
{
117+
"path": ".kokoro/presubmit/node10/lint.cfg"
118+
},
119+
{
120+
"path": ".kokoro/presubmit/node10/samples-test.cfg"
121+
},
122+
{
123+
"path": ".kokoro/presubmit/node10/system-test.cfg"
124+
},
125+
{
126+
"path": ".kokoro/presubmit/node10/test.cfg"
127+
},
128+
{
129+
"path": ".kokoro/presubmit/node12/common.cfg"
130+
},
131+
{
132+
"path": ".kokoro/presubmit/node12/test.cfg"
133+
},
134+
{
135+
"path": ".kokoro/presubmit/node8/common.cfg"
136+
},
137+
{
138+
"path": ".kokoro/presubmit/node8/test.cfg"
139+
},
140+
{
141+
"path": ".kokoro/presubmit/windows/common.cfg"
142+
},
143+
{
144+
"path": ".kokoro/presubmit/windows/test.cfg"
145+
},
146+
{
147+
"path": ".kokoro/publish.sh"
148+
},
149+
{
150+
"path": ".kokoro/release/common.cfg"
151+
},
152+
{
153+
"path": ".kokoro/release/docs.cfg"
154+
},
155+
{
156+
"path": ".kokoro/release/docs.sh"
157+
},
158+
{
159+
"path": ".kokoro/release/publish.cfg"
160+
},
161+
{
162+
"path": ".kokoro/samples-test.sh"
163+
},
164+
{
165+
"path": ".kokoro/system-test.sh"
166+
},
167+
{
168+
"path": ".kokoro/test.bat"
169+
},
170+
{
171+
"path": ".kokoro/test.sh"
172+
},
173+
{
174+
"path": ".kokoro/trampoline.sh"
175+
},
176+
{
177+
"path": ".nycrc"
178+
},
179+
{
180+
"path": ".prettierignore"
181+
},
182+
{
183+
"path": ".prettierrc"
184+
},
185+
{
186+
"path": ".repo-metadata.json"
187+
},
188+
{
189+
"path": "CHANGELOG.md"
190+
},
191+
{
192+
"path": "CODE_OF_CONDUCT.md"
193+
},
194+
{
195+
"path": "CONTRIBUTING.md"
196+
},
197+
{
198+
"path": "LICENSE"
199+
},
200+
{
201+
"path": "README.md"
202+
},
203+
{
204+
"path": "codecov.yaml"
205+
},
206+
{
207+
"path": "linkinator.config.json"
208+
},
209+
{
210+
"path": "package.json"
211+
},
212+
{
213+
"path": "protos/google/cloud/bigquery/datatransfer/v1/datasource.proto"
214+
},
215+
{
216+
"path": "protos/google/cloud/bigquery/datatransfer/v1/datatransfer.proto"
217+
},
218+
{
219+
"path": "protos/google/cloud/bigquery/datatransfer/v1/resourcestate.proto"
220+
},
221+
{
222+
"path": "protos/google/cloud/bigquery/datatransfer/v1/transfer.proto"
223+
},
224+
{
225+
"path": "protos/protos.d.ts"
226+
},
227+
{
228+
"path": "protos/protos.js"
229+
},
230+
{
231+
"path": "protos/protos.json"
232+
},
233+
{
234+
"path": "renovate.json"
235+
},
236+
{
237+
"path": "samples/.eslintrc.yml"
238+
},
239+
{
240+
"path": "samples/README.md"
241+
},
242+
{
243+
"path": "samples/package.json"
244+
},
245+
{
246+
"path": "samples/quickstart.js"
247+
},
248+
{
249+
"path": "samples/test/quickstart.test.js"
250+
},
251+
{
252+
"path": "smoke-test/.eslintrc.yml"
253+
},
254+
{
255+
"path": "smoke-test/data_transfer_service_smoke_test.js"
256+
},
257+
{
258+
"path": "src/browser.js"
259+
},
260+
{
261+
"path": "src/index.js"
262+
},
263+
{
264+
"path": "src/v1/data_transfer_service_client.js"
265+
},
266+
{
267+
"path": "src/v1/data_transfer_service_client_config.json"
268+
},
269+
{
270+
"path": "src/v1/data_transfer_service_proto_list.json"
271+
},
272+
{
273+
"path": "src/v1/doc/google/cloud/bigquery/datatransfer/v1/doc_datasource.js"
274+
},
275+
{
276+
"path": "src/v1/doc/google/cloud/bigquery/datatransfer/v1/doc_datatransfer.js"
277+
},
278+
{
279+
"path": "src/v1/doc/google/cloud/bigquery/datatransfer/v1/doc_transfer.js"
280+
},
281+
{
282+
"path": "src/v1/doc/google/protobuf/doc_any.js"
283+
},
284+
{
285+
"path": "src/v1/doc/google/protobuf/doc_duration.js"
286+
},
287+
{
288+
"path": "src/v1/doc/google/protobuf/doc_empty.js"
289+
},
290+
{
291+
"path": "src/v1/doc/google/protobuf/doc_field_mask.js"
292+
},
293+
{
294+
"path": "src/v1/doc/google/protobuf/doc_struct.js"
295+
},
296+
{
297+
"path": "src/v1/doc/google/protobuf/doc_timestamp.js"
298+
},
299+
{
300+
"path": "src/v1/doc/google/protobuf/doc_wrappers.js"
301+
},
302+
{
303+
"path": "src/v1/doc/google/rpc/doc_status.js"
304+
},
305+
{
306+
"path": "src/v1/index.js"
307+
},
308+
{
309+
"path": "synth.metadata"
310+
},
311+
{
312+
"path": "synth.py"
313+
},
314+
{
315+
"path": "system-test/.eslintrc.yml"
316+
},
317+
{
318+
"path": "system-test/system.js"
319+
},
320+
{
321+
"path": "test/gapic-v1.js"
322+
},
323+
{
324+
"path": "test/mocha.opts"
325+
},
326+
{
327+
"path": "webpack.config.js"
328+
}
38329
]
39330
}

0 commit comments

Comments
 (0)