Skip to content
This repository was archived by the owner on Sep 5, 2023. It is now read-only.

Commit 17d8096

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
docs: Minor formatting fixes to reference documentation (#214)
* docs: Minor formatting fixes to reference documentation PiperOrigin-RevId: 499362676 Source-Link: googleapis/googleapis@870a5ed Source-Link: https://github.com/googleapis/googleapis-gen/commit/43053623d4fa8285f3d82ec7d8c9b8f8c8495a64 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNDMwNTM2MjNkNGZhODI4NWYzZDgyZWM3ZDhjOWI4ZjhjODQ5NWE2NCJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
1 parent b9be1e2 commit 17d8096

File tree

12 files changed

+120
-115
lines changed

12 files changed

+120
-115
lines changed

‎google/cloud/notebooks_v1/services/managed_notebook_service/async_client.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -657,12 +657,12 @@ async def sample_update_runtime():
657657
658658
Currently, only the following fields can be updated:
659659
660-
- software_config.kernels
661-
- software_config.post_startup_script
662-
- software_config.custom_gpu_driver_path
663-
- software_config.idle_shutdown
664-
- software_config.idle_shutdown_timeout
665-
- software_config.disable_terminal
660+
- ``software_config.kernels``
661+
- ``software_config.post_startup_script``
662+
- ``software_config.custom_gpu_driver_path``
663+
- ``software_config.idle_shutdown``
664+
- ``software_config.idle_shutdown_timeout``
665+
- ``software_config.disable_terminal``
666666
667667
This corresponds to the ``update_mask`` field
668668
on the ``request`` instance; if ``request`` is provided, this

‎google/cloud/notebooks_v1/services/managed_notebook_service/client.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -881,12 +881,12 @@ def sample_update_runtime():
881881
882882
Currently, only the following fields can be updated:
883883
884-
- software_config.kernels
885-
- software_config.post_startup_script
886-
- software_config.custom_gpu_driver_path
887-
- software_config.idle_shutdown
888-
- software_config.idle_shutdown_timeout
889-
- software_config.disable_terminal
884+
- ``software_config.kernels``
885+
- ``software_config.post_startup_script``
886+
- ``software_config.custom_gpu_driver_path``
887+
- ``software_config.idle_shutdown``
888+
- ``software_config.idle_shutdown_timeout``
889+
- ``software_config.disable_terminal``
890890
891891
This corresponds to the ``update_mask`` field
892892
on the ``request`` instance; if ``request`` is provided, this

‎google/cloud/notebooks_v1/types/execution.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -227,22 +227,22 @@ class VertexAIParameters(proto.Message):
227227
Attributes:
228228
network (str):
229229
The full name of the Compute Engine
230-
`network </compute/docs/networks-and-firewalls#networks>`__
230+
`network <https://cloud.google.com/compute/docs/networks-and-firewalls#networks>`__
231231
to which the Job should be peered. For example,
232232
``projects/12345/global/networks/myVPC``.
233233
`Format <https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert>`__
234234
is of the form
235235
``projects/{project}/global/networks/{network}``. Where
236-
{project} is a project number, as in ``12345``, and
237-
{network} is a network name.
236+
``{project}`` is a project number, as in ``12345``, and
237+
``{network}`` is a network name.
238238
239239
Private services access must already be configured for the
240240
network. If left unspecified, the job is not peered with any
241241
network.
242242
env (MutableMapping[str, str]):
243243
Environment variables. At most 100 environment variables can
244244
be specified and unique. Example:
245-
GCP_BUCKET=gs://my-bucket/samples/
245+
``GCP_BUCKET=gs://my-bucket/samples/``
246246
"""
247247

248248
network: str = proto.Field(

‎google/cloud/notebooks_v1/types/instance.py

Lines changed: 38 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -128,12 +128,13 @@ class Instance(proto.Message):
128128
https://www.googleapis.com/auth/compute
129129
machine_type (str):
130130
Required. The `Compute Engine machine
131-
type </compute/docs/machine-types>`__ of this instance.
131+
type <https://cloud.google.com/compute/docs/machine-types>`__
132+
of this instance.
132133
accelerator_config (google.cloud.notebooks_v1.types.Instance.AcceleratorConfig):
133134
The hardware accelerator used on this instance. If you use
134135
accelerators, make sure that your configuration has `enough
135136
vCPUs and memory to support the ``machine_type`` you have
136-
selected </compute/docs/gpus/#gpus-list>`__.
137+
selected <https://cloud.google.com/compute/docs/gpus/#gpus-list>`__.
137138
state (google.cloud.notebooks_v1.types.Instance.State):
138139
Output only. The state of this instance.
139140
install_gpu_driver (bool):
@@ -153,20 +154,20 @@ class Instance(proto.Message):
153154
boot_disk_size_gb (int):
154155
Input only. The size of the boot disk in GB
155156
attached to this instance, up to a maximum of
156-
64000&nbsp;GB (64&nbsp;TB). The minimum
157-
recommended value is 100&nbsp;GB. If not
158-
specified, this defaults to 100.
157+
64000 GB (64 TB). The minimum recommended value
158+
is 100 GB. If not specified, this defaults to
159+
100.
159160
data_disk_type (google.cloud.notebooks_v1.types.Instance.DiskType):
160161
Input only. The type of the data disk attached to this
161162
instance, defaults to standard persistent disk
162163
(``PD_STANDARD``).
163164
data_disk_size_gb (int):
164165
Input only. The size of the data disk in GB
165166
attached to this instance, up to a maximum of
166-
64000&nbsp;GB (64&nbsp;TB). You can choose the
167-
size of the data disk based on how big your
168-
notebooks and data are. If not specified, this
169-
defaults to 100.
167+
64000 GB (64 TB). You can choose the size of the
168+
data disk based on how big your notebooks and
169+
data are. If not specified, this defaults to
170+
100.
170171
no_remove_data_disk (bool):
171172
Input only. If true, the data disk will not
172173
be auto deleted when deleting the instance.
@@ -287,8 +288,8 @@ class NicType(proto.Enum):
287288
class AcceleratorConfig(proto.Message):
288289
r"""Definition of a hardware accelerator. Note that not all combinations
289290
of ``type`` and ``core_count`` are valid. Check `GPUs on Compute
290-
Engine </compute/docs/gpus/#gpus-list>`__ to find a valid
291-
combination. TPUs are not supported.
291+
Engine <https://cloud.google.com/compute/docs/gpus/#gpus-list>`__ to
292+
find a valid combination. TPUs are not supported.
292293
293294
Attributes:
294295
type_ (google.cloud.notebooks_v1.types.Instance.AcceleratorType):
@@ -322,10 +323,10 @@ class Disk(proto.Message):
322323
the disk for its root filesystem.
323324
device_name (str):
324325
Indicates a unique device name of your choice that is
325-
reflected into the /dev/disk/by-id/google-\* tree of a Linux
326-
operating system running within the instance. This name can
327-
be used to reference the device for mounting, resizing, and
328-
so on, from within the instance.
326+
reflected into the ``/dev/disk/by-id/google-*`` tree of a
327+
Linux operating system running within the instance. This
328+
name can be used to reference the device for mounting,
329+
resizing, and so on, from within the instance.
329330
330331
If not specified, the server chooses a default device name
331332
to apply to this disk, in the form persistent-disk-x, where
@@ -353,8 +354,8 @@ class Disk(proto.Message):
353354
For performance characteristics of SCSI over NVMe, see Local
354355
SSD performance. Valid values:
355356
356-
- NVME
357-
- SCSI
357+
- ``NVME``
358+
- ``SCSI``
358359
kind (str):
359360
Type of the resource. Always
360361
compute#attachedDisk for attached disks.
@@ -364,21 +365,21 @@ class Disk(proto.Message):
364365
and aggregate usage data for public and
365366
marketplace images.
366367
mode (str):
367-
The mode in which to attach this disk, either READ_WRITE or
368-
READ_ONLY. If not specified, the default is to attach the
369-
disk in READ_WRITE mode. Valid values:
368+
The mode in which to attach this disk, either ``READ_WRITE``
369+
or ``READ_ONLY``. If not specified, the default is to attach
370+
the disk in ``READ_WRITE`` mode. Valid values:
370371
371-
- READ_ONLY
372-
- READ_WRITE
372+
- ``READ_ONLY``
373+
- ``READ_WRITE``
373374
source (str):
374375
Indicates a valid partial or full URL to an
375376
existing Persistent Disk resource.
376377
type_ (str):
377-
Indicates the type of the disk, either SCRATCH or
378-
PERSISTENT. Valid values:
378+
Indicates the type of the disk, either ``SCRATCH`` or
379+
``PERSISTENT``. Valid values:
379380
380-
- PERSISTENT
381-
- SCRATCH
381+
- ``PERSISTENT``
382+
- ``SCRATCH``
382383
"""
383384

384385
class GuestOsFeature(proto.Message):
@@ -390,12 +391,12 @@ class GuestOsFeature(proto.Message):
390391
system features to see a list of available options. Valid
391392
values:
392393
393-
- FEATURE_TYPE_UNSPECIFIED
394-
- MULTI_IP_SUBNET
395-
- SECURE_BOOT
396-
- UEFI_COMPATIBLE
397-
- VIRTIO_SCSI_MULTIQUEUE
398-
- WINDOWS
394+
- ``FEATURE_TYPE_UNSPECIFIED``
395+
- ``MULTI_IP_SUBNET``
396+
- ``SECURE_BOOT``
397+
- ``UEFI_COMPATIBLE``
398+
- ``VIRTIO_SCSI_MULTIQUEUE``
399+
- ``WINDOWS``
399400
"""
400401

401402
type_: str = proto.Field(
@@ -456,8 +457,10 @@ class GuestOsFeature(proto.Message):
456457
)
457458

458459
class ShieldedInstanceConfig(proto.Message):
459-
r"""A set of Shielded Instance options. Check [Images using supported
460-
Shielded VM features] Not all combinations are valid.
460+
r"""A set of Shielded Instance options. Check `Images using supported
461+
Shielded VM
462+
features <https://cloud.google.com/compute/docs/instances/modifying-shielded-vm>`__.
463+
Not all combinations are valid.
461464
462465
Attributes:
463466
enable_secure_boot (bool):
@@ -520,7 +523,7 @@ class UpgradeHistoryEntry(proto.Message):
520523
entry is created.
521524
target_image (str):
522525
Target VM Image. Format:
523-
ainotebooks-vm/project/image-name/name.
526+
``ainotebooks-vm/project/image-name/name``.
524527
action (google.cloud.notebooks_v1.types.Instance.UpgradeHistoryEntry.Action):
525528
Action. Rolloback or Upgrade.
526529
target_version (str):

‎google/cloud/notebooks_v1/types/managed_service.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ class ListRuntimesResponse(proto.Message):
8585
call.
8686
unreachable (MutableSequence[str]):
8787
Locations that could not be reached. For example,
88-
['us-west1', 'us-central1']. A ListRuntimesResponse will
88+
``['us-west1', 'us-central1']``. A ListRuntimesResponse will
8989
only contain either runtimes or unreachables,
9090
"""
9191

@@ -356,12 +356,12 @@ class UpdateRuntimeRequest(proto.Message):
356356
357357
Currently, only the following fields can be updated:
358358
359-
- software_config.kernels
360-
- software_config.post_startup_script
361-
- software_config.custom_gpu_driver_path
362-
- software_config.idle_shutdown
363-
- software_config.idle_shutdown_timeout
364-
- software_config.disable_terminal
359+
- ``software_config.kernels``
360+
- ``software_config.post_startup_script``
361+
- ``software_config.custom_gpu_driver_path``
362+
- ``software_config.idle_shutdown``
363+
- ``software_config.idle_shutdown_timeout``
364+
- ``software_config.disable_terminal``
365365
request_id (str):
366366
Idempotent request UUID.
367367
"""

‎google/cloud/notebooks_v1/types/runtime.py

Lines changed: 32 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -220,8 +220,8 @@ class LocalDisk(proto.Message):
220220
device_name (str):
221221
Optional. Output only. Specifies a unique device name of
222222
your choice that is reflected into the
223-
/dev/disk/by-id/google-\* tree of a Linux operating system
224-
running within the instance. This name can be used to
223+
``/dev/disk/by-id/google-*`` tree of a Linux operating
224+
system running within the instance. This name can be used to
225225
reference the device for mounting, resizing, and so on, from
226226
within the instance.
227227
@@ -258,31 +258,31 @@ class LocalDisk(proto.Message):
258258
For performance characteristics of SCSI over NVMe, see Local
259259
SSD performance. Valid values:
260260
261-
- NVME
262-
- SCSI
261+
- ``NVME``
262+
- ``SCSI``
263263
kind (str):
264264
Output only. Type of the resource. Always
265265
compute#attachedDisk for attached disks.
266266
licenses (MutableSequence[str]):
267267
Output only. Any valid publicly visible
268268
licenses.
269269
mode (str):
270-
The mode in which to attach this disk, either READ_WRITE or
271-
READ_ONLY. If not specified, the default is to attach the
272-
disk in READ_WRITE mode. Valid values:
270+
The mode in which to attach this disk, either ``READ_WRITE``
271+
or ``READ_ONLY``. If not specified, the default is to attach
272+
the disk in ``READ_WRITE`` mode. Valid values:
273273
274-
- READ_ONLY
275-
- READ_WRITE
274+
- ``READ_ONLY``
275+
- ``READ_WRITE``
276276
source (str):
277277
Specifies a valid partial or full URL to an
278278
existing Persistent Disk resource.
279279
type_ (str):
280-
Specifies the type of the disk, either SCRATCH or
281-
PERSISTENT. If not specified, the default is PERSISTENT.
282-
Valid values:
280+
Specifies the type of the disk, either ``SCRATCH`` or
281+
``PERSISTENT``. If not specified, the default is
282+
``PERSISTENT``. Valid values:
283283
284-
- PERSISTENT
285-
- SCRATCH
284+
- ``PERSISTENT``
285+
- ``SCRATCH``
286286
"""
287287

288288
class RuntimeGuestOsFeature(proto.Message):
@@ -301,12 +301,12 @@ class RuntimeGuestOsFeature(proto.Message):
301301
302302
Valid values:
303303
304-
- FEATURE_TYPE_UNSPECIFIED
305-
- MULTI_IP_SUBNET
306-
- SECURE_BOOT
307-
- UEFI_COMPATIBLE
308-
- VIRTIO_SCSI_MULTIQUEUE
309-
- WINDOWS
304+
- ``FEATURE_TYPE_UNSPECIFIED``
305+
- ``MULTI_IP_SUBNET``
306+
- ``SECURE_BOOT``
307+
- ``UEFI_COMPATIBLE``
308+
- ``VIRTIO_SCSI_MULTIQUEUE``
309+
- ``WINDOWS``
310310
"""
311311

312312
type_: str = proto.Field(
@@ -776,15 +776,18 @@ class VirtualMachineConfig(proto.Message):
776776
The subnetwork allocation will use the range *name* if it's
777777
assigned.
778778
779-
| Example: managed-notebooks-range-c
780-
PEERING_RANGE_NAME_3=managed-notebooks-range-c gcloud
781-
compute addresses create $PEERING_RANGE_NAME_3
782-
| --global
783-
| --prefix-length=24
784-
| --description="Google Cloud Managed Notebooks Range 24 c"
785-
| --network=$NETWORK
786-
| --addresses=192.168.0.0
787-
| --purpose=VPC_PEERING
779+
Example: managed-notebooks-range-c
780+
781+
::
782+
783+
PEERING_RANGE_NAME_3=managed-notebooks-range-c
784+
gcloud compute addresses create $PEERING_RANGE_NAME_3 \
785+
--global \
786+
--prefix-length=24 \
787+
--description="Google Cloud Managed Notebooks Range 24 c" \
788+
--network=$NETWORK \
789+
--addresses=192.168.0.0 \
790+
--purpose=VPC_PEERING
788791
789792
Field value will be: ``managed-notebooks-range-c``
790793
boot_image (google.cloud.notebooks_v1.types.VirtualMachineConfig.BootImage):

‎google/cloud/notebooks_v1/types/schedule.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,16 +37,16 @@ class Schedule(proto.Message):
3737
``projects/{project_id}/locations/{location}/schedules/{schedule_id}``
3838
display_name (str):
3939
Output only. Display name used for UI purposes. Name can
40-
only contain alphanumeric characters, hyphens '-', and
41-
underscores '_'.
40+
only contain alphanumeric characters, hyphens ``-``, and
41+
underscores ``_``.
4242
description (str):
4343
A brief description of this environment.
4444
state (google.cloud.notebooks_v1.types.Schedule.State):
4545
4646
cron_schedule (str):
4747
Cron-tab formatted schedule by which the job will execute.
4848
Format: minute, hour, day of month, month, day of week, e.g.
49-
0 0 \* \* WED = every Wednesday More examples:
49+
``0 0 * * WED`` = every Wednesday More examples:
5050
https://crontab.guru/examples.html
5151
time_zone (str):
5252
Timezone on which the cron_schedule. The value of this field

‎google/cloud/notebooks_v1/types/service.py

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ class ListInstancesResponse(proto.Message):
190190
call.
191191
unreachable (MutableSequence[str]):
192192
Locations that could not be reached. For example,
193-
['us-west1-a', 'us-central1-b']. A ListInstancesResponse
193+
``['us-west1-a', 'us-central1-b']``. A ListInstancesResponse
194194
will only contain either instances or unreachables,
195195
"""
196196

@@ -681,9 +681,8 @@ class RollbackInstanceRequest(proto.Message):
681681
Required. Format:
682682
``projects/{project_id}/locations/{location}/instances/{instance_id}``
683683
target_snapshot (str):
684-
Required. The snapshot for rollback.
685-
Example:
686-
"projects/test-project/global/snapshots/krwlzipynril".
684+
Required. The snapshot for rollback. Example:
685+
``projects/test-project/global/snapshots/krwlzipynril``.
687686
"""
688687

689688
name: str = proto.Field(
@@ -1040,8 +1039,8 @@ class ListExecutionsRequest(proto.Message):
10401039
used to continue listing from the last result.
10411040
filter (str):
10421041
Filter applied to resulting executions. Currently only
1043-
supports filtering executions by a specified schedule_id.
1044-
Format: ``schedule_id=<Schedule_ID>``
1042+
supports filtering executions by a specified
1043+
``schedule_id``. Format: ``schedule_id=<Schedule_ID>``
10451044
order_by (str):
10461045
Sort by field.
10471046
"""

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy