Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: [notebooks] fix minor docstring formatting #8846

Merged
merged 2 commits into from
Dec 6, 2022
Merged

docs: [notebooks] fix minor docstring formatting #8846

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0c10944
docs: fix minor docstring formatting
gcf-owl-bot[bot] Nov 28, 2022
da3a0cb
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Nov 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
140 changes: 77 additions & 63 deletions ...ogle-cloud-notebooks-v1/src/main/java/com/google/cloud/notebooks/v1/DiagnosticConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,17 +74,17 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
*
*
* <pre>
* Required. User Cloud Storage bucket location (REQUIRED)
* ## Must be formatted with path prefix (gs://$GCS_BUCKET)
* Required. User Cloud Storage bucket location (REQUIRED).
* Must be formatted with path prefix (`gs://$GCS_BUCKET`).
* Permissions:
* User Managed Notebooks:
* - storage.buckets.writer: Must be given to the project's service account
* attached to VM.
* attached to VM.
* Google Managed Notebooks:
* - storage.buckets.writer: Must be given to the project's service account or
* ## user credentials attached to VM depending on authentication mode.
* user credentials attached to VM depending on authentication mode.
* Cloud Storage bucket Log file will be written to
* gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz
* `gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz`
* </pre>
*
* <code>string gcs_bucket = 1 [(.google.api.field_behavior) = REQUIRED];</code>
Expand All @@ -107,17 +107,17 @@ public java.lang.String getGcsBucket() {
*
*
* <pre>
* Required. User Cloud Storage bucket location (REQUIRED)
* ## Must be formatted with path prefix (gs://$GCS_BUCKET)
* Required. User Cloud Storage bucket location (REQUIRED).
* Must be formatted with path prefix (`gs://$GCS_BUCKET`).
* Permissions:
* User Managed Notebooks:
* - storage.buckets.writer: Must be given to the project's service account
* attached to VM.
* attached to VM.
* Google Managed Notebooks:
* - storage.buckets.writer: Must be given to the project's service account or
* ## user credentials attached to VM depending on authentication mode.
* user credentials attached to VM depending on authentication mode.
* Cloud Storage bucket Log file will be written to
* gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz
* `gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz`
* </pre>
*
* <code>string gcs_bucket = 1 [(.google.api.field_behavior) = REQUIRED];</code>
Expand All @@ -143,10 +143,12 @@ public com.google.protobuf.ByteString getGcsBucketBytes() {
*
*
* <pre>
* Optional. Defines the relative storage path in the Cloud Storage bucket where the
* diagnostic logs will be written: Default path will be the root directory of
* the Cloud Storage bucket (gs://$GCS_BUCKET/$DATE_$TIME.tar.gz) Example of
* full path where Log file will be written: gs://$GCS_BUCKET/$RELATIVE_PATH/
* Optional. Defines the relative storage path in the Cloud Storage bucket
* where the diagnostic logs will be written: Default path will be the root
* directory of the Cloud Storage bucket
* (`gs://$GCS_BUCKET/$DATE_$TIME.tar.gz`)
* Example of full path where Log file will be written:
* `gs://$GCS_BUCKET/$RELATIVE_PATH/`
* </pre>
*
* <code>string relative_path = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
Expand All @@ -169,10 +171,12 @@ public java.lang.String getRelativePath() {
*
*
* <pre>
* Optional. Defines the relative storage path in the Cloud Storage bucket where the
* diagnostic logs will be written: Default path will be the root directory of
* the Cloud Storage bucket (gs://$GCS_BUCKET/$DATE_$TIME.tar.gz) Example of
* full path where Log file will be written: gs://$GCS_BUCKET/$RELATIVE_PATH/
* Optional. Defines the relative storage path in the Cloud Storage bucket
* where the diagnostic logs will be written: Default path will be the root
* directory of the Cloud Storage bucket
* (`gs://$GCS_BUCKET/$DATE_$TIME.tar.gz`)
* Example of full path where Log file will be written:
* `gs://$GCS_BUCKET/$RELATIVE_PATH/`
* </pre>
*
* <code>string relative_path = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
Expand Down Expand Up @@ -665,17 +669,17 @@ public Builder mergeFrom(
*
*
* <pre>
* Required. User Cloud Storage bucket location (REQUIRED)
* ## Must be formatted with path prefix (gs://$GCS_BUCKET)
* Required. User Cloud Storage bucket location (REQUIRED).
* Must be formatted with path prefix (`gs://$GCS_BUCKET`).
* Permissions:
* User Managed Notebooks:
* - storage.buckets.writer: Must be given to the project's service account
* attached to VM.
* attached to VM.
* Google Managed Notebooks:
* - storage.buckets.writer: Must be given to the project's service account or
* ## user credentials attached to VM depending on authentication mode.
* user credentials attached to VM depending on authentication mode.
* Cloud Storage bucket Log file will be written to
* gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz
* `gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz`
* </pre>
*
* <code>string gcs_bucket = 1 [(.google.api.field_behavior) = REQUIRED];</code>
Expand All @@ -697,17 +701,17 @@ public java.lang.String getGcsBucket() {
*
*
* <pre>
* Required. User Cloud Storage bucket location (REQUIRED)
* ## Must be formatted with path prefix (gs://$GCS_BUCKET)
* Required. User Cloud Storage bucket location (REQUIRED).
* Must be formatted with path prefix (`gs://$GCS_BUCKET`).
* Permissions:
* User Managed Notebooks:
* - storage.buckets.writer: Must be given to the project's service account
* attached to VM.
* attached to VM.
* Google Managed Notebooks:
* - storage.buckets.writer: Must be given to the project's service account or
* ## user credentials attached to VM depending on authentication mode.
* user credentials attached to VM depending on authentication mode.
* Cloud Storage bucket Log file will be written to
* gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz
* `gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz`
* </pre>
*
* <code>string gcs_bucket = 1 [(.google.api.field_behavior) = REQUIRED];</code>
Expand All @@ -729,17 +733,17 @@ public com.google.protobuf.ByteString getGcsBucketBytes() {
*
*
* <pre>
* Required. User Cloud Storage bucket location (REQUIRED)
* ## Must be formatted with path prefix (gs://$GCS_BUCKET)
* Required. User Cloud Storage bucket location (REQUIRED).
* Must be formatted with path prefix (`gs://$GCS_BUCKET`).
* Permissions:
* User Managed Notebooks:
* - storage.buckets.writer: Must be given to the project's service account
* attached to VM.
* attached to VM.
* Google Managed Notebooks:
* - storage.buckets.writer: Must be given to the project's service account or
* ## user credentials attached to VM depending on authentication mode.
* user credentials attached to VM depending on authentication mode.
* Cloud Storage bucket Log file will be written to
* gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz
* `gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz`
* </pre>
*
* <code>string gcs_bucket = 1 [(.google.api.field_behavior) = REQUIRED];</code>
Expand All @@ -760,17 +764,17 @@ public Builder setGcsBucket(java.lang.String value) {
*
*
* <pre>
* Required. User Cloud Storage bucket location (REQUIRED)
* ## Must be formatted with path prefix (gs://$GCS_BUCKET)
* Required. User Cloud Storage bucket location (REQUIRED).
* Must be formatted with path prefix (`gs://$GCS_BUCKET`).
* Permissions:
* User Managed Notebooks:
* - storage.buckets.writer: Must be given to the project's service account
* attached to VM.
* attached to VM.
* Google Managed Notebooks:
* - storage.buckets.writer: Must be given to the project's service account or
* ## user credentials attached to VM depending on authentication mode.
* user credentials attached to VM depending on authentication mode.
* Cloud Storage bucket Log file will be written to
* gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz
* `gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz`
* </pre>
*
* <code>string gcs_bucket = 1 [(.google.api.field_behavior) = REQUIRED];</code>
Expand All @@ -787,17 +791,17 @@ public Builder clearGcsBucket() {
*
*
* <pre>
* Required. User Cloud Storage bucket location (REQUIRED)
* ## Must be formatted with path prefix (gs://$GCS_BUCKET)
* Required. User Cloud Storage bucket location (REQUIRED).
* Must be formatted with path prefix (`gs://$GCS_BUCKET`).
* Permissions:
* User Managed Notebooks:
* - storage.buckets.writer: Must be given to the project's service account
* attached to VM.
* attached to VM.
* Google Managed Notebooks:
* - storage.buckets.writer: Must be given to the project's service account or
* ## user credentials attached to VM depending on authentication mode.
* user credentials attached to VM depending on authentication mode.
* Cloud Storage bucket Log file will be written to
* gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz
* `gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz`
* </pre>
*
* <code>string gcs_bucket = 1 [(.google.api.field_behavior) = REQUIRED];</code>
Expand All @@ -821,10 +825,12 @@ public Builder setGcsBucketBytes(com.google.protobuf.ByteString value) {
*
*
* <pre>
* Optional. Defines the relative storage path in the Cloud Storage bucket where the
* diagnostic logs will be written: Default path will be the root directory of
* the Cloud Storage bucket (gs://$GCS_BUCKET/$DATE_$TIME.tar.gz) Example of
* full path where Log file will be written: gs://$GCS_BUCKET/$RELATIVE_PATH/
* Optional. Defines the relative storage path in the Cloud Storage bucket
* where the diagnostic logs will be written: Default path will be the root
* directory of the Cloud Storage bucket
* (`gs://$GCS_BUCKET/$DATE_$TIME.tar.gz`)
* Example of full path where Log file will be written:
* `gs://$GCS_BUCKET/$RELATIVE_PATH/`
* </pre>
*
* <code>string relative_path = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
Expand All @@ -846,10 +852,12 @@ public java.lang.String getRelativePath() {
*
*
* <pre>
* Optional. Defines the relative storage path in the Cloud Storage bucket where the
* diagnostic logs will be written: Default path will be the root directory of
* the Cloud Storage bucket (gs://$GCS_BUCKET/$DATE_$TIME.tar.gz) Example of
* full path where Log file will be written: gs://$GCS_BUCKET/$RELATIVE_PATH/
* Optional. Defines the relative storage path in the Cloud Storage bucket
* where the diagnostic logs will be written: Default path will be the root
* directory of the Cloud Storage bucket
* (`gs://$GCS_BUCKET/$DATE_$TIME.tar.gz`)
* Example of full path where Log file will be written:
* `gs://$GCS_BUCKET/$RELATIVE_PATH/`
* </pre>
*
* <code>string relative_path = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
Expand All @@ -871,10 +879,12 @@ public com.google.protobuf.ByteString getRelativePathBytes() {
*
*
* <pre>
* Optional. Defines the relative storage path in the Cloud Storage bucket where the
* diagnostic logs will be written: Default path will be the root directory of
* the Cloud Storage bucket (gs://$GCS_BUCKET/$DATE_$TIME.tar.gz) Example of
* full path where Log file will be written: gs://$GCS_BUCKET/$RELATIVE_PATH/
* Optional. Defines the relative storage path in the Cloud Storage bucket
* where the diagnostic logs will be written: Default path will be the root
* directory of the Cloud Storage bucket
* (`gs://$GCS_BUCKET/$DATE_$TIME.tar.gz`)
* Example of full path where Log file will be written:
* `gs://$GCS_BUCKET/$RELATIVE_PATH/`
* </pre>
*
* <code>string relative_path = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
Expand All @@ -895,10 +905,12 @@ public Builder setRelativePath(java.lang.String value) {
*
*
* <pre>
* Optional. Defines the relative storage path in the Cloud Storage bucket where the
* diagnostic logs will be written: Default path will be the root directory of
* the Cloud Storage bucket (gs://$GCS_BUCKET/$DATE_$TIME.tar.gz) Example of
* full path where Log file will be written: gs://$GCS_BUCKET/$RELATIVE_PATH/
* Optional. Defines the relative storage path in the Cloud Storage bucket
* where the diagnostic logs will be written: Default path will be the root
* directory of the Cloud Storage bucket
* (`gs://$GCS_BUCKET/$DATE_$TIME.tar.gz`)
* Example of full path where Log file will be written:
* `gs://$GCS_BUCKET/$RELATIVE_PATH/`
* </pre>
*
* <code>string relative_path = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
Expand All @@ -915,10 +927,12 @@ public Builder clearRelativePath() {
*
*
* <pre>
* Optional. Defines the relative storage path in the Cloud Storage bucket where the
* diagnostic logs will be written: Default path will be the root directory of
* the Cloud Storage bucket (gs://$GCS_BUCKET/$DATE_$TIME.tar.gz) Example of
* full path where Log file will be written: gs://$GCS_BUCKET/$RELATIVE_PATH/
* Optional. Defines the relative storage path in the Cloud Storage bucket
* where the diagnostic logs will be written: Default path will be the root
* directory of the Cloud Storage bucket
* (`gs://$GCS_BUCKET/$DATE_$TIME.tar.gz`)
* Example of full path where Log file will be written:
* `gs://$GCS_BUCKET/$RELATIVE_PATH/`
* </pre>
*
* <code>string relative_path = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
Expand Down
40 changes: 22 additions & 18 deletions ...d-notebooks-v1/src/main/java/com/google/cloud/notebooks/v1/DiagnosticConfigOrBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,17 +27,17 @@ public interface DiagnosticConfigOrBuilder
*
*
* <pre>
* Required. User Cloud Storage bucket location (REQUIRED)
* ## Must be formatted with path prefix (gs://$GCS_BUCKET)
* Required. User Cloud Storage bucket location (REQUIRED).
* Must be formatted with path prefix (`gs://$GCS_BUCKET`).
* Permissions:
* User Managed Notebooks:
* - storage.buckets.writer: Must be given to the project's service account
* attached to VM.
* attached to VM.
* Google Managed Notebooks:
* - storage.buckets.writer: Must be given to the project's service account or
* ## user credentials attached to VM depending on authentication mode.
* user credentials attached to VM depending on authentication mode.
* Cloud Storage bucket Log file will be written to
* gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz
* `gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz`
* </pre>
*
* <code>string gcs_bucket = 1 [(.google.api.field_behavior) = REQUIRED];</code>
Expand All @@ -49,17 +49,17 @@ public interface DiagnosticConfigOrBuilder
*
*
* <pre>
* Required. User Cloud Storage bucket location (REQUIRED)
* ## Must be formatted with path prefix (gs://$GCS_BUCKET)
* Required. User Cloud Storage bucket location (REQUIRED).
* Must be formatted with path prefix (`gs://$GCS_BUCKET`).
* Permissions:
* User Managed Notebooks:
* - storage.buckets.writer: Must be given to the project's service account
* attached to VM.
* attached to VM.
* Google Managed Notebooks:
* - storage.buckets.writer: Must be given to the project's service account or
* ## user credentials attached to VM depending on authentication mode.
* user credentials attached to VM depending on authentication mode.
* Cloud Storage bucket Log file will be written to
* gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz
* `gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz`
* </pre>
*
* <code>string gcs_bucket = 1 [(.google.api.field_behavior) = REQUIRED];</code>
Expand All @@ -72,10 +72,12 @@ public interface DiagnosticConfigOrBuilder
*
*
* <pre>
* Optional. Defines the relative storage path in the Cloud Storage bucket where the
* diagnostic logs will be written: Default path will be the root directory of
* the Cloud Storage bucket (gs://$GCS_BUCKET/$DATE_$TIME.tar.gz) Example of
* full path where Log file will be written: gs://$GCS_BUCKET/$RELATIVE_PATH/
* Optional. Defines the relative storage path in the Cloud Storage bucket
* where the diagnostic logs will be written: Default path will be the root
* directory of the Cloud Storage bucket
* (`gs://$GCS_BUCKET/$DATE_$TIME.tar.gz`)
* Example of full path where Log file will be written:
* `gs://$GCS_BUCKET/$RELATIVE_PATH/`
* </pre>
*
* <code>string relative_path = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
Expand All @@ -87,10 +89,12 @@ public interface DiagnosticConfigOrBuilder
*
*
* <pre>
* Optional. Defines the relative storage path in the Cloud Storage bucket where the
* diagnostic logs will be written: Default path will be the root directory of
* the Cloud Storage bucket (gs://$GCS_BUCKET/$DATE_$TIME.tar.gz) Example of
* full path where Log file will be written: gs://$GCS_BUCKET/$RELATIVE_PATH/
* Optional. Defines the relative storage path in the Cloud Storage bucket
* where the diagnostic logs will be written: Default path will be the root
* directory of the Cloud Storage bucket
* (`gs://$GCS_BUCKET/$DATE_$TIME.tar.gz`)
* Example of full path where Log file will be written:
* `gs://$GCS_BUCKET/$RELATIVE_PATH/`
* </pre>
*
* <code>string relative_path = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
Expand Down
Loading