Skip to content

Commit 824a59d

Browse files
author
Google Cloud SDK
committed
regen: Regenerate google-cloud-compute at API commit e1e3efd
fix!: Remove schemas.MachineType.scratchDisks.scratchDisk from config (#1027) The field and type have already been through a deprecation process. This is an intended breaking change. Googlers: see cl/751378213 Source-Link: googleapis/googleapis@e1e3efd
1 parent df1ca13 commit 824a59d

File tree

519 files changed

+6477
-8594
lines changed

Some content is hidden

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

519 files changed

+6477
-8594
lines changed

generator-input/pipeline-state.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2135,7 +2135,7 @@
21352135
"currentVersion": "1.30.0",
21362136
"generationAutomationLevel": "AUTOMATION_LEVEL_AUTOMATIC",
21372137
"releaseAutomationLevel": "AUTOMATION_LEVEL_AUTOMATIC",
2138-
"lastGeneratedCommit": "97a83d76a09a7f6dcab43675c87bdfeb5bcf1cb5",
2138+
"lastGeneratedCommit": "e1e3efd93a705c4e0b937b2f764fa509e7a3af6c",
21392139
"apiPaths": [
21402140
"google/cloud/compute/v1"
21412141
],

packages/google-cloud-compute/.OwlBot.yaml

Lines changed: 0 additions & 24 deletions
This file was deleted.

packages/google-cloud-compute/.repo-metadata.json

Lines changed: 0 additions & 17 deletions
This file was deleted.

packages/google-cloud-compute/CHANGELOG.md

Lines changed: 0 additions & 614 deletions
This file was deleted.

packages/google-cloud-compute/README.rst

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
Python Client for Compute Engine
2-
================================
1+
Python Client for
2+
==================
33

44
|stable| |pypi| |versions|
55

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+
``_:
77
88
- `Client Library Documentation`_
99
- `Product Documentation`_
@@ -14,9 +14,9 @@ Python Client for Compute Engine
1414
:target: https://pypi.org/project/google-cloud-compute/
1515
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-compute.svg
1616
:target: https://pypi.org/project/google-cloud-compute/
17-
.. _Compute Engine: https://cloud.google.com/compute/
17+
.. _:
1818
.. _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:
2020
2121
Quick Start
2222
-----------
@@ -25,12 +25,12 @@ In order to use this library, you first need to go through the following steps:
2525
2626
1. `Select or create a Cloud Platform project.`_
2727
2. `Enable billing for your project.`_
28-
3. `Enable the Compute Engine.`_
28+
3. `Enable the .`_
2929
4. `Set up Authentication.`_
3030
3131
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
3232
.. _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 .:
3434
.. _Set up Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
3535
3636
Installation
@@ -106,14 +106,14 @@ Windows
106106
Next Steps
107107
~~~~~~~~~~
108108

109-
- Read the `Client Library Documentation`_ for Compute Engine
109+
- Read the `Client Library Documentation`_ for
110110
to see other available methods on the client.
111-
- Read the `Compute Engine Product documentation`_ to learn
111+
- Read the ` Product documentation`_ to learn
112112
more about the product and see How-to Guides.
113113
- View this `README`_ to see the full list of Cloud
114114
APIs that we cover.
115115

116-
.. _Compute Engine Product documentation: https://cloud.google.com/compute/
116+
.. _ Product documentation:
117117
.. _README: https://github.com/googleapis/google-cloud-python/blob/main/README.rst
118118

119119
Logging
@@ -170,9 +170,9 @@ Code-Based Examples
170170
.. code-block:: python
171171
172172
import logging
173-
173+
174174
from google.cloud import library_v1
175-
175+
176176
base_logger = logging.getLogger("google")
177177
base_logger.addHandler(logging.StreamHandler())
178178
base_logger.setLevel(logging.DEBUG)
@@ -182,9 +182,9 @@ Code-Based Examples
182182
.. code-block:: python
183183
184184
import logging
185-
185+
186186
from google.cloud import library_v1
187-
187+
188188
base_logger = logging.getLogger("google.cloud.library_v1")
189189
base_logger.addHandler(logging.StreamHandler())
190190
base_logger.setLevel(logging.DEBUG)
-3.53 MB
Binary file not shown.

packages/google-cloud-compute/docs/CHANGELOG.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

packages/google-cloud-compute/docs/README.rst

Lines changed: 0 additions & 1 deletion
This file was deleted.
Lines changed: 197 additions & 0 deletions
Original file line numberDiff line numberDiff 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.)

packages/google-cloud-compute/docs/summary_overview.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ reverted. Instead, if you want to place additional content, create an
55
pick up on the content and merge the content.
66
]: #
77

8-
# Compute Engine API
8+
#
99

10-
Overview of the APIs available for Compute Engine API.
10+
Overview of the APIs available for .
1111

1212
## All entries
1313

1414
Classes, methods and properties & attributes for
15-
Compute Engine API.
15+
.
1616

1717
[classes](https://cloud.google.com/python/docs/reference/compute/latest/summary_class.html)
1818

0 commit comments

Comments
 (0)