Skip to content

Commit dbee08f

Browse files
docs: Minor formatting (#11632)
- [ ] Regenerate this pull request now. chore: Update gapic-generator-python to v1.11.5 build: Update rules_python to 0.24.0 PiperOrigin-RevId: 563436317 Source-Link: googleapis/googleapis@42fd37b Source-Link: googleapis/googleapis-gen@280264c Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWRhdGFwcm9jLW1ldGFzdG9yZS8uT3dsQm90LnlhbWwiLCJoIjoiMjgwMjY0Y2EwMmZiOTMxNmI0MjM3YTk2ZDBhZjFhMjM0M2E4MWE1NiJ9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWRhdGFzdHJlYW0vLk93bEJvdC55YW1sIiwiaCI6IjI4MDI2NGNhMDJmYjkzMTZiNDIzN2E5NmQwYWYxYTIzNDNhODFhNTYifQ== Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWRlcGxveS8uT3dsQm90LnlhbWwiLCJoIjoiMjgwMjY0Y2EwMmZiOTMxNmI0MjM3YTk2ZDBhZjFhMjM0M2E4MWE1NiJ9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWRpYWxvZ2Zsb3ctY3gvLk93bEJvdC55YW1sIiwiaCI6IjI4MDI2NGNhMDJmYjkzMTZiNDIzN2E5NmQwYWYxYTIzNDNhODFhNTYifQ== Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWRpc2NvdmVyeWVuZ2luZS8uT3dsQm90LnlhbWwiLCJoIjoiMjgwMjY0Y2EwMmZiOTMxNmI0MjM3YTk2ZDBhZjFhMjM0M2E4MWE1NiJ9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWRvY3VtZW50YWkvLk93bEJvdC55YW1sIiwiaCI6IjI4MDI2NGNhMDJmYjkzMTZiNDIzN2E5NmQwYWYxYTIzNDNhODFhNTYifQ== Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWRvbWFpbnMvLk93bEJvdC55YW1sIiwiaCI6IjI4MDI2NGNhMDJmYjkzMTZiNDIzN2E5NmQwYWYxYTIzNDNhODFhNTYifQ== Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWVkZ2Vjb250YWluZXIvLk93bEJvdC55YW1sIiwiaCI6IjI4MDI2NGNhMDJmYjkzMTZiNDIzN2E5NmQwYWYxYTIzNDNhODFhNTYifQ== Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWVudGVycHJpc2Vrbm93bGVkZ2VncmFwaC8uT3dsQm90LnlhbWwiLCJoIjoiMjgwMjY0Y2EwMmZiOTMxNmI0MjM3YTk2ZDBhZjFhMjM0M2E4MWE1NiJ9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWVzc2VudGlhbC1jb250YWN0cy8uT3dsQm90LnlhbWwiLCJoIjoiMjgwMjY0Y2EwMmZiOTMxNmI0MjM3YTk2ZDBhZjFhMjM0M2E4MWE1NiJ9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWV2ZW50YXJjLXB1Ymxpc2hpbmcvLk93bEJvdC55YW1sIiwiaCI6IjI4MDI2NGNhMDJmYjkzMTZiNDIzN2E5NmQwYWYxYTIzNDNhODFhNTYifQ== Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWV2ZW50YXJjLy5Pd2xCb3QueWFtbCIsImgiOiIyODAyNjRjYTAyZmI5MzE2YjQyMzdhOTZkMGFmMWEyMzQzYTgxYTU2In0= Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWZ1bmN0aW9ucy8uT3dsQm90LnlhbWwiLCJoIjoiMjgwMjY0Y2EwMmZiOTMxNmI0MjM3YTk2ZDBhZjFhMjM0M2E4MWE1NiJ9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWdrZS1jb25uZWN0LWdhdGV3YXkvLk93bEJvdC55YW1sIiwiaCI6IjI4MDI2NGNhMDJmYjkzMTZiNDIzN2E5NmQwYWYxYTIzNDNhODFhNTYifQ== Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWdrZS1tdWx0aWNsb3VkLy5Pd2xCb3QueWFtbCIsImgiOiIyODAyNjRjYTAyZmI5MzE2YjQyMzdhOTZkMGFmMWEyMzQzYTgxYTU2In0= Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWlhbS1sb2dnaW5nLy5Pd2xCb3QueWFtbCIsImgiOiIyODAyNjRjYTAyZmI5MzE2YjQyMzdhOTZkMGFmMWEyMzQzYTgxYTU2In0= Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWlhbS8uT3dsQm90LnlhbWwiLCJoIjoiMjgwMjY0Y2EwMmZiOTMxNmI0MjM3YTk2ZDBhZjFhMjM0M2E4MWE1NiJ9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWlhcC8uT3dsQm90LnlhbWwiLCJoIjoiMjgwMjY0Y2EwMmZiOTMxNmI0MjM3YTk2ZDBhZjFhMjM0M2E4MWE1NiJ9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWlkcy8uT3dsQm90LnlhbWwiLCJoIjoiMjgwMjY0Y2EwMmZiOTMxNmI0MjM3YTk2ZDBhZjFhMjM0M2E4MWE1NiJ9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWttcy1pbnZlbnRvcnkvLk93bEJvdC55YW1sIiwiaCI6IjI4MDI2NGNhMDJmYjkzMTZiNDIzN2E5NmQwYWYxYTIzNDNhODFhNTYifQ== --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: Anthonios Partheniou <partheniou@google.com>
1 parent 4769404 commit dbee08f

File tree

546 files changed

+4760
-686
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

546 files changed

+4760
-686
lines changed

packages/google-cloud-dataproc-metastore/.flake8

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# -*- coding: utf-8 -*-
22
#
3-
# Copyright 2020 Google LLC
3+
# Copyright 2023 Google LLC
44
#
55
# Licensed under the Apache License, Version 2.0 (the "License");
66
# you may not use this file except in compliance with the License.

packages/google-cloud-dataproc-metastore/CONTRIBUTING.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ We support:
236236

237237
Supported versions can be found in our ``noxfile.py`` `config`_.
238238

239-
.. _config: https://github.com/googleapis/google-cloud-python/blob/main/noxfile.py
239+
.. _config: https://github.com/googleapis/google-cloud-python/blob/main/packages/google-cloud-dataproc-metastore/noxfile.py
240240

241241

242242
**********

packages/google-cloud-dataproc-metastore/MANIFEST.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# -*- coding: utf-8 -*-
22
#
3-
# Copyright 2020 Google LLC
3+
# Copyright 2023 Google LLC
44
#
55
# Licensed under the Apache License, Version 2.0 (the "License");
66
# you may not use this file except in compliance with the License.

packages/google-cloud-dataproc-metastore/README.rst

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -36,21 +36,24 @@ In order to use this library, you first need to go through the following steps:
3636
Installation
3737
~~~~~~~~~~~~
3838

39-
Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to
40-
create isolated Python environments. The basic problem it addresses is one of
41-
dependencies and versions, and indirectly permissions.
39+
Install this library in a virtual environment using `venv`_. `venv`_ is a tool that
40+
creates isolated Python environments. These isolated environments can have separate
41+
versions of Python packages, which allows you to isolate one project's dependencies
42+
from the dependencies of other projects.
4243

43-
With `virtualenv`_, it's possible to install this library without needing system
44+
With `venv`_, it's possible to install this library without needing system
4445
install permissions, and without clashing with the installed system
4546
dependencies.
4647

47-
.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/
48+
.. _`venv`: https://docs.python.org/3/library/venv.html
4849

4950

5051
Code samples and snippets
5152
~~~~~~~~~~~~~~~~~~~~~~~~~
5253

53-
Code samples and snippets live in the `samples/` folder.
54+
Code samples and snippets live in the `samples/`_ folder.
55+
56+
.. _samples/: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-dataproc-metastore/samples
5457

5558

5659
Supported Python Versions
@@ -77,21 +80,19 @@ Mac/Linux
7780

7881
.. code-block:: console
7982
80-
pip install virtualenv
81-
virtualenv <your-env>
83+
python3 -m venv <your-env>
8284
source <your-env>/bin/activate
83-
<your-env>/bin/pip install google-cloud-dataproc-metastore
85+
pip install google-cloud-dataproc-metastore
8486
8587
8688
Windows
8789
^^^^^^^
8890

8991
.. code-block:: console
9092
91-
pip install virtualenv
92-
virtualenv <your-env>
93-
<your-env>\Scripts\activate
94-
<your-env>\Scripts\pip.exe install google-cloud-dataproc-metastore
93+
py -m venv <your-env>
94+
.\<your-env>\Scripts\activate
95+
pip install google-cloud-dataproc-metastore
9596
9697
Next Steps
9798
~~~~~~~~~~

packages/google-cloud-dataproc-metastore/docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# -*- coding: utf-8 -*-
2-
# Copyright 2021 Google LLC
2+
# Copyright 2023 Google LLC
33
#
44
# Licensed under the Apache License, Version 2.0 (the "License");
55
# you may not use this file except in compliance with the License.

packages/google-cloud-dataproc-metastore/google/cloud/metastore_v1/services/dataproc_metastore/async_client.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@
4747
from google.cloud.location import locations_pb2 # type: ignore
4848
from google.iam.v1 import iam_policy_pb2 # type: ignore
4949
from google.iam.v1 import policy_pb2 # type: ignore
50-
from google.longrunning import operations_pb2
50+
from google.longrunning import operations_pb2 # type: ignore
5151
from google.protobuf import empty_pb2 # type: ignore
5252
from google.protobuf import field_mask_pb2 # type: ignore
5353
from google.protobuf import timestamp_pb2 # type: ignore
@@ -550,6 +550,7 @@ async def sample_create_service():
550550
service, which is used as the final
551551
component of the metastore service's
552552
name.
553+
553554
This value must be between 2 and 63
554555
characters long inclusive, begin with a
555556
letter, end with a letter or number, and
@@ -1182,6 +1183,7 @@ async def sample_create_metadata_import():
11821183
Required. The ID of the metadata
11831184
import, which is used as the final
11841185
component of the metadata import's name.
1186+
11851187
This value must be between 1 and 64
11861188
characters long, begin with a letter,
11871189
end with a letter or number, and consist
@@ -1912,6 +1914,7 @@ async def sample_create_backup():
19121914
Required. The ID of the backup, which
19131915
is used as the final component of the
19141916
backup's name.
1917+
19151918
This value must be between 1 and 64
19161919
characters long, begin with a letter,
19171920
end with a letter or number, and consist

packages/google-cloud-dataproc-metastore/google/cloud/metastore_v1/services/dataproc_metastore/client.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@
5151
from google.cloud.location import locations_pb2 # type: ignore
5252
from google.iam.v1 import iam_policy_pb2 # type: ignore
5353
from google.iam.v1 import policy_pb2 # type: ignore
54-
from google.longrunning import operations_pb2
54+
from google.longrunning import operations_pb2 # type: ignore
5555
from google.protobuf import empty_pb2 # type: ignore
5656
from google.protobuf import field_mask_pb2 # type: ignore
5757
from google.protobuf import timestamp_pb2 # type: ignore
@@ -858,6 +858,7 @@ def sample_create_service():
858858
service, which is used as the final
859859
component of the metastore service's
860860
name.
861+
861862
This value must be between 2 and 63
862863
characters long inclusive, begin with a
863864
letter, end with a letter or number, and
@@ -1490,6 +1491,7 @@ def sample_create_metadata_import():
14901491
Required. The ID of the metadata
14911492
import, which is used as the final
14921493
component of the metadata import's name.
1494+
14931495
This value must be between 1 and 64
14941496
characters long, begin with a letter,
14951497
end with a letter or number, and consist
@@ -2221,6 +2223,7 @@ def sample_create_backup():
22212223
Required. The ID of the backup, which
22222224
is used as the final component of the
22232225
backup's name.
2226+
22242227
This value must be between 1 and 64
22252228
characters long, begin with a letter,
22262229
end with a letter or number, and consist

packages/google-cloud-dataproc-metastore/google/cloud/metastore_v1/services/dataproc_metastore/transports/rest.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,6 @@
3535
from google.cloud.location import locations_pb2 # type: ignore
3636
from google.iam.v1 import iam_policy_pb2 # type: ignore
3737
from google.iam.v1 import policy_pb2 # type: ignore
38-
from google.longrunning import operations_pb2
3938
from google.protobuf import json_format
4039
import grpc # type: ignore
4140
from requests import __version__ as requests_version

packages/google-cloud-dataproc-metastore/google/cloud/metastore_v1/services/dataproc_metastore_federation/async_client.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@
4747
from google.cloud.location import locations_pb2 # type: ignore
4848
from google.iam.v1 import iam_policy_pb2 # type: ignore
4949
from google.iam.v1 import policy_pb2 # type: ignore
50-
from google.longrunning import operations_pb2
50+
from google.longrunning import operations_pb2 # type: ignore
5151
from google.protobuf import empty_pb2 # type: ignore
5252
from google.protobuf import field_mask_pb2 # type: ignore
5353
from google.protobuf import timestamp_pb2 # type: ignore
@@ -308,6 +308,7 @@ async def sample_list_federations():
308308
Returns:
309309
google.cloud.metastore_v1.services.dataproc_metastore_federation.pagers.ListFederationsAsyncPager:
310310
Response message for ListFederations
311+
311312
Iterating over this object will yield
312313
results and resolve additional pages
313314
automatically.
@@ -543,6 +544,7 @@ async def sample_create_federation():
543544
federation, which is used as the final
544545
component of the metastore federation's
545546
name.
547+
546548
This value must be between 2 and 63
547549
characters long inclusive, begin with a
548550
letter, end with a letter or number, and

packages/google-cloud-dataproc-metastore/google/cloud/metastore_v1/services/dataproc_metastore_federation/client.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@
5151
from google.cloud.location import locations_pb2 # type: ignore
5252
from google.iam.v1 import iam_policy_pb2 # type: ignore
5353
from google.iam.v1 import policy_pb2 # type: ignore
54-
from google.longrunning import operations_pb2
54+
from google.longrunning import operations_pb2 # type: ignore
5555
from google.protobuf import empty_pb2 # type: ignore
5656
from google.protobuf import field_mask_pb2 # type: ignore
5757
from google.protobuf import timestamp_pb2 # type: ignore
@@ -534,6 +534,7 @@ def sample_list_federations():
534534
Returns:
535535
google.cloud.metastore_v1.services.dataproc_metastore_federation.pagers.ListFederationsPager:
536536
Response message for ListFederations
537+
537538
Iterating over this object will yield
538539
results and resolve additional pages
539540
automatically.
@@ -769,6 +770,7 @@ def sample_create_federation():
769770
federation, which is used as the final
770771
component of the metastore federation's
771772
name.
773+
772774
This value must be between 2 and 63
773775
characters long inclusive, begin with a
774776
letter, end with a letter or number, and

0 commit comments

Comments
 (0)