docs: Minor formatting fixes to reference documentation

PiperOrigin-RevId: 499362676
pull/765/head
Google APIs 2 years ago committed by Copybara-Service
parent c3845dd3b8
commit 870a5ed7e1
  1. 13
      google/cloud/notebooks/v1/execution.proto
  2. 65
      google/cloud/notebooks/v1/instance.proto
  3. 14
      google/cloud/notebooks/v1/managed_service.proto
  4. 51
      google/cloud/notebooks/v1/runtime.proto
  5. 6
      google/cloud/notebooks/v1/schedule.proto
  6. 20
      google/cloud/notebooks/v1/service.proto
  7. 27
      google/cloud/notebooks/v1beta1/instance.proto
  8. 2
      google/cloud/notebooks/v1beta1/service.proto

@ -129,20 +129,21 @@ message ExecutionTemplate {
// Parameters used in Vertex AI JobType executions.
message VertexAIParameters {
// The full name of the Compute Engine
// [network](/compute/docs/networks-and-firewalls#networks) to which the Job
// should be peered. For example, `projects/12345/global/networks/myVPC`.
// [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks)
// to which the Job should be peered. For example,
// `projects/12345/global/networks/myVPC`.
// [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert)
// is of the form `projects/{project}/global/networks/{network}`.
// Where {project} is a project number, as in `12345`, and {network} is a
// network name.
// Where `{project}` is a project number, as in `12345`, and `{network}` is
// a network name.
//
// Private services access must already be configured for the network. If
// left unspecified, the job is not peered with any network.
string network = 1;
// Environment variables.
// At most 100 environment variables can be specified and unique.
// Example: GCP_BUCKET=gs://my-bucket/samples/
// At most 100 environment variables can be specified and unique.
// Example: `GCP_BUCKET=gs://my-bucket/samples/`
map<string, string> env = 2;
}

@ -105,9 +105,9 @@ message Instance {
}
// Definition of a hardware accelerator. Note that not all combinations
// of `type` and `core_count` are valid. Check [GPUs on
// Compute Engine](/compute/docs/gpus/#gpus-list) to find a valid
// combination. TPUs are not supported.
// of `type` and `core_count` are valid. Check [GPUs on Compute
// Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to find a
// valid combination. TPUs are not supported.
message AcceleratorConfig {
// Type of this accelerator.
AcceleratorType type = 1;
@ -194,12 +194,12 @@ message Instance {
// features to see a list of available options.
// Valid values:
//
// * FEATURE_TYPE_UNSPECIFIED
// * MULTI_IP_SUBNET
// * SECURE_BOOT
// * UEFI_COMPATIBLE
// * VIRTIO_SCSI_MULTIQUEUE
// * WINDOWS
// * `FEATURE_TYPE_UNSPECIFIED`
// * `MULTI_IP_SUBNET`
// * `SECURE_BOOT`
// * `UEFI_COMPATIBLE`
// * `VIRTIO_SCSI_MULTIQUEUE`
// * `WINDOWS`
string type = 1;
}
@ -212,9 +212,9 @@ message Instance {
bool boot = 2;
// Indicates a unique device name of your choice that is reflected into the
// /dev/disk/by-id/google-* tree of a Linux operating system running within
// the instance. This name can be used to reference the device for mounting,
// resizing, and so on, from within the instance.
// `/dev/disk/by-id/google-*` tree of a Linux operating system running
// within the instance. This name can be used to reference the device for
// mounting, resizing, and so on, from within the instance.
//
// If not specified, the server chooses a default device name to apply to
// this disk, in the form persistent-disk-x, where x is a number assigned by
@ -242,8 +242,8 @@ message Instance {
// performance.
// Valid values:
//
// * NVME
// * SCSI
// * `NVME`
// * `SCSI`
string interface = 7;
// Type of the resource. Always compute#attachedDisk for attached
@ -255,28 +255,29 @@ message Instance {
// and marketplace images.
repeated string licenses = 9;
// The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If
// not specified, the default is to attach the disk in READ_WRITE mode.
// Valid values:
// The mode in which to attach this disk, either `READ_WRITE` or
// `READ_ONLY`. If not specified, the default is to attach the disk in
// `READ_WRITE` mode. Valid values:
//
// * READ_ONLY
// * READ_WRITE
// * `READ_ONLY`
// * `READ_WRITE`
string mode = 10;
// Indicates a valid partial or full URL to an existing Persistent Disk
// resource.
string source = 11;
// Indicates the type of the disk, either SCRATCH or PERSISTENT.
// Indicates the type of the disk, either `SCRATCH` or `PERSISTENT`.
// Valid values:
//
// * PERSISTENT
// * SCRATCH
// * `PERSISTENT`
// * `SCRATCH`
string type = 12;
}
// A set of Shielded Instance options.
// Check [Images using supported Shielded VM features]
// Check [Images using supported Shielded VM
// features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm).
// Not all combinations are valid.
message ShieldedInstanceConfig {
// Defines whether the instance has Secure Boot enabled.
@ -348,7 +349,7 @@ message Instance {
// The time that this instance upgrade history entry is created.
google.protobuf.Timestamp create_time = 7;
// Target VM Image. Format: ainotebooks-vm/project/image-name/name.
// Target VM Image. Format: `ainotebooks-vm/project/image-name/name`.
string target_image = 8 [deprecated = true];
// Action. Rolloback or Upgrade.
@ -421,14 +422,15 @@ message Instance {
// https://www.googleapis.com/auth/compute
repeated string service_account_scopes = 31 [(google.api.field_behavior) = OPTIONAL];
// Required. The [Compute Engine machine type](/compute/docs/machine-types) of this
// Required. The [Compute Engine machine
// type](https://cloud.google.com/compute/docs/machine-types) of this
// instance.
string machine_type = 8 [(google.api.field_behavior) = REQUIRED];
// The hardware accelerator used on this instance. If you use
// accelerators, make sure that your configuration has
// [enough vCPUs and memory to support the `machine_type` you
// have selected](/compute/docs/gpus/#gpus-list).
// [enough vCPUs and memory to support the `machine_type` you have
// selected](https://cloud.google.com/compute/docs/gpus/#gpus-list).
AcceleratorConfig accelerator_config = 9;
// Output only. The state of this instance.
@ -449,8 +451,8 @@ message Instance {
DiskType boot_disk_type = 13 [(google.api.field_behavior) = INPUT_ONLY];
// Input only. The size of the boot disk in GB attached to this instance, up to a maximum
// of 64000&nbsp;GB (64&nbsp;TB). The minimum recommended value is
// 100&nbsp;GB. If not specified, this defaults to 100.
// of 64000 GB (64 TB). The minimum recommended value is 100 GB. If not
// specified, this defaults to 100.
int64 boot_disk_size_gb = 14 [(google.api.field_behavior) = INPUT_ONLY];
// Input only. The type of the data disk attached to this instance, defaults to
@ -458,9 +460,8 @@ message Instance {
DiskType data_disk_type = 25 [(google.api.field_behavior) = INPUT_ONLY];
// Input only. The size of the data disk in GB attached to this instance, up to a maximum
// of 64000&nbsp;GB (64&nbsp;TB). You can choose the size of the data disk
// based on how big your notebooks and data are. If not specified, this
// defaults to 100.
// of 64000 GB (64 TB). You can choose the size of the data disk based on how
// big your notebooks and data are. If not specified, this defaults to 100.
int64 data_disk_size_gb = 26 [(google.api.field_behavior) = INPUT_ONLY];
// Input only. If true, the data disk will not be auto deleted when deleting the instance.

@ -234,7 +234,7 @@ message ListRuntimesResponse {
string next_page_token = 2;
// Locations that could not be reached. For example,
// ['us-west1', 'us-central1'].
// `['us-west1', 'us-central1']`.
// A ListRuntimesResponse will only contain either runtimes or unreachables,
repeated string unreachable = 3;
}
@ -386,12 +386,12 @@ message UpdateRuntimeRequest {
//
//
// Currently, only the following fields can be updated:
// - software_config.kernels
// - software_config.post_startup_script
// - software_config.custom_gpu_driver_path
// - software_config.idle_shutdown
// - software_config.idle_shutdown_timeout
// - software_config.disable_terminal
// - `software_config.kernels`
// - `software_config.post_startup_script`
// - `software_config.custom_gpu_driver_path`
// - `software_config.idle_shutdown`
// - `software_config.idle_shutdown_timeout`
// - `software_config.disable_terminal`
google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
// Idempotent request UUID.

@ -209,12 +209,12 @@ message LocalDisk {
//
// Valid values:
//
// * FEATURE_TYPE_UNSPECIFIED
// * MULTI_IP_SUBNET
// * SECURE_BOOT
// * UEFI_COMPATIBLE
// * VIRTIO_SCSI_MULTIQUEUE
// * WINDOWS
// * `FEATURE_TYPE_UNSPECIFIED`
// * `MULTI_IP_SUBNET`
// * `SECURE_BOOT`
// * `UEFI_COMPATIBLE`
// * `VIRTIO_SCSI_MULTIQUEUE`
// * `WINDOWS`
string type = 1;
}
@ -228,7 +228,7 @@ message LocalDisk {
// Optional. Output only. Specifies a unique device name
// of your choice that is reflected into the
// /dev/disk/by-id/google-* tree of a Linux operating system running within
// `/dev/disk/by-id/google-*` tree of a Linux operating system running within
// the instance. This name can be used to reference the device for mounting,
// resizing, and so on, from within the instance.
//
@ -262,8 +262,8 @@ message LocalDisk {
// performance characteristics of SCSI over NVMe, see Local SSD performance.
// Valid values:
//
// * NVME
// * SCSI
// * `NVME`
// * `SCSI`
string interface = 7;
// Output only. Type of the resource. Always compute#attachedDisk for attached disks.
@ -272,24 +272,24 @@ message LocalDisk {
// Output only. Any valid publicly visible licenses.
repeated string licenses = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
// The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If
// not specified, the default is to attach the disk in READ_WRITE mode.
// The mode in which to attach this disk, either `READ_WRITE` or `READ_ONLY`.
// If not specified, the default is to attach the disk in `READ_WRITE` mode.
// Valid values:
//
// * READ_ONLY
// * READ_WRITE
// * `READ_ONLY`
// * `READ_WRITE`
string mode = 10;
// Specifies a valid partial or full URL to an existing Persistent Disk
// resource.
string source = 11;
// Specifies the type of the disk, either SCRATCH or PERSISTENT. If not
// specified, the default is PERSISTENT.
// Specifies the type of the disk, either `SCRATCH` or `PERSISTENT`. If not
// specified, the default is `PERSISTENT`.
// Valid values:
//
// * PERSISTENT
// * SCRATCH
// * `PERSISTENT`
// * `SCRATCH`
string type = 12;
}
@ -593,14 +593,15 @@ message VirtualMachineConfig {
// The subnetwork allocation will use the range *name* if it's assigned.
//
// Example: managed-notebooks-range-c
// PEERING_RANGE_NAME_3=managed-notebooks-range-c
// gcloud compute addresses create $PEERING_RANGE_NAME_3 \
// --global \
// --prefix-length=24 \
// --description="Google Cloud Managed Notebooks Range 24 c" \
// --network=$NETWORK \
// --addresses=192.168.0.0 \
// --purpose=VPC_PEERING
//
// PEERING_RANGE_NAME_3=managed-notebooks-range-c
// gcloud compute addresses create $PEERING_RANGE_NAME_3 \
// --global \
// --prefix-length=24 \
// --description="Google Cloud Managed Notebooks Range 24 c" \
// --network=$NETWORK \
// --addresses=192.168.0.0 \
// --purpose=VPC_PEERING
//
// Field value will be: `managed-notebooks-range-c`
string reserved_ip_range = 18 [(google.api.field_behavior) = OPTIONAL];

@ -67,8 +67,8 @@ message Schedule {
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Display name used for UI purposes.
// Name can only contain alphanumeric characters, hyphens '-',
// and underscores '_'.
// Name can only contain alphanumeric characters, hyphens `-`,
// and underscores `_`.
string display_name = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
// A brief description of this environment.
@ -78,7 +78,7 @@ message Schedule {
// Cron-tab formatted schedule by which the job will execute.
// Format: minute, hour, day of month, month, day of week,
// e.g. 0 0 * * WED = every Wednesday
// e.g. `0 0 * * WED` = every Wednesday
// More examples: https://crontab.guru/examples.html
string cron_schedule = 5;

@ -472,7 +472,7 @@ message ListInstancesResponse {
string next_page_token = 2;
// Locations that could not be reached. For example,
// ['us-west1-a', 'us-central1-b'].
// `['us-west1-a', 'us-central1-b']`.
// A ListInstancesResponse will only contain either instances or unreachables,
repeated string unreachable = 3;
}
@ -700,13 +700,13 @@ message GetInstanceHealthResponse {
// Output only. Additional information about instance health.
// Example:
// healthInfo": {
// "docker_proxy_agent_status": "1",
// "docker_status": "1",
// "jupyterlab_api_status": "-1",
// "jupyterlab_status": "-1",
// "updated": "2020-10-18 09:40:03.573409"
// }
// healthInfo": {
// "docker_proxy_agent_status": "1",
// "docker_status": "1",
// "jupyterlab_api_status": "-1",
// "jupyterlab_status": "-1",
// "updated": "2020-10-18 09:40:03.573409"
// }
map<string, string> health_info = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
}
@ -728,7 +728,7 @@ message RollbackInstanceRequest {
string name = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The snapshot for rollback.
// Example: "projects/test-project/global/snapshots/krwlzipynril".
// Example: `projects/test-project/global/snapshots/krwlzipynril`.
string target_snapshot = 2 [(google.api.field_behavior) = REQUIRED];
}
@ -931,7 +931,7 @@ message ListExecutionsRequest {
string page_token = 3;
// Filter applied to resulting executions. Currently only supports filtering
// executions by a specified schedule_id.
// executions by a specified `schedule_id`.
// Format: `schedule_id=<Schedule_ID>`
string filter = 4;

@ -102,9 +102,9 @@ message Instance {
}
// Definition of a hardware accelerator. Note that not all combinations
// of `type` and `core_count` are valid. Check [GPUs on
// Compute Engine](/compute/docs/gpus/#gpus-list) to find a valid
// combination. TPUs are not supported.
// of `type` and `core_count` are valid. Check [GPUs on Compute
// Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to find a
// valid combination. TPUs are not supported.
message AcceleratorConfig {
// Type of this accelerator.
AcceleratorType type = 1;
@ -208,7 +208,7 @@ message Instance {
// Path to a Bash script that automatically runs after a notebook instance
// fully boots up. The path must be a URL or
// Cloud Storage path (gs://path-to-file/file-name).
// Cloud Storage path (`gs://path-to-file/file-name`).
string post_startup_script = 4;
// Output only. The proxy endpoint that is used to access the Jupyter notebook.
@ -231,14 +231,15 @@ message Instance {
// is used.
string service_account = 7;
// Required. The [Compute Engine machine type](/compute/docs/machine-types) of this
// Required. The [Compute Engine machine
// type](https://cloud.google.com/compute/docs/machine-types) of this
// instance.
string machine_type = 8 [(google.api.field_behavior) = REQUIRED];
// The hardware accelerator used on this instance. If you use
// accelerators, make sure that your configuration has
// [enough vCPUs and memory to support the `machine_type` you
// have selected](/compute/docs/gpus/#gpus-list).
// [enough vCPUs and memory to support the `machine_type` you have
// selected](https://cloud.google.com/compute/docs/gpus/#gpus-list).
AcceleratorConfig accelerator_config = 9;
// Output only. The state of this instance.
@ -259,8 +260,8 @@ message Instance {
DiskType boot_disk_type = 13 [(google.api.field_behavior) = INPUT_ONLY];
// Input only. The size of the boot disk in GB attached to this instance, up to a maximum
// of 64000&nbsp;GB (64&nbsp;TB). The minimum recommended value is
// 100&nbsp;GB. If not specified, this defaults to 100.
// of 64000 GB (64 TB). The minimum recommended value is 100 GB. If not
// specified, this defaults to 100.
int64 boot_disk_size_gb = 14 [(google.api.field_behavior) = INPUT_ONLY];
// Input only. The type of the data disk attached to this instance, defaults to
@ -268,9 +269,8 @@ message Instance {
DiskType data_disk_type = 25 [(google.api.field_behavior) = INPUT_ONLY];
// Input only. The size of the data disk in GB attached to this instance, up to a maximum
// of 64000&nbsp;GB (64&nbsp;TB). You can choose the size of the data disk
// based on how big your notebooks and data are. If not specified, this
// defaults to 100.
// of 64000 GB (64 TB). You can choose the size of the data disk based on how
// big your notebooks and data are. If not specified, this defaults to 100.
int64 data_disk_size_gb = 26 [(google.api.field_behavior) = INPUT_ONLY];
// Input only. If true, the data disk will not be auto deleted when deleting the instance.
@ -284,7 +284,8 @@ message Instance {
// Format:
// `projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}`
//
// Learn more about [using your own encryption keys](/kms/docs/quickstart).
// Learn more about [using your own encryption
// keys](https://cloud.google.com/kms/docs/quickstart).
string kms_key = 16 [(google.api.field_behavior) = INPUT_ONLY];
// If true, no public IP will be assigned to this instance.

@ -306,7 +306,7 @@ message ListInstancesResponse {
string next_page_token = 2;
// Locations that could not be reached. For example,
// ['us-west1-a', 'us-central1-b'].
// `['us-west1-a', 'us-central1-b']`.
// A ListInstancesResponse will only contain either instances or unreachables,
repeated string unreachable = 3;
}

Loading…
Cancel
Save