@@ -56,7 +56,8 @@ def __init__(
56
56
def application_name (self ) -> Optional [str ]:
57
57
"""The application name to amend to the user-agent sent to Google APIs.
58
58
59
- Recommended format is ``"appplication-name/major.minor.patch_version"``
59
+ The application name to amend to the user agent sent to Google APIs.
60
+ The recommended format is ``"appplication-name/major.minor.patch_version"``
60
61
or ``"(gpn:PartnerName;)"`` for official Google partners.
61
62
"""
62
63
return self ._application_name
@@ -71,7 +72,7 @@ def application_name(self, value: Optional[str]):
71
72
72
73
@property
73
74
def credentials (self ) -> Optional [google .auth .credentials .Credentials ]:
74
- """The OAuth2 Credentials to use for this client."""
75
+ """The OAuth2 credentials to use for this client."""
75
76
return self ._credentials
76
77
77
78
@credentials .setter
@@ -84,7 +85,7 @@ def credentials(self, value: Optional[google.auth.credentials.Credentials]):
84
85
def location (self ) -> Optional [str ]:
85
86
"""Default location for job, datasets, and tables.
86
87
87
- See: https://cloud.google.com/bigquery/docs/locations
88
+ For more information, see https://cloud.google.com/bigquery/docs/locations BigQuery locations.
88
89
"""
89
90
return self ._location
90
91
@@ -107,13 +108,15 @@ def project(self, value: Optional[str]):
107
108
108
109
@property
109
110
def bq_connection (self ) -> Optional [str ]:
110
- """Name of the BigQuery connection to use. Should be of the form
111
+ """Name of the BigQuery connection to use in the form
111
112
<PROJECT_NUMBER/PROJECT_ID>.<LOCATION>.<CONNECTION_ID>.
112
113
113
- You should either have the connection already created in the
114
- <code>location</code> you have chosen, or you should have the Project IAM
115
- Admin role to enable the service to create the connection for you if you
116
- need it.
114
+ You either need to create the connection in a location of your choice, or
115
+ you need the Project Admin IAM role to enable the service to create the
116
+ connection for you.
117
+
118
+ If this option isn't available, or the project or location isn't provided,
119
+ then the default connection project/location/connection_id is used in the session.
117
120
118
121
If this option isn't provided, or project or location aren't provided,
119
122
session will use its default project/location/connection_id as default connection.
@@ -151,12 +154,12 @@ def use_regional_endpoints(self) -> bool:
151
154
"""Flag to connect to regional API endpoints.
152
155
153
156
.. deprecated:: 0.13.0
154
- Use of regional endpoints is a feature in preview and
157
+ Use of regional endpoints is a feature in Preview and
155
158
available only in selected regions and projects.
156
159
157
- Requires ``location`` to also be set. For example, set
158
- ``location=' asia-northeast1'`` and ``use_regional_endpoints=True`` to
159
- connect to asia-northeast1-bigquery.googleapis.com .
160
+ Requires that ``location`` is set. For example, to connect to
161
+ asia-northeast1-bigquery.googleapis.com, specify
162
+ ``location=' asia-northeast1'`` and ``use_regional_endpoints=True`` .
160
163
"""
161
164
return self ._use_regional_endpoints
162
165
@@ -177,17 +180,22 @@ def use_regional_endpoints(self, value: bool):
177
180
178
181
@property
179
182
def kms_key_name (self ) -> Optional [str ]:
180
- """Customer managed encryption key used to control encryption of the
183
+ """
184
+ Customer-managed encryption key
185
+ used to control encryption of the data at rest in BigQuery. This key
186
+ takes the format projects/PROJECT_ID/locations/LOCATION/keyRings/KEYRING/cryptoKeys/KEY
187
+
188
+ Customer managed encryption key used to control encryption of the
181
189
data-at-rest in BigQuery. This is of the format
182
190
projects/PROJECT_ID/locations/LOCATION/keyRings/KEYRING/cryptoKeys/KEY
183
191
184
- See https://cloud.google.com/bigquery/docs/customer-managed-encryption
185
- for more details.
192
+ For more information, see https://cloud.google.com/bigquery/docs/customer-managed-encryption
193
+ Customer-managed Cloud KMS keys
186
194
187
- Please make sure the project used for Bigquery DataFrames has "Cloud KMS
188
- CryptoKey Encrypter/Decrypter" role in the key's project, See
189
- https://cloud.google.com/bigquery/docs/customer-managed-encryption#assign_role
190
- for steps on how to ensure that .
195
+ Make sure the project used for Bigquery DataFrames has the
196
+ Cloud KMS CryptoKey Encrypter/Decrypter IAM role in the key's project.
197
+ For more information, see https://cloud.google.com/bigquery/docs/customer-managed-encryption#assign_role
198
+ Assign the Encrypter/Decrypter .
191
199
"""
192
200
return self ._kms_key_name
193
201
0 commit comments