google-cloud-container 2.56.0__tar.gz → 2.56.1__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {google_cloud_container-2.56.0/google_cloud_container.egg-info → google_cloud_container-2.56.1}/PKG-INFO +97 -8
- google_cloud_container-2.56.1/README.rst +197 -0
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/google/cloud/container/gapic_version.py +1 -1
- {google_cloud_container-2.56.0/google/cloud/container_v1beta1 → google_cloud_container-2.56.1/google/cloud/container_v1}/gapic_version.py +1 -1
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/google/cloud/container_v1/services/cluster_manager/async_client.py +93 -27
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/google/cloud/container_v1/services/cluster_manager/client.py +93 -27
- {google_cloud_container-2.56.0/google/cloud/container_v1 → google_cloud_container-2.56.1/google/cloud/container_v1beta1}/gapic_version.py +1 -1
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/google/cloud/container_v1beta1/services/cluster_manager/async_client.py +116 -30
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/google/cloud/container_v1beta1/services/cluster_manager/client.py +116 -30
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1/google_cloud_container.egg-info}/PKG-INFO +97 -8
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/google_cloud_container.egg-info/SOURCES.txt +0 -1
- google_cloud_container-2.56.1/google_cloud_container.egg-info/requires.txt +7 -0
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/setup.cfg +0 -3
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/setup.py +5 -5
- google_cloud_container-2.56.0/README.rst +0 -108
- google_cloud_container-2.56.0/google_cloud_container.egg-info/requires.txt +0 -7
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/LICENSE +0 -0
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/MANIFEST.in +0 -0
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/google/cloud/container/__init__.py +0 -0
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/google/cloud/container/py.typed +0 -0
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/google/cloud/container_v1/__init__.py +0 -0
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/google/cloud/container_v1/gapic_metadata.json +0 -0
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/google/cloud/container_v1/py.typed +0 -0
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/google/cloud/container_v1/services/__init__.py +0 -0
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/google/cloud/container_v1/services/cluster_manager/__init__.py +0 -0
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/google/cloud/container_v1/services/cluster_manager/pagers.py +0 -0
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/google/cloud/container_v1/services/cluster_manager/transports/__init__.py +0 -0
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/google/cloud/container_v1/services/cluster_manager/transports/base.py +0 -0
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/google/cloud/container_v1/services/cluster_manager/transports/grpc.py +0 -0
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/google/cloud/container_v1/services/cluster_manager/transports/grpc_asyncio.py +0 -0
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/google/cloud/container_v1/services/cluster_manager/transports/rest.py +0 -0
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/google/cloud/container_v1/services/cluster_manager/transports/rest_base.py +0 -0
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/google/cloud/container_v1/types/__init__.py +0 -0
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/google/cloud/container_v1/types/cluster_service.py +0 -0
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/google/cloud/container_v1beta1/__init__.py +0 -0
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/google/cloud/container_v1beta1/gapic_metadata.json +0 -0
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/google/cloud/container_v1beta1/py.typed +0 -0
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/google/cloud/container_v1beta1/services/__init__.py +0 -0
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/google/cloud/container_v1beta1/services/cluster_manager/__init__.py +0 -0
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/google/cloud/container_v1beta1/services/cluster_manager/pagers.py +0 -0
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/google/cloud/container_v1beta1/services/cluster_manager/transports/__init__.py +0 -0
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/google/cloud/container_v1beta1/services/cluster_manager/transports/base.py +0 -0
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/google/cloud/container_v1beta1/services/cluster_manager/transports/grpc.py +0 -0
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/google/cloud/container_v1beta1/services/cluster_manager/transports/grpc_asyncio.py +0 -0
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/google/cloud/container_v1beta1/types/__init__.py +0 -0
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/google/cloud/container_v1beta1/types/cluster_service.py +0 -0
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/google_cloud_container.egg-info/dependency_links.txt +0 -0
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/google_cloud_container.egg-info/not-zip-safe +0 -0
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/google_cloud_container.egg-info/top_level.txt +0 -0
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/tests/__init__.py +0 -0
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/tests/system/__init__.py +0 -0
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/tests/system/smoke_test.py +0 -0
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/tests/unit/__init__.py +0 -0
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/tests/unit/gapic/__init__.py +0 -0
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/tests/unit/gapic/container_v1/__init__.py +0 -0
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/tests/unit/gapic/container_v1/test_cluster_manager.py +0 -0
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/tests/unit/gapic/container_v1beta1/__init__.py +0 -0
- {google_cloud_container-2.56.0 → google_cloud_container-2.56.1}/tests/unit/gapic/container_v1beta1/test_cluster_manager.py +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.1
|
|
2
2
|
Name: google-cloud-container
|
|
3
|
-
Version: 2.56.
|
|
3
|
+
Version: 2.56.1
|
|
4
4
|
Summary: Google Cloud Container API client library
|
|
5
5
|
Home-page: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-container
|
|
6
6
|
Author: Google LLC
|
|
@@ -23,11 +23,11 @@ Classifier: Operating System :: OS Independent
|
|
|
23
23
|
Classifier: Topic :: Internet
|
|
24
24
|
Requires-Python: >=3.7
|
|
25
25
|
License-File: LICENSE
|
|
26
|
-
Requires-Dist: google-api-core[grpc]!=2.0.*,!=2.1.*,!=2.10.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,!=2.8.*,!=2.9.*,<3.0.
|
|
27
|
-
Requires-Dist: google-auth!=2.24.0,!=2.25.0,<3.0.
|
|
28
|
-
Requires-Dist: proto-plus<2.0.
|
|
29
|
-
Requires-Dist: proto-plus<2.0.
|
|
30
|
-
Requires-Dist: protobuf!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5,<
|
|
26
|
+
Requires-Dist: google-api-core[grpc]!=2.0.*,!=2.1.*,!=2.10.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,!=2.8.*,!=2.9.*,<3.0.0,>=1.34.1
|
|
27
|
+
Requires-Dist: google-auth!=2.24.0,!=2.25.0,<3.0.0,>=2.14.1
|
|
28
|
+
Requires-Dist: proto-plus<2.0.0,>=1.22.3
|
|
29
|
+
Requires-Dist: proto-plus<2.0.0,>=1.25.0; python_version >= "3.13"
|
|
30
|
+
Requires-Dist: protobuf!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5,<7.0.0,>=3.20.2
|
|
31
31
|
|
|
32
32
|
Python Client for Kubernetes Engine
|
|
33
33
|
===================================
|
|
@@ -57,12 +57,12 @@ In order to use this library, you first need to go through the following steps:
|
|
|
57
57
|
1. `Select or create a Cloud Platform project.`_
|
|
58
58
|
2. `Enable billing for your project.`_
|
|
59
59
|
3. `Enable the Kubernetes Engine.`_
|
|
60
|
-
4. `
|
|
60
|
+
4. `Set up Authentication.`_
|
|
61
61
|
|
|
62
62
|
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
|
|
63
63
|
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
|
|
64
64
|
.. _Enable the Kubernetes Engine.: https://cloud.google.com/kubernetes-engine/
|
|
65
|
-
..
|
|
65
|
+
.. _Set up Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
|
|
66
66
|
|
|
67
67
|
Installation
|
|
68
68
|
~~~~~~~~~~~~
|
|
@@ -137,3 +137,92 @@ Next Steps
|
|
|
137
137
|
|
|
138
138
|
.. _Kubernetes Engine Product documentation: https://cloud.google.com/kubernetes-engine/
|
|
139
139
|
.. _README: https://github.com/googleapis/google-cloud-python/blob/main/README.rst
|
|
140
|
+
|
|
141
|
+
Logging
|
|
142
|
+
-------
|
|
143
|
+
|
|
144
|
+
This library uses the standard Python :code:`logging` functionality to log some RPC events that could be of interest for debugging and monitoring purposes.
|
|
145
|
+
Note the following:
|
|
146
|
+
|
|
147
|
+
#. Logs may contain sensitive information. Take care to **restrict access to the logs** if they are saved, whether it be on local storage or on Google Cloud Logging.
|
|
148
|
+
#. Google may refine the occurrence, level, and content of various log messages in this library without flagging such changes as breaking. **Do not depend on immutability of the logging events**.
|
|
149
|
+
#. By default, the logging events from this library are not handled. You must **explicitly configure log handling** using one of the mechanisms below.
|
|
150
|
+
|
|
151
|
+
Simple, environment-based configuration
|
|
152
|
+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
153
|
+
|
|
154
|
+
To enable logging for this library without any changes in your code, set the :code:`GOOGLE_SDK_PYTHON_LOGGING_SCOPE` environment variable to a valid Google
|
|
155
|
+
logging scope. This configures handling of logging events (at level :code:`logging.DEBUG` or higher) from this library in a default manner, emitting the logged
|
|
156
|
+
messages in a structured format. It does not currently allow customizing the logging levels captured nor the handlers, formatters, etc. used for any logging
|
|
157
|
+
event.
|
|
158
|
+
|
|
159
|
+
A logging scope is a period-separated namespace that begins with :code:`google`, identifying the Python module or package to log.
|
|
160
|
+
|
|
161
|
+
- Valid logging scopes: :code:`google`, :code:`google.cloud.asset.v1`, :code:`google.api`, :code:`google.auth`, etc.
|
|
162
|
+
- Invalid logging scopes: :code:`foo`, :code:`123`, etc.
|
|
163
|
+
|
|
164
|
+
**NOTE**: If the logging scope is invalid, the library does not set up any logging handlers.
|
|
165
|
+
|
|
166
|
+
Environment-Based Examples
|
|
167
|
+
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
168
|
+
|
|
169
|
+
- Enabling the default handler for all Google-based loggers
|
|
170
|
+
|
|
171
|
+
.. code-block:: console
|
|
172
|
+
|
|
173
|
+
export GOOGLE_SDK_PYTHON_LOGGING_SCOPE=google
|
|
174
|
+
|
|
175
|
+
- Enabling the default handler for a specific Google module (for a client library called :code:`library_v1`):
|
|
176
|
+
|
|
177
|
+
.. code-block:: console
|
|
178
|
+
|
|
179
|
+
export GOOGLE_SDK_PYTHON_LOGGING_SCOPE=google.cloud.library_v1
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
Advanced, code-based configuration
|
|
183
|
+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
184
|
+
|
|
185
|
+
You can also configure a valid logging scope using Python's standard `logging` mechanism.
|
|
186
|
+
|
|
187
|
+
Code-Based Examples
|
|
188
|
+
^^^^^^^^^^^^^^^^^^^
|
|
189
|
+
|
|
190
|
+
- Configuring a handler for all Google-based loggers
|
|
191
|
+
|
|
192
|
+
.. code-block:: python
|
|
193
|
+
|
|
194
|
+
import logging
|
|
195
|
+
|
|
196
|
+
from google.cloud.translate_v3 import translate
|
|
197
|
+
|
|
198
|
+
base_logger = logging.getLogger("google")
|
|
199
|
+
base_logger.addHandler(logging.StreamHandler())
|
|
200
|
+
base_logger.setLevel(logging.DEBUG)
|
|
201
|
+
|
|
202
|
+
- Configuring a handler for a specific Google module (for a client library called :code:`library_v1`):
|
|
203
|
+
|
|
204
|
+
.. code-block:: python
|
|
205
|
+
|
|
206
|
+
import logging
|
|
207
|
+
|
|
208
|
+
from google.cloud.translate_v3 import translate
|
|
209
|
+
|
|
210
|
+
base_logger = logging.getLogger("google.cloud.library_v1")
|
|
211
|
+
base_logger.addHandler(logging.StreamHandler())
|
|
212
|
+
base_logger.setLevel(logging.DEBUG)
|
|
213
|
+
|
|
214
|
+
Logging details
|
|
215
|
+
~~~~~~~~~~~~~~~
|
|
216
|
+
|
|
217
|
+
#. Regardless of which of the mechanisms above you use to configure logging for this library, by default logging events are not propagated up to the root
|
|
218
|
+
logger from the `google`-level logger. If you need the events to be propagated to the root logger, you must explicitly set
|
|
219
|
+
:code:`logging.getLogger("google").propagate = True` in your code.
|
|
220
|
+
#. You can mix the different logging configurations above for different Google modules. For example, you may want use a code-based logging configuration for
|
|
221
|
+
one library, but decide you need to also set up environment-based logging configuration for another library.
|
|
222
|
+
|
|
223
|
+
#. If you attempt to use both code-based and environment-based configuration for the same module, the environment-based configuration will be ineffectual
|
|
224
|
+
if the code -based configuration gets applied first.
|
|
225
|
+
|
|
226
|
+
#. The Google-specific logging configurations (default handlers for environment-based configuration; not propagating logging events to the root logger) get
|
|
227
|
+
executed the first time *any* client library is instantiated in your application, and only if the affected loggers have not been previously configured.
|
|
228
|
+
(This is the reason for 2.i. above.)
|
|
@@ -0,0 +1,197 @@
|
|
|
1
|
+
Python Client for Kubernetes Engine
|
|
2
|
+
===================================
|
|
3
|
+
|
|
4
|
+
|stable| |pypi| |versions|
|
|
5
|
+
|
|
6
|
+
`Kubernetes Engine`_: The Google Kubernetes Engine API is used for building and managing container based applications, powered by the open source Kubernetes technology.
|
|
7
|
+
|
|
8
|
+
- `Client Library Documentation`_
|
|
9
|
+
- `Product Documentation`_
|
|
10
|
+
|
|
11
|
+
.. |stable| image:: https://img.shields.io/badge/support-stable-gold.svg
|
|
12
|
+
:target: https://github.com/googleapis/google-cloud-python/blob/main/README.rst#stability-levels
|
|
13
|
+
.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-container.svg
|
|
14
|
+
:target: https://pypi.org/project/google-cloud-container/
|
|
15
|
+
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-container.svg
|
|
16
|
+
:target: https://pypi.org/project/google-cloud-container/
|
|
17
|
+
.. _Kubernetes Engine: https://cloud.google.com/kubernetes-engine/
|
|
18
|
+
.. _Client Library Documentation: https://cloud.google.com/python/docs/reference/container/latest/summary_overview
|
|
19
|
+
.. _Product Documentation: https://cloud.google.com/kubernetes-engine/
|
|
20
|
+
|
|
21
|
+
Quick Start
|
|
22
|
+
-----------
|
|
23
|
+
|
|
24
|
+
In order to use this library, you first need to go through the following steps:
|
|
25
|
+
|
|
26
|
+
1. `Select or create a Cloud Platform project.`_
|
|
27
|
+
2. `Enable billing for your project.`_
|
|
28
|
+
3. `Enable the Kubernetes Engine.`_
|
|
29
|
+
4. `Set up Authentication.`_
|
|
30
|
+
|
|
31
|
+
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
|
|
32
|
+
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
|
|
33
|
+
.. _Enable the Kubernetes Engine.: https://cloud.google.com/kubernetes-engine/
|
|
34
|
+
.. _Set up Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
|
|
35
|
+
|
|
36
|
+
Installation
|
|
37
|
+
~~~~~~~~~~~~
|
|
38
|
+
|
|
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.
|
|
43
|
+
|
|
44
|
+
With `venv`_, it's possible to install this library without needing system
|
|
45
|
+
install permissions, and without clashing with the installed system
|
|
46
|
+
dependencies.
|
|
47
|
+
|
|
48
|
+
.. _`venv`: https://docs.python.org/3/library/venv.html
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
Code samples and snippets
|
|
52
|
+
~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
53
|
+
|
|
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-container/samples
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
Supported Python Versions
|
|
60
|
+
^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
61
|
+
Our client libraries are compatible with all current `active`_ and `maintenance`_ versions of
|
|
62
|
+
Python.
|
|
63
|
+
|
|
64
|
+
Python >= 3.7
|
|
65
|
+
|
|
66
|
+
.. _active: https://devguide.python.org/devcycle/#in-development-main-branch
|
|
67
|
+
.. _maintenance: https://devguide.python.org/devcycle/#maintenance-branches
|
|
68
|
+
|
|
69
|
+
Unsupported Python Versions
|
|
70
|
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
71
|
+
Python <= 3.6
|
|
72
|
+
|
|
73
|
+
If you are using an `end-of-life`_
|
|
74
|
+
version of Python, we recommend that you update as soon as possible to an actively supported version.
|
|
75
|
+
|
|
76
|
+
.. _end-of-life: https://devguide.python.org/devcycle/#end-of-life-branches
|
|
77
|
+
|
|
78
|
+
Mac/Linux
|
|
79
|
+
^^^^^^^^^
|
|
80
|
+
|
|
81
|
+
.. code-block:: console
|
|
82
|
+
|
|
83
|
+
python3 -m venv <your-env>
|
|
84
|
+
source <your-env>/bin/activate
|
|
85
|
+
pip install google-cloud-container
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
Windows
|
|
89
|
+
^^^^^^^
|
|
90
|
+
|
|
91
|
+
.. code-block:: console
|
|
92
|
+
|
|
93
|
+
py -m venv <your-env>
|
|
94
|
+
.\<your-env>\Scripts\activate
|
|
95
|
+
pip install google-cloud-container
|
|
96
|
+
|
|
97
|
+
Next Steps
|
|
98
|
+
~~~~~~~~~~
|
|
99
|
+
|
|
100
|
+
- Read the `Client Library Documentation`_ for Kubernetes Engine
|
|
101
|
+
to see other available methods on the client.
|
|
102
|
+
- Read the `Kubernetes Engine Product documentation`_ to learn
|
|
103
|
+
more about the product and see How-to Guides.
|
|
104
|
+
- View this `README`_ to see the full list of Cloud
|
|
105
|
+
APIs that we cover.
|
|
106
|
+
|
|
107
|
+
.. _Kubernetes Engine Product documentation: https://cloud.google.com/kubernetes-engine/
|
|
108
|
+
.. _README: https://github.com/googleapis/google-cloud-python/blob/main/README.rst
|
|
109
|
+
|
|
110
|
+
Logging
|
|
111
|
+
-------
|
|
112
|
+
|
|
113
|
+
This library uses the standard Python :code:`logging` functionality to log some RPC events that could be of interest for debugging and monitoring purposes.
|
|
114
|
+
Note the following:
|
|
115
|
+
|
|
116
|
+
#. Logs may contain sensitive information. Take care to **restrict access to the logs** if they are saved, whether it be on local storage or on Google Cloud Logging.
|
|
117
|
+
#. Google may refine the occurrence, level, and content of various log messages in this library without flagging such changes as breaking. **Do not depend on immutability of the logging events**.
|
|
118
|
+
#. By default, the logging events from this library are not handled. You must **explicitly configure log handling** using one of the mechanisms below.
|
|
119
|
+
|
|
120
|
+
Simple, environment-based configuration
|
|
121
|
+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
122
|
+
|
|
123
|
+
To enable logging for this library without any changes in your code, set the :code:`GOOGLE_SDK_PYTHON_LOGGING_SCOPE` environment variable to a valid Google
|
|
124
|
+
logging scope. This configures handling of logging events (at level :code:`logging.DEBUG` or higher) from this library in a default manner, emitting the logged
|
|
125
|
+
messages in a structured format. It does not currently allow customizing the logging levels captured nor the handlers, formatters, etc. used for any logging
|
|
126
|
+
event.
|
|
127
|
+
|
|
128
|
+
A logging scope is a period-separated namespace that begins with :code:`google`, identifying the Python module or package to log.
|
|
129
|
+
|
|
130
|
+
- Valid logging scopes: :code:`google`, :code:`google.cloud.asset.v1`, :code:`google.api`, :code:`google.auth`, etc.
|
|
131
|
+
- Invalid logging scopes: :code:`foo`, :code:`123`, etc.
|
|
132
|
+
|
|
133
|
+
**NOTE**: If the logging scope is invalid, the library does not set up any logging handlers.
|
|
134
|
+
|
|
135
|
+
Environment-Based Examples
|
|
136
|
+
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
137
|
+
|
|
138
|
+
- Enabling the default handler for all Google-based loggers
|
|
139
|
+
|
|
140
|
+
.. code-block:: console
|
|
141
|
+
|
|
142
|
+
export GOOGLE_SDK_PYTHON_LOGGING_SCOPE=google
|
|
143
|
+
|
|
144
|
+
- Enabling the default handler for a specific Google module (for a client library called :code:`library_v1`):
|
|
145
|
+
|
|
146
|
+
.. code-block:: console
|
|
147
|
+
|
|
148
|
+
export GOOGLE_SDK_PYTHON_LOGGING_SCOPE=google.cloud.library_v1
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
Advanced, code-based configuration
|
|
152
|
+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
153
|
+
|
|
154
|
+
You can also configure a valid logging scope using Python's standard `logging` mechanism.
|
|
155
|
+
|
|
156
|
+
Code-Based Examples
|
|
157
|
+
^^^^^^^^^^^^^^^^^^^
|
|
158
|
+
|
|
159
|
+
- Configuring a handler for all Google-based loggers
|
|
160
|
+
|
|
161
|
+
.. code-block:: python
|
|
162
|
+
|
|
163
|
+
import logging
|
|
164
|
+
|
|
165
|
+
from google.cloud.translate_v3 import translate
|
|
166
|
+
|
|
167
|
+
base_logger = logging.getLogger("google")
|
|
168
|
+
base_logger.addHandler(logging.StreamHandler())
|
|
169
|
+
base_logger.setLevel(logging.DEBUG)
|
|
170
|
+
|
|
171
|
+
- Configuring a handler for a specific Google module (for a client library called :code:`library_v1`):
|
|
172
|
+
|
|
173
|
+
.. code-block:: python
|
|
174
|
+
|
|
175
|
+
import logging
|
|
176
|
+
|
|
177
|
+
from google.cloud.translate_v3 import translate
|
|
178
|
+
|
|
179
|
+
base_logger = logging.getLogger("google.cloud.library_v1")
|
|
180
|
+
base_logger.addHandler(logging.StreamHandler())
|
|
181
|
+
base_logger.setLevel(logging.DEBUG)
|
|
182
|
+
|
|
183
|
+
Logging details
|
|
184
|
+
~~~~~~~~~~~~~~~
|
|
185
|
+
|
|
186
|
+
#. Regardless of which of the mechanisms above you use to configure logging for this library, by default logging events are not propagated up to the root
|
|
187
|
+
logger from the `google`-level logger. If you need the events to be propagated to the root logger, you must explicitly set
|
|
188
|
+
:code:`logging.getLogger("google").propagate = True` in your code.
|
|
189
|
+
#. You can mix the different logging configurations above for different Google modules. For example, you may want use a code-based logging configuration for
|
|
190
|
+
one library, but decide you need to also set up environment-based logging configuration for another library.
|
|
191
|
+
|
|
192
|
+
#. If you attempt to use both code-based and environment-based configuration for the same module, the environment-based configuration will be ineffectual
|
|
193
|
+
if the code -based configuration gets applied first.
|
|
194
|
+
|
|
195
|
+
#. The Google-specific logging configurations (default handlers for environment-based configuration; not propagating logging events to the root logger) get
|
|
196
|
+
executed the first time *any* client library is instantiated in your application, and only if the affected loggers have not been previously configured.
|
|
197
|
+
(This is the reason for 2.i. above.)
|
|
@@ -383,7 +383,10 @@ class ClusterManagerAsyncClient:
|
|
|
383
383
|
# Create or coerce a protobuf request object.
|
|
384
384
|
# - Quick check: If we got a request object, we should *not* have
|
|
385
385
|
# gotten any keyword arguments that map to the request.
|
|
386
|
-
|
|
386
|
+
flattened_params = [project_id, zone, parent]
|
|
387
|
+
has_flattened_params = (
|
|
388
|
+
len([param for param in flattened_params if param is not None]) > 0
|
|
389
|
+
)
|
|
387
390
|
if request is not None and has_flattened_params:
|
|
388
391
|
raise ValueError(
|
|
389
392
|
"If the `request` argument is set, then none of "
|
|
@@ -524,7 +527,10 @@ class ClusterManagerAsyncClient:
|
|
|
524
527
|
# Create or coerce a protobuf request object.
|
|
525
528
|
# - Quick check: If we got a request object, we should *not* have
|
|
526
529
|
# gotten any keyword arguments that map to the request.
|
|
527
|
-
|
|
530
|
+
flattened_params = [project_id, zone, cluster_id, name]
|
|
531
|
+
has_flattened_params = (
|
|
532
|
+
len([param for param in flattened_params if param is not None]) > 0
|
|
533
|
+
)
|
|
528
534
|
if request is not None and has_flattened_params:
|
|
529
535
|
raise ValueError(
|
|
530
536
|
"If the `request` argument is set, then none of "
|
|
@@ -681,7 +687,10 @@ class ClusterManagerAsyncClient:
|
|
|
681
687
|
# Create or coerce a protobuf request object.
|
|
682
688
|
# - Quick check: If we got a request object, we should *not* have
|
|
683
689
|
# gotten any keyword arguments that map to the request.
|
|
684
|
-
|
|
690
|
+
flattened_params = [project_id, zone, cluster, parent]
|
|
691
|
+
has_flattened_params = (
|
|
692
|
+
len([param for param in flattened_params if param is not None]) > 0
|
|
693
|
+
)
|
|
685
694
|
if request is not None and has_flattened_params:
|
|
686
695
|
raise ValueError(
|
|
687
696
|
"If the `request` argument is set, then none of "
|
|
@@ -836,7 +845,10 @@ class ClusterManagerAsyncClient:
|
|
|
836
845
|
# Create or coerce a protobuf request object.
|
|
837
846
|
# - Quick check: If we got a request object, we should *not* have
|
|
838
847
|
# gotten any keyword arguments that map to the request.
|
|
839
|
-
|
|
848
|
+
flattened_params = [project_id, zone, cluster_id, update, name]
|
|
849
|
+
has_flattened_params = (
|
|
850
|
+
len([param for param in flattened_params if param is not None]) > 0
|
|
851
|
+
)
|
|
840
852
|
if request is not None and has_flattened_params:
|
|
841
853
|
raise ValueError(
|
|
842
854
|
"If the `request` argument is set, then none of "
|
|
@@ -1186,8 +1198,9 @@ class ClusterManagerAsyncClient:
|
|
|
1186
1198
|
# Create or coerce a protobuf request object.
|
|
1187
1199
|
# - Quick check: If we got a request object, we should *not* have
|
|
1188
1200
|
# gotten any keyword arguments that map to the request.
|
|
1189
|
-
|
|
1190
|
-
|
|
1201
|
+
flattened_params = [project_id, zone, cluster_id, logging_service, name]
|
|
1202
|
+
has_flattened_params = (
|
|
1203
|
+
len([param for param in flattened_params if param is not None]) > 0
|
|
1191
1204
|
)
|
|
1192
1205
|
if request is not None and has_flattened_params:
|
|
1193
1206
|
raise ValueError(
|
|
@@ -1362,8 +1375,9 @@ class ClusterManagerAsyncClient:
|
|
|
1362
1375
|
# Create or coerce a protobuf request object.
|
|
1363
1376
|
# - Quick check: If we got a request object, we should *not* have
|
|
1364
1377
|
# gotten any keyword arguments that map to the request.
|
|
1365
|
-
|
|
1366
|
-
|
|
1378
|
+
flattened_params = [project_id, zone, cluster_id, monitoring_service, name]
|
|
1379
|
+
has_flattened_params = (
|
|
1380
|
+
len([param for param in flattened_params if param is not None]) > 0
|
|
1367
1381
|
)
|
|
1368
1382
|
if request is not None and has_flattened_params:
|
|
1369
1383
|
raise ValueError(
|
|
@@ -1522,7 +1536,10 @@ class ClusterManagerAsyncClient:
|
|
|
1522
1536
|
# Create or coerce a protobuf request object.
|
|
1523
1537
|
# - Quick check: If we got a request object, we should *not* have
|
|
1524
1538
|
# gotten any keyword arguments that map to the request.
|
|
1525
|
-
|
|
1539
|
+
flattened_params = [project_id, zone, cluster_id, addons_config, name]
|
|
1540
|
+
has_flattened_params = (
|
|
1541
|
+
len([param for param in flattened_params if param is not None]) > 0
|
|
1542
|
+
)
|
|
1526
1543
|
if request is not None and has_flattened_params:
|
|
1527
1544
|
raise ValueError(
|
|
1528
1545
|
"If the `request` argument is set, then none of "
|
|
@@ -1693,7 +1710,10 @@ class ClusterManagerAsyncClient:
|
|
|
1693
1710
|
# Create or coerce a protobuf request object.
|
|
1694
1711
|
# - Quick check: If we got a request object, we should *not* have
|
|
1695
1712
|
# gotten any keyword arguments that map to the request.
|
|
1696
|
-
|
|
1713
|
+
flattened_params = [project_id, zone, cluster_id, locations, name]
|
|
1714
|
+
has_flattened_params = (
|
|
1715
|
+
len([param for param in flattened_params if param is not None]) > 0
|
|
1716
|
+
)
|
|
1697
1717
|
if request is not None and has_flattened_params:
|
|
1698
1718
|
raise ValueError(
|
|
1699
1719
|
"If the `request` argument is set, then none of "
|
|
@@ -1866,7 +1886,10 @@ class ClusterManagerAsyncClient:
|
|
|
1866
1886
|
# Create or coerce a protobuf request object.
|
|
1867
1887
|
# - Quick check: If we got a request object, we should *not* have
|
|
1868
1888
|
# gotten any keyword arguments that map to the request.
|
|
1869
|
-
|
|
1889
|
+
flattened_params = [project_id, zone, cluster_id, master_version, name]
|
|
1890
|
+
has_flattened_params = (
|
|
1891
|
+
len([param for param in flattened_params if param is not None]) > 0
|
|
1892
|
+
)
|
|
1870
1893
|
if request is not None and has_flattened_params:
|
|
1871
1894
|
raise ValueError(
|
|
1872
1895
|
"If the `request` argument is set, then none of "
|
|
@@ -2115,7 +2138,10 @@ class ClusterManagerAsyncClient:
|
|
|
2115
2138
|
# Create or coerce a protobuf request object.
|
|
2116
2139
|
# - Quick check: If we got a request object, we should *not* have
|
|
2117
2140
|
# gotten any keyword arguments that map to the request.
|
|
2118
|
-
|
|
2141
|
+
flattened_params = [project_id, zone, cluster_id, name]
|
|
2142
|
+
has_flattened_params = (
|
|
2143
|
+
len([param for param in flattened_params if param is not None]) > 0
|
|
2144
|
+
)
|
|
2119
2145
|
if request is not None and has_flattened_params:
|
|
2120
2146
|
raise ValueError(
|
|
2121
2147
|
"If the `request` argument is set, then none of "
|
|
@@ -2253,7 +2279,10 @@ class ClusterManagerAsyncClient:
|
|
|
2253
2279
|
# Create or coerce a protobuf request object.
|
|
2254
2280
|
# - Quick check: If we got a request object, we should *not* have
|
|
2255
2281
|
# gotten any keyword arguments that map to the request.
|
|
2256
|
-
|
|
2282
|
+
flattened_params = [project_id, zone, parent]
|
|
2283
|
+
has_flattened_params = (
|
|
2284
|
+
len([param for param in flattened_params if param is not None]) > 0
|
|
2285
|
+
)
|
|
2257
2286
|
if request is not None and has_flattened_params:
|
|
2258
2287
|
raise ValueError(
|
|
2259
2288
|
"If the `request` argument is set, then none of "
|
|
@@ -2397,7 +2426,10 @@ class ClusterManagerAsyncClient:
|
|
|
2397
2426
|
# Create or coerce a protobuf request object.
|
|
2398
2427
|
# - Quick check: If we got a request object, we should *not* have
|
|
2399
2428
|
# gotten any keyword arguments that map to the request.
|
|
2400
|
-
|
|
2429
|
+
flattened_params = [project_id, zone, operation_id, name]
|
|
2430
|
+
has_flattened_params = (
|
|
2431
|
+
len([param for param in flattened_params if param is not None]) > 0
|
|
2432
|
+
)
|
|
2401
2433
|
if request is not None and has_flattened_params:
|
|
2402
2434
|
raise ValueError(
|
|
2403
2435
|
"If the `request` argument is set, then none of "
|
|
@@ -2532,7 +2564,10 @@ class ClusterManagerAsyncClient:
|
|
|
2532
2564
|
# Create or coerce a protobuf request object.
|
|
2533
2565
|
# - Quick check: If we got a request object, we should *not* have
|
|
2534
2566
|
# gotten any keyword arguments that map to the request.
|
|
2535
|
-
|
|
2567
|
+
flattened_params = [project_id, zone, operation_id, name]
|
|
2568
|
+
has_flattened_params = (
|
|
2569
|
+
len([param for param in flattened_params if param is not None]) > 0
|
|
2570
|
+
)
|
|
2536
2571
|
if request is not None and has_flattened_params:
|
|
2537
2572
|
raise ValueError(
|
|
2538
2573
|
"If the `request` argument is set, then none of "
|
|
@@ -2664,7 +2699,10 @@ class ClusterManagerAsyncClient:
|
|
|
2664
2699
|
# Create or coerce a protobuf request object.
|
|
2665
2700
|
# - Quick check: If we got a request object, we should *not* have
|
|
2666
2701
|
# gotten any keyword arguments that map to the request.
|
|
2667
|
-
|
|
2702
|
+
flattened_params = [project_id, zone, name]
|
|
2703
|
+
has_flattened_params = (
|
|
2704
|
+
len([param for param in flattened_params if param is not None]) > 0
|
|
2705
|
+
)
|
|
2668
2706
|
if request is not None and has_flattened_params:
|
|
2669
2707
|
raise ValueError(
|
|
2670
2708
|
"If the `request` argument is set, then none of "
|
|
@@ -2896,7 +2934,10 @@ class ClusterManagerAsyncClient:
|
|
|
2896
2934
|
# Create or coerce a protobuf request object.
|
|
2897
2935
|
# - Quick check: If we got a request object, we should *not* have
|
|
2898
2936
|
# gotten any keyword arguments that map to the request.
|
|
2899
|
-
|
|
2937
|
+
flattened_params = [project_id, zone, cluster_id, parent]
|
|
2938
|
+
has_flattened_params = (
|
|
2939
|
+
len([param for param in flattened_params if param is not None]) > 0
|
|
2940
|
+
)
|
|
2900
2941
|
if request is not None and has_flattened_params:
|
|
2901
2942
|
raise ValueError(
|
|
2902
2943
|
"If the `request` argument is set, then none of "
|
|
@@ -3057,7 +3098,10 @@ class ClusterManagerAsyncClient:
|
|
|
3057
3098
|
# Create or coerce a protobuf request object.
|
|
3058
3099
|
# - Quick check: If we got a request object, we should *not* have
|
|
3059
3100
|
# gotten any keyword arguments that map to the request.
|
|
3060
|
-
|
|
3101
|
+
flattened_params = [project_id, zone, cluster_id, node_pool_id, name]
|
|
3102
|
+
has_flattened_params = (
|
|
3103
|
+
len([param for param in flattened_params if param is not None]) > 0
|
|
3104
|
+
)
|
|
3061
3105
|
if request is not None and has_flattened_params:
|
|
3062
3106
|
raise ValueError(
|
|
3063
3107
|
"If the `request` argument is set, then none of "
|
|
@@ -3211,7 +3255,10 @@ class ClusterManagerAsyncClient:
|
|
|
3211
3255
|
# Create or coerce a protobuf request object.
|
|
3212
3256
|
# - Quick check: If we got a request object, we should *not* have
|
|
3213
3257
|
# gotten any keyword arguments that map to the request.
|
|
3214
|
-
|
|
3258
|
+
flattened_params = [project_id, zone, cluster_id, node_pool, parent]
|
|
3259
|
+
has_flattened_params = (
|
|
3260
|
+
len([param for param in flattened_params if param is not None]) > 0
|
|
3261
|
+
)
|
|
3215
3262
|
if request is not None and has_flattened_params:
|
|
3216
3263
|
raise ValueError(
|
|
3217
3264
|
"If the `request` argument is set, then none of "
|
|
@@ -3369,7 +3416,10 @@ class ClusterManagerAsyncClient:
|
|
|
3369
3416
|
# Create or coerce a protobuf request object.
|
|
3370
3417
|
# - Quick check: If we got a request object, we should *not* have
|
|
3371
3418
|
# gotten any keyword arguments that map to the request.
|
|
3372
|
-
|
|
3419
|
+
flattened_params = [project_id, zone, cluster_id, node_pool_id, name]
|
|
3420
|
+
has_flattened_params = (
|
|
3421
|
+
len([param for param in flattened_params if param is not None]) > 0
|
|
3422
|
+
)
|
|
3373
3423
|
if request is not None and has_flattened_params:
|
|
3374
3424
|
raise ValueError(
|
|
3375
3425
|
"If the `request` argument is set, then none of "
|
|
@@ -3613,7 +3663,10 @@ class ClusterManagerAsyncClient:
|
|
|
3613
3663
|
# Create or coerce a protobuf request object.
|
|
3614
3664
|
# - Quick check: If we got a request object, we should *not* have
|
|
3615
3665
|
# gotten any keyword arguments that map to the request.
|
|
3616
|
-
|
|
3666
|
+
flattened_params = [project_id, zone, cluster_id, node_pool_id, name]
|
|
3667
|
+
has_flattened_params = (
|
|
3668
|
+
len([param for param in flattened_params if param is not None]) > 0
|
|
3669
|
+
)
|
|
3617
3670
|
if request is not None and has_flattened_params:
|
|
3618
3671
|
raise ValueError(
|
|
3619
3672
|
"If the `request` argument is set, then none of "
|
|
@@ -3954,7 +4007,10 @@ class ClusterManagerAsyncClient:
|
|
|
3954
4007
|
# Create or coerce a protobuf request object.
|
|
3955
4008
|
# - Quick check: If we got a request object, we should *not* have
|
|
3956
4009
|
# gotten any keyword arguments that map to the request.
|
|
3957
|
-
|
|
4010
|
+
flattened_params = [project_id, zone, cluster_id, enabled, name]
|
|
4011
|
+
has_flattened_params = (
|
|
4012
|
+
len([param for param in flattened_params if param is not None]) > 0
|
|
4013
|
+
)
|
|
3958
4014
|
if request is not None and has_flattened_params:
|
|
3959
4015
|
raise ValueError(
|
|
3960
4016
|
"If the `request` argument is set, then none of "
|
|
@@ -4104,7 +4160,10 @@ class ClusterManagerAsyncClient:
|
|
|
4104
4160
|
# Create or coerce a protobuf request object.
|
|
4105
4161
|
# - Quick check: If we got a request object, we should *not* have
|
|
4106
4162
|
# gotten any keyword arguments that map to the request.
|
|
4107
|
-
|
|
4163
|
+
flattened_params = [project_id, zone, cluster_id, name]
|
|
4164
|
+
has_flattened_params = (
|
|
4165
|
+
len([param for param in flattened_params if param is not None]) > 0
|
|
4166
|
+
)
|
|
4108
4167
|
if request is not None and has_flattened_params:
|
|
4109
4168
|
raise ValueError(
|
|
4110
4169
|
"If the `request` argument is set, then none of "
|
|
@@ -4252,7 +4311,10 @@ class ClusterManagerAsyncClient:
|
|
|
4252
4311
|
# Create or coerce a protobuf request object.
|
|
4253
4312
|
# - Quick check: If we got a request object, we should *not* have
|
|
4254
4313
|
# gotten any keyword arguments that map to the request.
|
|
4255
|
-
|
|
4314
|
+
flattened_params = [project_id, zone, cluster_id, name]
|
|
4315
|
+
has_flattened_params = (
|
|
4316
|
+
len([param for param in flattened_params if param is not None]) > 0
|
|
4317
|
+
)
|
|
4256
4318
|
if request is not None and has_flattened_params:
|
|
4257
4319
|
raise ValueError(
|
|
4258
4320
|
"If the `request` argument is set, then none of "
|
|
@@ -4498,7 +4560,10 @@ class ClusterManagerAsyncClient:
|
|
|
4498
4560
|
# Create or coerce a protobuf request object.
|
|
4499
4561
|
# - Quick check: If we got a request object, we should *not* have
|
|
4500
4562
|
# gotten any keyword arguments that map to the request.
|
|
4501
|
-
|
|
4563
|
+
flattened_params = [project_id, zone, cluster_id, network_policy, name]
|
|
4564
|
+
has_flattened_params = (
|
|
4565
|
+
len([param for param in flattened_params if param is not None]) > 0
|
|
4566
|
+
)
|
|
4502
4567
|
if request is not None and has_flattened_params:
|
|
4503
4568
|
raise ValueError(
|
|
4504
4569
|
"If the `request` argument is set, then none of "
|
|
@@ -4656,8 +4721,9 @@ class ClusterManagerAsyncClient:
|
|
|
4656
4721
|
# Create or coerce a protobuf request object.
|
|
4657
4722
|
# - Quick check: If we got a request object, we should *not* have
|
|
4658
4723
|
# gotten any keyword arguments that map to the request.
|
|
4659
|
-
|
|
4660
|
-
|
|
4724
|
+
flattened_params = [project_id, zone, cluster_id, maintenance_policy, name]
|
|
4725
|
+
has_flattened_params = (
|
|
4726
|
+
len([param for param in flattened_params if param is not None]) > 0
|
|
4661
4727
|
)
|
|
4662
4728
|
if request is not None and has_flattened_params:
|
|
4663
4729
|
raise ValueError(
|