diff --git a/google/cloud/notebooks_v1/types/execution.py b/google/cloud/notebooks_v1/types/execution.py index 1bb8d40..07768b9 100644 --- a/google/cloud/notebooks_v1/types/execution.py +++ b/google/cloud/notebooks_v1/types/execution.py @@ -91,8 +91,8 @@ class ExecutionTemplate(proto.Message): input_notebook_file (str): Path to the notebook file to execute. Must be in a Google Cloud Storage bucket. Format: - gs://{project_id}/{folder}/{notebook_file_name} Ex: - gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb + ``gs://{project_id}/{folder}/{notebook_file_name}`` Ex: + ``gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb`` container_image_uri (str): Container Image URI to a DLVM Example: 'gcr.io/deeplearning-platform- @@ -103,15 +103,15 @@ class ExecutionTemplate(proto.Message): output_notebook_folder (str): Path to the notebook folder to write to. Must be in a Google Cloud Storage bucket path. Format: - gs://{project_id}/{folder} Ex: - gs://notebook_user/scheduled_notebooks + ``gs://{project_id}/{folder}`` Ex: + ``gs://notebook_user/scheduled_notebooks`` params_yaml_file (str): Parameters to be overridden in the notebook during execution. Ref https://papermill.readthedocs.io/en/latest/usage-parameterize.html on how to specifying parameters in the input notebook and pass them here in an YAML file. Ex: - gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml + ``gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml`` parameters (str): Parameters used within the 'input_notebook_file' notebook. service_account (str): @@ -177,7 +177,7 @@ class DataprocParameters(proto.Message): Attributes: cluster (str): URI for cluster used to run Dataproc execution. Format: - 'projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME} + ``projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}`` """ cluster = proto.Field(proto.STRING, number=1,) @@ -208,7 +208,7 @@ class Execution(proto.Message): spec, region, labels, etc. name (str): Output only. The resource name of the execute. Format: - \`projects/{project_id}/locations/{location}/execution/{execution_id} + ``projects/{project_id}/locations/{location}/execution/{execution_id}`` display_name (str): Output only. Name used for UI purposes. Name can only contain alphanumeric characters and underscores '_'. diff --git a/google/cloud/notebooks_v1/types/instance.py b/google/cloud/notebooks_v1/types/instance.py index 4cd3602..00a6153 100644 --- a/google/cloud/notebooks_v1/types/instance.py +++ b/google/cloud/notebooks_v1/types/instance.py @@ -66,10 +66,9 @@ class Instance(proto.Message): Use a container image to start the notebook instance. post_startup_script (str): - 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). + 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``). proxy_uri (str): Output only. The proxy endpoint that is used to access the Jupyter notebook. @@ -159,9 +158,9 @@ class Instance(proto.Message): Output only. Attached disks to notebook instance. shielded_instance_config (google.cloud.notebooks_v1.types.Instance.ShieldedInstanceConfig): - Optional. Shielded VM configuration. [Images using supported - Shielded VM features] - (https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). + Optional. Shielded VM configuration. `Images using supported + Shielded VM + features `__. no_public_ip (bool): If true, no public IP will be assigned to this instance. diff --git a/google/cloud/notebooks_v1/types/instance_config.py b/google/cloud/notebooks_v1/types/instance_config.py index f7edb43..e76798a 100644 --- a/google/cloud/notebooks_v1/types/instance_config.py +++ b/google/cloud/notebooks_v1/types/instance_config.py @@ -30,7 +30,6 @@ class InstanceConfig(proto.Message): format `__. enable_health_monitoring (bool): Verifies core internal services are running. - More info: go/notebooks-health """ notebook_upgrade_schedule = proto.Field(proto.STRING, number=1,) diff --git a/google/cloud/notebooks_v1/types/runtime.py b/google/cloud/notebooks_v1/types/runtime.py index 1b448e4..64fda82 100644 --- a/google/cloud/notebooks_v1/types/runtime.py +++ b/google/cloud/notebooks_v1/types/runtime.py @@ -384,10 +384,9 @@ class RuntimeSoftwareConfig(proto.Message): GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers. post_startup_script (str): - 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). + 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``). """ notebook_upgrade_schedule = proto.Field(proto.STRING, number=1,) diff --git a/google/cloud/notebooks_v1/types/service.py b/google/cloud/notebooks_v1/types/service.py index 3095f89..c93e08a 100644 --- a/google/cloud/notebooks_v1/types/service.py +++ b/google/cloud/notebooks_v1/types/service.py @@ -589,9 +589,12 @@ class ListSchedulesResponse(proto.Message): listing from the last result in the next list call. unreachable (Sequence[str]): - Schedules that could not be reached. For example, - ['projects/{project_id}/location/{location}/schedules/monthly_digest', - 'projects/{project_id}/location/{location}/schedules/weekly_sentiment']. + Schedules that could not be reached. For example: + + :: + + ['projects/{project_id}/location/{location}/schedules/monthly_digest', + 'projects/{project_id}/location/{location}/schedules/weekly_sentiment'] """ @property @@ -670,7 +673,7 @@ class ListExecutionsRequest(proto.Message): filter (str): Filter applied to resulting executions. Currently only supports filtering executions by a specified schedule_id. - Format: "schedule_id=". + Format: ``schedule_id=`` order_by (str): Sort by field. """ @@ -692,9 +695,12 @@ class ListExecutionsResponse(proto.Message): listing from the last result in the next list call. unreachable (Sequence[str]): - Executions IDs that could not be reached. For example, - ['projects/{project_id}/location/{location}/executions/imagenet_test1', - 'projects/{project_id}/location/{location}/executions/classifier_train1']. + Executions IDs that could not be reached. For example: + + :: + + ['projects/{project_id}/location/{location}/executions/imagenet_test1', + 'projects/{project_id}/location/{location}/executions/classifier_train1'] """ @property