From 760fcb73217aabe4815bc16dc464c1a0e500ea3e Mon Sep 17 00:00:00 2001 From: Peter Lamut Date: Thu, 7 Nov 2019 11:53:48 +0200 Subject: [PATCH] chore(bigquery): fix link anchors in external config docstrings --- .../google/cloud/bigquery/external_config.py | 85 +++++++------------ 1 file changed, 29 insertions(+), 56 deletions(-) diff --git a/bigquery/google/cloud/bigquery/external_config.py b/bigquery/google/cloud/bigquery/external_config.py index c637d37d185c..8355c0f0940d 100644 --- a/bigquery/google/cloud/bigquery/external_config.py +++ b/bigquery/google/cloud/bigquery/external_config.py @@ -68,8 +68,7 @@ def encoding(self): """str: The encoding of the values when the type is not `STRING` See - https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.%28key%29.bigtableOptions.columnFamilies.columns.encoding - https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.bigtableOptions.columnFamilies.columns.encoding + https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableColumn.FIELDS.encoding """ return self._properties.get("encoding") @@ -83,8 +82,7 @@ def field_name(self): field identifier See - https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.%28key%29.bigtableOptions.columnFamilies.columns.fieldName - https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.bigtableOptions.columnFamilies.columns.fieldName + https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableColumn.FIELDS.field_name """ return self._properties.get("fieldName") @@ -98,8 +96,7 @@ def only_read_latest(self): column are exposed. See - https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.%28key%29.bigtableOptions.columnFamilies.columns.onlyReadLatest - https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.bigtableOptions.columnFamilies.columns.onlyReadLatest + https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableColumn.FIELDS.only_read_latest """ return self._properties.get("onlyReadLatest") @@ -115,8 +112,7 @@ def qualifier_encoded(self): will handle base64 encoding for you. See - https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.%28key%29.bigtableOptions.columnFamilies.columns.qualifierEncoded - https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.bigtableOptions.columnFamilies.columns.qualifierEncoded + https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableColumn.FIELDS.qualifier_encoded """ prop = self._properties.get("qualifierEncoded") if prop is None: @@ -132,8 +128,7 @@ def qualifier_string(self): """str: A valid UTF-8 string qualifier See - https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.%28key%29.bigtableOptions.columnFamilies.columns.qualifierEncoded - https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.bigtableOptions.columnFamilies.columns.qualifierEncoded + https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableColumn.FIELDS.qualifier_string """ return self._properties.get("qualifierString") @@ -146,8 +141,7 @@ def type_(self): """str: The type to convert the value in cells of this column. See - https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.%28key%29.bigtableOptions.columnFamilies.columns.type - https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.bigtableOptions.columnFamilies.columns.type + https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableColumn.FIELDS.type """ return self._properties.get("type") @@ -194,8 +188,7 @@ def encoding(self): """str: The encoding of the values when the type is not `STRING` See - https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.(key).bigtableOptions.columnFamilies.encoding - https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.bigtableOptions.columnFamilies.encoding + https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableColumnFamily.FIELDS.encoding """ return self._properties.get("encoding") @@ -208,8 +201,7 @@ def family_id(self): """str: Identifier of the column family. See - https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.(key).bigtableOptions.columnFamilies.familyId - https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.bigtableOptions.columnFamilies.familyId + https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableColumnFamily.FIELDS.family_id """ return self._properties.get("familyId") @@ -223,8 +215,7 @@ def only_read_latest(self): for all columns in this column family. See - https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.(key).bigtableOptions.columnFamilies.onlyReadLatest - https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.bigtableOptions.columnFamilies.onlyReadLatest + https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableColumnFamily.FIELDS.only_read_latest """ return self._properties.get("onlyReadLatest") @@ -237,8 +228,7 @@ def type_(self): """str: The type to convert the value in cells of this column family. See - https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.(key).bigtableOptions.columnFamilies.type - https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.bigtableOptions.columnFamilies.type + https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableColumnFamily.FIELDS.type """ return self._properties.get("type") @@ -252,8 +242,7 @@ def columns(self): that should be exposed as individual fields. See - https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.(key).bigtableOptions.columnFamilies.columns - https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.bigtableOptions.columnFamilies.columns + https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableColumnFamily.FIELDS.columns """ prop = self._properties.get("columns", []) return [BigtableColumn.from_api_repr(col) for col in prop] @@ -307,8 +296,7 @@ def ignore_unspecified_column_families(self): :attr:`column_families` list. Defaults to :data:`False`. See - https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.(key).bigtableOptions.ignoreUnspecifiedColumnFamilies - https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.bigtableOptions.ignoreUnspecifiedColumnFamilies + https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableOptions.FIELDS.ignore_unspecified_column_families """ return self._properties.get("ignoreUnspecifiedColumnFamilies") @@ -322,8 +310,7 @@ def read_rowkey_as_string(self): converted to string. Defaults to :data:`False`. See - https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.(key).bigtableOptions.readRowkeyAsString - https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.bigtableOptions.readRowkeyAsString + https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableOptions.FIELDS.read_rowkey_as_string """ return self._properties.get("readRowkeyAsString") @@ -337,8 +324,7 @@ def column_families(self): column families to expose in the table schema along with their types. See - https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.(key).bigtableOptions.columnFamilies - https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.bigtableOptions.columnFamilies + https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableOptions.FIELDS.column_families """ prop = self._properties.get("columnFamilies", []) return [BigtableColumnFamily.from_api_repr(cf) for cf in prop] @@ -390,8 +376,7 @@ def allow_jagged_rows(self): null values. Defaults to :data:`False`. See - https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.(key).csvOptions.allowJaggedRows - https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.csvOptions.allowJaggedRows + https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#CsvOptions.FIELDS.allow_jagged_rows """ return self._properties.get("allowJaggedRows") @@ -405,8 +390,7 @@ def allow_quoted_newlines(self): characters in a CSV file are allowed. Defaults to :data:`False`. See - https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.(key).csvOptions.allowQuotedNewlines - https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.csvOptions.allowQuotedNewlines + https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#CsvOptions.FIELDS.allow_quoted_newlines """ return self._properties.get("allowQuotedNewlines") @@ -419,8 +403,7 @@ def encoding(self): """str: The character encoding of the data. See - https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.(key).csvOptions.encoding - https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.csvOptions.encoding + https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#CsvOptions.FIELDS.encoding """ return self._properties.get("encoding") @@ -433,8 +416,7 @@ def field_delimiter(self): """str: The separator for fields in a CSV file. Defaults to comma (','). See - https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.(key).csvOptions.fieldDelimiter - https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.csvOptions.fieldDelimiter + https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#CsvOptions.FIELDS.field_delimiter """ return self._properties.get("fieldDelimiter") @@ -447,8 +429,7 @@ def quote_character(self): """str: The value that is used to quote data sections in a CSV file. See - https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.(key).csvOptions.quote - https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.csvOptions.quote + https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#CsvOptions.FIELDS.quote """ return self._properties.get("quote") @@ -461,8 +442,7 @@ def skip_leading_rows(self): """int: The number of rows at the top of a CSV file. See - https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.(key).csvOptions.skipLeadingRows - https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.csvOptions.skipLeadingRows + https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#CsvOptions.FIELDS.skip_leading_rows """ return _int_or_none(self._properties.get("skipLeadingRows")) @@ -512,8 +492,7 @@ def skip_leading_rows(self): skip when reading the data. See - https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.(key).googleSheetsOptions.skipLeadingRows - https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.googleSheetsOptions.skipLeadingRows + https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#GoogleSheetsOptions.FIELDS.skip_leading_rows """ return _int_or_none(self._properties.get("skipLeadingRows")) @@ -526,7 +505,7 @@ def range(self): """str: The range of a sheet that BigQuery will query from. See - https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#GoogleSheetsOptions + https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#GoogleSheetsOptions.FIELDS.range """ return _str_or_none(self._properties.get("range")) @@ -586,7 +565,7 @@ def source_format(self): Format of external source. See - https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.sourceFormat + https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#ExternalDataConfiguration.FIELDS.source_format """ return self._properties["sourceFormat"] @@ -601,8 +580,7 @@ def autodetect(self): automatically. See - https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.(key).autodetect - https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.autodetect + https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#ExternalDataConfiguration.FIELDS.autodetect """ return self._properties.get("autodetect") @@ -615,8 +593,7 @@ def compression(self): """str: The compression type of the data source. See - https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.(key).compression - https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.compression + https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#ExternalDataConfiguration.FIELDS.compression """ return self._properties.get("compression") @@ -630,8 +607,7 @@ def ignore_unknown_values(self): table schema are ignored. Defaults to :data:`False`. See - https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.(key).ignoreUnknownValues - https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.ignoreUnknownValues + https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#ExternalDataConfiguration.FIELDS.ignore_unknown_values """ return self._properties.get("ignoreUnknownValues") @@ -645,8 +621,7 @@ def max_bad_records(self): reading data. See - https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.(key).maxBadRecords - https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.maxBadRecords + https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#ExternalDataConfiguration.FIELDS.max_bad_records """ return self._properties.get("maxBadRecords") @@ -659,8 +634,7 @@ def source_uris(self): """List[str]: URIs that point to your data in Google Cloud. See - https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.(key).sourceUris - https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.sourceUris + https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#ExternalDataConfiguration.FIELDS.source_uris """ return self._properties.get("sourceUris", []) @@ -674,8 +648,7 @@ def schema(self): for the data. See - https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.(key).schema - https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.schema + https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#ExternalDataConfiguration.FIELDS.schema """ prop = self._properties.get("schema", {}) return [SchemaField.from_api_repr(field) for field in prop.get("fields", [])]