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

Commit

Permalink
docs: Fixed several broken links and formatting issues in the referen…
Browse files Browse the repository at this point in the history 
…ce documentation (#269)

* docs: Fixed several broken links and formatting issues in the reference documentation

PiperOrigin-RevId: 400904467

Source-Link: googleapis/googleapis@701a095

Source-Link: googleapis/googleapis-gen@fb14cf0
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZmIxNGNmMDIzMzI0OTQ0NzU5NzgwMzM3NGI0YmZjNzU3ZDk2NzM1NiJ9

* 🦉 Updates from OwlBot

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>
  • Loading branch information
@gcf-owl-bot
gcf-owl-bot[bot] and gcf-owl-bot[bot] committed Oct 5, 2021
1 parent 9e77a45 commit 609f7e9
Show file tree
Hide file tree
Showing 21 changed files with 248 additions and 246 deletions.
14 changes: 7 additions & 7 deletions proto-google-cloud-notebooks-v1/src/main/java/com/google/cloud/notebooks/v1/Execution.java
View file
Expand Up @@ -571,7 +571,7 @@ public com.google.cloud.notebooks.v1.ExecutionTemplateOrBuilder getExecutionTemp
*
* <pre>
* 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}`
* </pre>
*
* <code>string name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
Expand All @@ -595,7 +595,7 @@ public java.lang.String getName() {
*
* <pre>
* 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}`
* </pre>
*
* <code>string name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
Expand Down Expand Up @@ -1622,7 +1622,7 @@ public com.google.cloud.notebooks.v1.ExecutionTemplate.Builder getExecutionTempl
*
* <pre>
* 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}`
* </pre>
*
* <code>string name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
Expand All @@ -1645,7 +1645,7 @@ public java.lang.String getName() {
*
* <pre>
* 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}`
* </pre>
*
* <code>string name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
Expand All @@ -1668,7 +1668,7 @@ public com.google.protobuf.ByteString getNameBytes() {
*
* <pre>
* 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}`
* </pre>
*
* <code>string name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
Expand All @@ -1690,7 +1690,7 @@ public Builder setName(java.lang.String value) {
*
* <pre>
* 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}`
* </pre>
*
* <code>string name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
Expand All @@ -1708,7 +1708,7 @@ public Builder clearName() {
*
* <pre>
* 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}`
* </pre>
*
* <code>string name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
Expand Down
4 changes: 2 additions & 2 deletions ...le-cloud-notebooks-v1/src/main/java/com/google/cloud/notebooks/v1/ExecutionOrBuilder.java
View file
Expand Up @@ -63,7 +63,7 @@ public interface ExecutionOrBuilder
*
* <pre>
* 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}`
* </pre>
*
* <code>string name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
Expand All @@ -76,7 +76,7 @@ public interface ExecutionOrBuilder
*
* <pre>
* 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}`
* </pre>
*
* <code>string name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
Expand Down
88 changes: 44 additions & 44 deletions ...gle-cloud-notebooks-v1/src/main/java/com/google/cloud/notebooks/v1/ExecutionTemplate.java
View file
Expand Up @@ -1741,7 +1741,7 @@ public interface DataprocParametersOrBuilder
*
* <pre>
* URI for cluster used to run Dataproc execution.
* Format: 'projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}
* Format: `projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}`
* </pre>
*
* <code>string cluster = 1;</code>
Expand All @@ -1754,7 +1754,7 @@ public interface DataprocParametersOrBuilder
*
* <pre>
* URI for cluster used to run Dataproc execution.
* Format: 'projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}
* Format: `projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}`
* </pre>
*
* <code>string cluster = 1;</code>
Expand Down Expand Up @@ -1863,7 +1863,7 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
*
* <pre>
* URI for cluster used to run Dataproc execution.
* Format: 'projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}
* Format: `projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}`
* </pre>
*
* <code>string cluster = 1;</code>
Expand All @@ -1887,7 +1887,7 @@ public java.lang.String getCluster() {
*
* <pre>
* URI for cluster used to run Dataproc execution.
* Format: 'projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}
* Format: `projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}`
* </pre>
*
* <code>string cluster = 1;</code>
Expand Down Expand Up @@ -2244,7 +2244,7 @@ public Builder mergeFrom(
*
* <pre>
* URI for cluster used to run Dataproc execution.
* Format: 'projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}
* Format: `projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}`
* </pre>
*
* <code>string cluster = 1;</code>
Expand All @@ -2267,7 +2267,7 @@ public java.lang.String getCluster() {
*
* <pre>
* URI for cluster used to run Dataproc execution.
* Format: 'projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}
* Format: `projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}`
* </pre>
*
* <code>string cluster = 1;</code>
Expand All @@ -2290,7 +2290,7 @@ public com.google.protobuf.ByteString getClusterBytes() {
*
* <pre>
* URI for cluster used to run Dataproc execution.
* Format: 'projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}
* Format: `projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}`
* </pre>
*
* <code>string cluster = 1;</code>
Expand All @@ -2312,7 +2312,7 @@ public Builder setCluster(java.lang.String value) {
*
* <pre>
* URI for cluster used to run Dataproc execution.
* Format: 'projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}
* Format: `projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}`
* </pre>
*
* <code>string cluster = 1;</code>
Expand All @@ -2330,7 +2330,7 @@ public Builder clearCluster() {
*
* <pre>
* URI for cluster used to run Dataproc execution.
* Format: 'projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}
* Format: `projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}`
* </pre>
*
* <code>string cluster = 1;</code>
Expand Down Expand Up @@ -2804,8 +2804,8 @@ public java.lang.String getLabelsOrThrow(java.lang.String key) {
* <pre>
* 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
* Format: `gs://{project_id}/{folder}/{notebook_file_name}`
* Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb`
* </pre>
*
* <code>string input_notebook_file = 5;</code>
Expand All @@ -2830,8 +2830,8 @@ public java.lang.String getInputNotebookFile() {
* <pre>
* 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
* Format: `gs://{project_id}/{folder}/{notebook_file_name}`
* Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb`
* </pre>
*
* <code>string input_notebook_file = 5;</code>
Expand Down Expand Up @@ -2914,8 +2914,8 @@ public com.google.protobuf.ByteString getContainerImageUriBytes() {
* <pre>
* 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
* Format: `gs://{project_id}/{folder}`
* Ex: `gs://notebook_user/scheduled_notebooks`
* </pre>
*
* <code>string output_notebook_folder = 7;</code>
Expand All @@ -2940,8 +2940,8 @@ public java.lang.String getOutputNotebookFolder() {
* <pre>
* 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
* Format: `gs://{project_id}/{folder}`
* Ex: `gs://notebook_user/scheduled_notebooks`
* </pre>
*
* <code>string output_notebook_folder = 7;</code>
Expand Down Expand Up @@ -2971,7 +2971,7 @@ public com.google.protobuf.ByteString getOutputNotebookFolderBytes() {
* 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
* Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml`
* </pre>
*
* <code>string params_yaml_file = 8;</code>
Expand All @@ -2998,7 +2998,7 @@ public java.lang.String getParamsYamlFile() {
* 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
* Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml`
* </pre>
*
* <code>string params_yaml_file = 8;</code>
Expand Down Expand Up @@ -4628,8 +4628,8 @@ public Builder putAllLabels(java.util.Map<java.lang.String, java.lang.String> va
* <pre>
* 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
* Format: `gs://{project_id}/{folder}/{notebook_file_name}`
* Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb`
* </pre>
*
* <code>string input_notebook_file = 5;</code>
Expand All @@ -4653,8 +4653,8 @@ public java.lang.String getInputNotebookFile() {
* <pre>
* 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
* Format: `gs://{project_id}/{folder}/{notebook_file_name}`
* Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb`
* </pre>
*
* <code>string input_notebook_file = 5;</code>
Expand All @@ -4678,8 +4678,8 @@ public com.google.protobuf.ByteString getInputNotebookFileBytes() {
* <pre>
* 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
* Format: `gs://{project_id}/{folder}/{notebook_file_name}`
* Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb`
* </pre>
*
* <code>string input_notebook_file = 5;</code>
Expand All @@ -4702,8 +4702,8 @@ public Builder setInputNotebookFile(java.lang.String value) {
* <pre>
* 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
* Format: `gs://{project_id}/{folder}/{notebook_file_name}`
* Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb`
* </pre>
*
* <code>string input_notebook_file = 5;</code>
Expand All @@ -4722,8 +4722,8 @@ public Builder clearInputNotebookFile() {
* <pre>
* 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
* Format: `gs://{project_id}/{folder}/{notebook_file_name}`
* Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb`
* </pre>
*
* <code>string input_notebook_file = 5;</code>
Expand Down Expand Up @@ -4870,8 +4870,8 @@ public Builder setContainerImageUriBytes(com.google.protobuf.ByteString value) {
* <pre>
* 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
* Format: `gs://{project_id}/{folder}`
* Ex: `gs://notebook_user/scheduled_notebooks`
* </pre>
*
* <code>string output_notebook_folder = 7;</code>
Expand All @@ -4895,8 +4895,8 @@ public java.lang.String getOutputNotebookFolder() {
* <pre>
* 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
* Format: `gs://{project_id}/{folder}`
* Ex: `gs://notebook_user/scheduled_notebooks`
* </pre>
*
* <code>string output_notebook_folder = 7;</code>
Expand All @@ -4920,8 +4920,8 @@ public com.google.protobuf.ByteString getOutputNotebookFolderBytes() {
* <pre>
* 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
* Format: `gs://{project_id}/{folder}`
* Ex: `gs://notebook_user/scheduled_notebooks`
* </pre>
*
* <code>string output_notebook_folder = 7;</code>
Expand All @@ -4944,8 +4944,8 @@ public Builder setOutputNotebookFolder(java.lang.String value) {
* <pre>
* 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
* Format: `gs://{project_id}/{folder}`
* Ex: `gs://notebook_user/scheduled_notebooks`
* </pre>
*
* <code>string output_notebook_folder = 7;</code>
Expand All @@ -4964,8 +4964,8 @@ public Builder clearOutputNotebookFolder() {
* <pre>
* 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
* Format: `gs://{project_id}/{folder}`
* Ex: `gs://notebook_user/scheduled_notebooks`
* </pre>
*
* <code>string output_notebook_folder = 7;</code>
Expand Down Expand Up @@ -4993,7 +4993,7 @@ public Builder setOutputNotebookFolderBytes(com.google.protobuf.ByteString value
* 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
* Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml`
* </pre>
*
* <code>string params_yaml_file = 8;</code>
Expand All @@ -5019,7 +5019,7 @@ public java.lang.String getParamsYamlFile() {
* 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
* Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml`
* </pre>
*
* <code>string params_yaml_file = 8;</code>
Expand All @@ -5045,7 +5045,7 @@ public com.google.protobuf.ByteString getParamsYamlFileBytes() {
* 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
* Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml`
* </pre>
*
* <code>string params_yaml_file = 8;</code>
Expand All @@ -5070,7 +5070,7 @@ public Builder setParamsYamlFile(java.lang.String value) {
* 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
* Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml`
* </pre>
*
* <code>string params_yaml_file = 8;</code>
Expand All @@ -5091,7 +5091,7 @@ public Builder clearParamsYamlFile() {
* 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
* Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml`
* </pre>
*
* <code>string params_yaml_file = 8;</code>
Expand Down

0 comments on commit 609f7e9

Please sign in to comment.