| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
1 parent a84b74e commit c6ec87e
420 files changed
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -2135,7 +2135,7 @@ | |||
| 2135 | 2135 | "currentVersion": "1.30.0", | |
| 2136 | 2136 | "generationAutomationLevel": "AUTOMATION_LEVEL_AUTOMATIC", | |
| 2137 | 2137 | "releaseAutomationLevel": "AUTOMATION_LEVEL_AUTOMATIC", | |
| 2138 | - "lastGeneratedCommit": "97a83d76a09a7f6dcab43675c87bdfeb5bcf1cb5", | ||
| 2138 | + "lastGeneratedCommit": "e1e3efd93a705c4e0b937b2f764fa509e7a3af6c", | ||
| 2139 | 2139 | "apiPaths": [ | |
| 2140 | 2140 | "google/cloud/compute/v1" | |
| 2141 | 2141 | ], | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1,9 +1,9 @@ | |||
| 1 | - Python Client for Compute Engine | ||
| 2 | - ================================ | ||
| 1 | + Python Client for | ||
| 2 | + ================== | ||
| 3 | 3 | ||
| 4 | 4 | |stable| |pypi| |versions| | |
| 5 | 5 | ||
| 6 | - `Compute Engine`_: delivers virtual machines running in Google's innovative data centers and worldwide fiber network. Compute Engine's tooling and workflow support enable scaling from single instances to global, load-balanced cloud computing. Compute Engine's VMs boot quickly, come with persistent disk storage, deliver consistent performance and are available in many configurations. | ||
| 6 | + ``_: | ||
| 7 | 7 | ||
| 8 | 8 | - `Client Library Documentation`_ | |
| 9 | 9 | - `Product Documentation`_ | |
@@ -14,9 +14,9 @@ Python Client for Compute Engine | |||
| 14 | 14 | :target: https://pypi.org/project/google-cloud-compute/ | |
| 15 | 15 | .. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-compute.svg | |
| 16 | 16 | :target: https://pypi.org/project/google-cloud-compute/ | |
| 17 | - .. _Compute Engine: https://cloud.google.com/compute/ | ||
| 17 | + .. _: | ||
| 18 | 18 | .. _Client Library Documentation: https://cloud.google.com/python/docs/reference/compute/latest/summary_overview | |
| 19 | - .. _Product Documentation: https://cloud.google.com/compute/ | ||
| 19 | + .. _Product Documentation: | ||
| 20 | 20 | ||
| 21 | 21 | Quick Start | |
| 22 | 22 | ----------- | |
@@ -25,12 +25,12 @@ In order to use this library, you first need to go through the following steps: | |||
| 25 | 25 | ||
| 26 | 26 | 1. `Select or create a Cloud Platform project.`_ | |
| 27 | 27 | 2. `Enable billing for your project.`_ | |
| 28 | - 3. `Enable the Compute Engine.`_ | ||
| 28 | + 3. `Enable the .`_ | ||
| 29 | 29 | 4. `Set up Authentication.`_ | |
| 30 | 30 | ||
| 31 | 31 | .. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project | |
| 32 | 32 | .. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project | |
| 33 | - .. _Enable the Compute Engine.: https://cloud.google.com/compute/ | ||
| 33 | + .. _Enable the .: | ||
| 34 | 34 | .. _Set up Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html | |
| 35 | 35 | ||
| 36 | 36 | Installation | |
@@ -106,14 +106,14 @@ Windows | |||
| 106 | 106 | Next Steps | |
| 107 | 107 | ~~~~~~~~~~ | |
| 108 | 108 | ||
| 109 | - - Read the `Client Library Documentation`_ for Compute Engine | ||
| 109 | + - Read the `Client Library Documentation`_ for | ||
| 110 | 110 | to see other available methods on the client. | |
| 111 | - - Read the `Compute Engine Product documentation`_ to learn | ||
| 111 | + - Read the ` Product documentation`_ to learn | ||
| 112 | 112 | more about the product and see How-to Guides. | |
| 113 | 113 | - View this `README`_ to see the full list of Cloud | |
| 114 | 114 | APIs that we cover. | |
| 115 | 115 | ||
| 116 | - .. _Compute Engine Product documentation: https://cloud.google.com/compute/ | ||
| 116 | + .. _ Product documentation: | ||
| 117 | 117 | .. _README: https://github.com/googleapis/google-cloud-python/blob/main/README.rst | |
| 118 | 118 | ||
| 119 | 119 | Logging | |
@@ -170,9 +170,9 @@ Code-Based Examples | |||
| 170 | 170 | .. code-block:: python | |
| 171 | 171 | ||
| 172 | 172 | import logging | |
| 173 | - | ||
| 173 | + | ||
| 174 | 174 | from google.cloud import library_v1 | |
| 175 | - | ||
| 175 | + | ||
| 176 | 176 | base_logger = logging.getLogger("google") | |
| 177 | 177 | base_logger.addHandler(logging.StreamHandler()) | |
| 178 | 178 | base_logger.setLevel(logging.DEBUG) | |
@@ -182,9 +182,9 @@ Code-Based Examples | |||
| 182 | 182 | .. code-block:: python | |
| 183 | 183 | ||
| 184 | 184 | import logging | |
| 185 | - | ||
| 185 | + | ||
| 186 | 186 | from google.cloud import library_v1 | |
| 187 | - | ||
| 187 | + | ||
| 188 | 188 | base_logger = logging.getLogger("google.cloud.library_v1") | |
| 189 | 189 | base_logger.addHandler(logging.StreamHandler()) | |
| 190 | 190 | base_logger.setLevel(logging.DEBUG) | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -0,0 +1,197 @@ | |||
| 1 | + Python Client for | ||
| 2 | + ================== | ||
| 3 | + | ||
| 4 | + |stable| |pypi| |versions| | ||
| 5 | + | ||
| 6 | + ``_: | ||
| 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-compute.svg | ||
| 14 | + :target: https://pypi.org/project/google-cloud-compute/ | ||
| 15 | + .. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-compute.svg | ||
| 16 | + :target: https://pypi.org/project/google-cloud-compute/ | ||
| 17 | + .. _: | ||
| 18 | + .. _Client Library Documentation: https://cloud.google.com/python/docs/reference/compute/latest/summary_overview | ||
| 19 | + .. _Product Documentation: | ||
| 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 .`_ | ||
| 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 .: | ||
| 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-compute/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-compute | ||
| 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-compute | ||
| 96 | + | ||
| 97 | + Next Steps | ||
| 98 | + ~~~~~~~~~~ | ||
| 99 | + | ||
| 100 | + - Read the `Client Library Documentation`_ for | ||
| 101 | + to see other available methods on the client. | ||
| 102 | + - Read the ` 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 | + .. _ Product documentation: | ||
| 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 import library_v1 | ||
| 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 import library_v1 | ||
| 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.) | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -11,7 +11,6 @@ API Reference | |||
| 11 | 11 | compute_v1/services_ | |
| 12 | 12 | compute_v1/types_ | |
| 13 | 13 | ||
| 14 | - | ||
| 15 | 14 | Changelog | |
| 16 | 15 | --------- | |
| 17 | 16 | ||
| Back | FazBrowse Home | New Git URL |
0 commit comments