Skip to content

Commit b55170e

Browse files
authored
chore(bigquery): fix link anchors in external config docstrings (#9627)
1 parent 505d553 commit b55170e

1 file changed

Lines changed: 29 additions & 56 deletions

File tree

bigquery/google/cloud/bigquery/external_config.py

Lines changed: 29 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,7 @@ def encoding(self):
6868
"""str: The encoding of the values when the type is not `STRING`
6969
7070
See
71-
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.%28key%29.bigtableOptions.columnFamilies.columns.encoding
72-
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.bigtableOptions.columnFamilies.columns.encoding
71+
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableColumn.FIELDS.encoding
7372
"""
7473
return self._properties.get("encoding")
7574

@@ -83,8 +82,7 @@ def field_name(self):
8382
field identifier
8483
8584
See
86-
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.%28key%29.bigtableOptions.columnFamilies.columns.fieldName
87-
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.bigtableOptions.columnFamilies.columns.fieldName
85+
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableColumn.FIELDS.field_name
8886
"""
8987
return self._properties.get("fieldName")
9088

@@ -98,8 +96,7 @@ def only_read_latest(self):
9896
column are exposed.
9997
10098
See
101-
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.%28key%29.bigtableOptions.columnFamilies.columns.onlyReadLatest
102-
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.bigtableOptions.columnFamilies.columns.onlyReadLatest
99+
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableColumn.FIELDS.only_read_latest
103100
"""
104101
return self._properties.get("onlyReadLatest")
105102

@@ -115,8 +112,7 @@ def qualifier_encoded(self):
115112
will handle base64 encoding for you.
116113
117114
See
118-
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.%28key%29.bigtableOptions.columnFamilies.columns.qualifierEncoded
119-
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.bigtableOptions.columnFamilies.columns.qualifierEncoded
115+
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableColumn.FIELDS.qualifier_encoded
120116
"""
121117
prop = self._properties.get("qualifierEncoded")
122118
if prop is None:
@@ -132,8 +128,7 @@ def qualifier_string(self):
132128
"""str: A valid UTF-8 string qualifier
133129
134130
See
135-
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.%28key%29.bigtableOptions.columnFamilies.columns.qualifierEncoded
136-
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.bigtableOptions.columnFamilies.columns.qualifierEncoded
131+
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableColumn.FIELDS.qualifier_string
137132
"""
138133
return self._properties.get("qualifierString")
139134

@@ -146,8 +141,7 @@ def type_(self):
146141
"""str: The type to convert the value in cells of this column.
147142
148143
See
149-
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.%28key%29.bigtableOptions.columnFamilies.columns.type
150-
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.bigtableOptions.columnFamilies.columns.type
144+
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableColumn.FIELDS.type
151145
"""
152146
return self._properties.get("type")
153147

@@ -194,8 +188,7 @@ def encoding(self):
194188
"""str: The encoding of the values when the type is not `STRING`
195189
196190
See
197-
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.(key).bigtableOptions.columnFamilies.encoding
198-
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.bigtableOptions.columnFamilies.encoding
191+
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableColumnFamily.FIELDS.encoding
199192
"""
200193
return self._properties.get("encoding")
201194

@@ -208,8 +201,7 @@ def family_id(self):
208201
"""str: Identifier of the column family.
209202
210203
See
211-
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.(key).bigtableOptions.columnFamilies.familyId
212-
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.bigtableOptions.columnFamilies.familyId
204+
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableColumnFamily.FIELDS.family_id
213205
"""
214206
return self._properties.get("familyId")
215207

@@ -223,8 +215,7 @@ def only_read_latest(self):
223215
for all columns in this column family.
224216
225217
See
226-
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.(key).bigtableOptions.columnFamilies.onlyReadLatest
227-
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.bigtableOptions.columnFamilies.onlyReadLatest
218+
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableColumnFamily.FIELDS.only_read_latest
228219
"""
229220
return self._properties.get("onlyReadLatest")
230221

@@ -237,8 +228,7 @@ def type_(self):
237228
"""str: The type to convert the value in cells of this column family.
238229
239230
See
240-
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.(key).bigtableOptions.columnFamilies.type
241-
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.bigtableOptions.columnFamilies.type
231+
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableColumnFamily.FIELDS.type
242232
"""
243233
return self._properties.get("type")
244234

@@ -252,8 +242,7 @@ def columns(self):
252242
that should be exposed as individual fields.
253243
254244
See
255-
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.(key).bigtableOptions.columnFamilies.columns
256-
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.bigtableOptions.columnFamilies.columns
245+
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableColumnFamily.FIELDS.columns
257246
"""
258247
prop = self._properties.get("columns", [])
259248
return [BigtableColumn.from_api_repr(col) for col in prop]
@@ -307,8 +296,7 @@ def ignore_unspecified_column_families(self):
307296
:attr:`column_families` list. Defaults to :data:`False`.
308297
309298
See
310-
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.(key).bigtableOptions.ignoreUnspecifiedColumnFamilies
311-
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.bigtableOptions.ignoreUnspecifiedColumnFamilies
299+
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableOptions.FIELDS.ignore_unspecified_column_families
312300
"""
313301
return self._properties.get("ignoreUnspecifiedColumnFamilies")
314302

@@ -322,8 +310,7 @@ def read_rowkey_as_string(self):
322310
converted to string. Defaults to :data:`False`.
323311
324312
See
325-
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.(key).bigtableOptions.readRowkeyAsString
326-
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.bigtableOptions.readRowkeyAsString
313+
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableOptions.FIELDS.read_rowkey_as_string
327314
"""
328315
return self._properties.get("readRowkeyAsString")
329316

@@ -337,8 +324,7 @@ def column_families(self):
337324
column families to expose in the table schema along with their types.
338325
339326
See
340-
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.(key).bigtableOptions.columnFamilies
341-
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.bigtableOptions.columnFamilies
327+
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableOptions.FIELDS.column_families
342328
"""
343329
prop = self._properties.get("columnFamilies", [])
344330
return [BigtableColumnFamily.from_api_repr(cf) for cf in prop]
@@ -390,8 +376,7 @@ def allow_jagged_rows(self):
390376
null values. Defaults to :data:`False`.
391377
392378
See
393-
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.(key).csvOptions.allowJaggedRows
394-
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.csvOptions.allowJaggedRows
379+
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#CsvOptions.FIELDS.allow_jagged_rows
395380
"""
396381
return self._properties.get("allowJaggedRows")
397382

@@ -405,8 +390,7 @@ def allow_quoted_newlines(self):
405390
characters in a CSV file are allowed. Defaults to :data:`False`.
406391
407392
See
408-
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.(key).csvOptions.allowQuotedNewlines
409-
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.csvOptions.allowQuotedNewlines
393+
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#CsvOptions.FIELDS.allow_quoted_newlines
410394
"""
411395
return self._properties.get("allowQuotedNewlines")
412396

@@ -419,8 +403,7 @@ def encoding(self):
419403
"""str: The character encoding of the data.
420404
421405
See
422-
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.(key).csvOptions.encoding
423-
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.csvOptions.encoding
406+
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#CsvOptions.FIELDS.encoding
424407
"""
425408
return self._properties.get("encoding")
426409

@@ -433,8 +416,7 @@ def field_delimiter(self):
433416
"""str: The separator for fields in a CSV file. Defaults to comma (',').
434417
435418
See
436-
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.(key).csvOptions.fieldDelimiter
437-
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.csvOptions.fieldDelimiter
419+
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#CsvOptions.FIELDS.field_delimiter
438420
"""
439421
return self._properties.get("fieldDelimiter")
440422

@@ -447,8 +429,7 @@ def quote_character(self):
447429
"""str: The value that is used to quote data sections in a CSV file.
448430
449431
See
450-
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.(key).csvOptions.quote
451-
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.csvOptions.quote
432+
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#CsvOptions.FIELDS.quote
452433
"""
453434
return self._properties.get("quote")
454435

@@ -461,8 +442,7 @@ def skip_leading_rows(self):
461442
"""int: The number of rows at the top of a CSV file.
462443
463444
See
464-
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.(key).csvOptions.skipLeadingRows
465-
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.csvOptions.skipLeadingRows
445+
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#CsvOptions.FIELDS.skip_leading_rows
466446
"""
467447
return _int_or_none(self._properties.get("skipLeadingRows"))
468448

@@ -512,8 +492,7 @@ def skip_leading_rows(self):
512492
skip when reading the data.
513493
514494
See
515-
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.(key).googleSheetsOptions.skipLeadingRows
516-
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.googleSheetsOptions.skipLeadingRows
495+
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#GoogleSheetsOptions.FIELDS.skip_leading_rows
517496
"""
518497
return _int_or_none(self._properties.get("skipLeadingRows"))
519498

@@ -526,7 +505,7 @@ def range(self):
526505
"""str: The range of a sheet that BigQuery will query from.
527506
528507
See
529-
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#GoogleSheetsOptions
508+
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#GoogleSheetsOptions.FIELDS.range
530509
"""
531510
return _str_or_none(self._properties.get("range"))
532511

@@ -586,7 +565,7 @@ def source_format(self):
586565
Format of external source.
587566
588567
See
589-
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.sourceFormat
568+
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#ExternalDataConfiguration.FIELDS.source_format
590569
"""
591570
return self._properties["sourceFormat"]
592571

@@ -601,8 +580,7 @@ def autodetect(self):
601580
automatically.
602581
603582
See
604-
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.(key).autodetect
605-
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.autodetect
583+
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#ExternalDataConfiguration.FIELDS.autodetect
606584
"""
607585
return self._properties.get("autodetect")
608586

@@ -615,8 +593,7 @@ def compression(self):
615593
"""str: The compression type of the data source.
616594
617595
See
618-
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.(key).compression
619-
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.compression
596+
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#ExternalDataConfiguration.FIELDS.compression
620597
"""
621598
return self._properties.get("compression")
622599

@@ -630,8 +607,7 @@ def ignore_unknown_values(self):
630607
table schema are ignored. Defaults to :data:`False`.
631608
632609
See
633-
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.(key).ignoreUnknownValues
634-
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.ignoreUnknownValues
610+
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#ExternalDataConfiguration.FIELDS.ignore_unknown_values
635611
"""
636612
return self._properties.get("ignoreUnknownValues")
637613

@@ -645,8 +621,7 @@ def max_bad_records(self):
645621
reading data.
646622
647623
See
648-
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.(key).maxBadRecords
649-
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.maxBadRecords
624+
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#ExternalDataConfiguration.FIELDS.max_bad_records
650625
"""
651626
return self._properties.get("maxBadRecords")
652627

@@ -659,8 +634,7 @@ def source_uris(self):
659634
"""List[str]: URIs that point to your data in Google Cloud.
660635
661636
See
662-
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.(key).sourceUris
663-
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.sourceUris
637+
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#ExternalDataConfiguration.FIELDS.source_uris
664638
"""
665639
return self._properties.get("sourceUris", [])
666640

@@ -674,8 +648,7 @@ def schema(self):
674648
for the data.
675649
676650
See
677-
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.(key).schema
678-
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.schema
651+
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#ExternalDataConfiguration.FIELDS.schema
679652
"""
680653
prop = self._properties.get("schema", {})
681654
return [SchemaField.from_api_repr(field) for field in prop.get("fields", [])]

0 commit comments

Comments
 (0)