docs: Put resource paths in code spans and use absolute URLs (#27)

This PR was generated using Autosynth. 🌈 Synth log will be available here: https://source.cloud.google.com/results/invocations/7b97c562-262f-4a9f-b760-5ce9bb5a4439/targets - [ ] To automatically regenerate this PR, check this box. PiperOrigin-RevId: 352807727 Source-Link: googleapis/googleapis@dc9821e
googleapis · Feb 10, 2021 · d21a378 · d21a378
1 parent f73a8a2
commit d21a378
Show file tree

Hide file tree

Showing 28 changed files with 200 additions and 182 deletions.
diff --git a/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/ProductServiceClient.java b/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/ProductServiceClient.java
@@ -154,7 +154,7 @@ public final OperationsClient getOperationsClient() {
    * Creates a [Product][google.cloud.retail.v2.Product].
    *
    * @param parent Required. The parent catalog resource name, such as
-   *     "projects/&#42;/locations/global/catalogs/default_catalog/branches/default_branch".
+   *     `projects/&#42;/locations/global/catalogs/default_catalog/branches/default_branch`.
    * @param product Required. The [Product][google.cloud.retail.v2.Product] to create.
    * @param productId Required. The ID to use for the [Product][google.cloud.retail.v2.Product],
    *     which will become the final component of the
@@ -184,7 +184,7 @@ public final Product createProduct(BranchName parent, Product product, String pr
    * Creates a [Product][google.cloud.retail.v2.Product].
    *
    * @param parent Required. The parent catalog resource name, such as
-   *     "projects/&#42;/locations/global/catalogs/default_catalog/branches/default_branch".
+   *     `projects/&#42;/locations/global/catalogs/default_catalog/branches/default_branch`.
    * @param product Required. The [Product][google.cloud.retail.v2.Product] to create.
    * @param productId Required. The ID to use for the [Product][google.cloud.retail.v2.Product],
    *     which will become the final component of the
@@ -235,7 +235,7 @@ public final UnaryCallable<CreateProductRequest, Product> createProductCallable(
    * Gets a [Product][google.cloud.retail.v2.Product].
    *
    * @param name Required. Full resource name of [Product][google.cloud.retail.v2.Product], such as
-   *     "projects/&#42;/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id".
+   *     `projects/&#42;/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`.
    *     <p>If the caller does not have permission to access the
    *     [Product][google.cloud.retail.v2.Product], regardless of whether or not it exists, a
    *     PERMISSION_DENIED error is returned.
@@ -254,7 +254,7 @@ public final Product getProduct(ProductName name) {
    * Gets a [Product][google.cloud.retail.v2.Product].
    *
    * @param name Required. Full resource name of [Product][google.cloud.retail.v2.Product], such as
-   *     "projects/&#42;/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id".
+   *     `projects/&#42;/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`.
    *     <p>If the caller does not have permission to access the
    *     [Product][google.cloud.retail.v2.Product], regardless of whether or not it exists, a
    *     PERMISSION_DENIED error is returned.
@@ -337,7 +337,7 @@ public final UnaryCallable<UpdateProductRequest, Product> updateProductCallable(
    * Deletes a [Product][google.cloud.retail.v2.Product].
    *
    * @param name Required. Full resource name of [Product][google.cloud.retail.v2.Product], such as
-   *     "projects/&#42;/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id".
+   *     `projects/&#42;/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`.
    *     <p>If the caller does not have permission to delete the
    *     [Product][google.cloud.retail.v2.Product], regardless of whether or not it exists, a
    *     PERMISSION_DENIED error is returned.
@@ -356,7 +356,7 @@ public final void deleteProduct(ProductName name) {
    * Deletes a [Product][google.cloud.retail.v2.Product].
    *
    * @param name Required. Full resource name of [Product][google.cloud.retail.v2.Product], such as
-   *     "projects/&#42;/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id".
+   *     `projects/&#42;/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`.
    *     <p>If the caller does not have permission to delete the
    *     [Product][google.cloud.retail.v2.Product], regardless of whether or not it exists, a
    *     PERMISSION_DENIED error is returned.

diff --git a/proto-google-cloud-retail-v2/src/main/java/com/google/cloud/retail/v2/BigQuerySource.java b/proto-google-cloud-retail-v2/src/main/java/com/google/cloud/retail/v2/BigQuerySource.java
@@ -363,7 +363,7 @@ public com.google.protobuf.ByteString getGcsStagingDirBytes() {
    * per line. Each product must
    *   have a valid [Product.id][google.cloud.retail.v2.Product.id].
    * * `product_merchant_center`: See [Importing catalog data from Merchant
-   *   Center](/retail/recommendations-ai/docs/upload-catalog#mc).
+   *   Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc).
    * Supported values for user events imports:
    * * `user_event` (default): One JSON
    * [UserEvent][google.cloud.retail.v2.UserEvent] per line.
@@ -397,7 +397,7 @@ public java.lang.String getDataSchema() {
    * per line. Each product must
    *   have a valid [Product.id][google.cloud.retail.v2.Product.id].
    * * `product_merchant_center`: See [Importing catalog data from Merchant
-   *   Center](/retail/recommendations-ai/docs/upload-catalog#mc).
+   *   Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc).
    * Supported values for user events imports:
    * * `user_event` (default): One JSON
    * [UserEvent][google.cloud.retail.v2.UserEvent] per line.
@@ -1267,7 +1267,7 @@ public Builder setGcsStagingDirBytes(com.google.protobuf.ByteString value) {
      * per line. Each product must
      *   have a valid [Product.id][google.cloud.retail.v2.Product.id].
      * * `product_merchant_center`: See [Importing catalog data from Merchant
-     *   Center](/retail/recommendations-ai/docs/upload-catalog#mc).
+     *   Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc).
      * Supported values for user events imports:
      * * `user_event` (default): One JSON
      * [UserEvent][google.cloud.retail.v2.UserEvent] per line.
@@ -1300,7 +1300,7 @@ public java.lang.String getDataSchema() {
      * per line. Each product must
      *   have a valid [Product.id][google.cloud.retail.v2.Product.id].
      * * `product_merchant_center`: See [Importing catalog data from Merchant
-     *   Center](/retail/recommendations-ai/docs/upload-catalog#mc).
+     *   Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc).
      * Supported values for user events imports:
      * * `user_event` (default): One JSON
      * [UserEvent][google.cloud.retail.v2.UserEvent] per line.
@@ -1333,7 +1333,7 @@ public com.google.protobuf.ByteString getDataSchemaBytes() {
      * per line. Each product must
      *   have a valid [Product.id][google.cloud.retail.v2.Product.id].
      * * `product_merchant_center`: See [Importing catalog data from Merchant
-     *   Center](/retail/recommendations-ai/docs/upload-catalog#mc).
+     *   Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc).
      * Supported values for user events imports:
      * * `user_event` (default): One JSON
      * [UserEvent][google.cloud.retail.v2.UserEvent] per line.
@@ -1365,7 +1365,7 @@ public Builder setDataSchema(java.lang.String value) {
      * per line. Each product must
      *   have a valid [Product.id][google.cloud.retail.v2.Product.id].
      * * `product_merchant_center`: See [Importing catalog data from Merchant
-     *   Center](/retail/recommendations-ai/docs/upload-catalog#mc).
+     *   Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc).
      * Supported values for user events imports:
      * * `user_event` (default): One JSON
      * [UserEvent][google.cloud.retail.v2.UserEvent] per line.
@@ -1393,7 +1393,7 @@ public Builder clearDataSchema() {
      * per line. Each product must
      *   have a valid [Product.id][google.cloud.retail.v2.Product.id].
      * * `product_merchant_center`: See [Importing catalog data from Merchant
-     *   Center](/retail/recommendations-ai/docs/upload-catalog#mc).
+     *   Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc).
      * Supported values for user events imports:
      * * `user_event` (default): One JSON
      * [UserEvent][google.cloud.retail.v2.UserEvent] per line.

diff --git a/...gle-cloud-retail-v2/src/main/java/com/google/cloud/retail/v2/BigQuerySourceOrBuilder.java b/...gle-cloud-retail-v2/src/main/java/com/google/cloud/retail/v2/BigQuerySourceOrBuilder.java
@@ -145,7 +145,7 @@ public interface BigQuerySourceOrBuilder
    * per line. Each product must
    *   have a valid [Product.id][google.cloud.retail.v2.Product.id].
    * * `product_merchant_center`: See [Importing catalog data from Merchant
-   *   Center](/retail/recommendations-ai/docs/upload-catalog#mc).
+   *   Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc).
    * Supported values for user events imports:
    * * `user_event` (default): One JSON
    * [UserEvent][google.cloud.retail.v2.UserEvent] per line.
@@ -168,7 +168,7 @@ public interface BigQuerySourceOrBuilder
    * per line. Each product must
    *   have a valid [Product.id][google.cloud.retail.v2.Product.id].
    * * `product_merchant_center`: See [Importing catalog data from Merchant
-   *   Center](/retail/recommendations-ai/docs/upload-catalog#mc).
+   *   Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc).
    * Supported values for user events imports:
    * * `user_event` (default): One JSON
    * [UserEvent][google.cloud.retail.v2.UserEvent] per line.

diff --git a/...gle-cloud-retail-v2/src/main/java/com/google/cloud/retail/v2/CollectUserEventRequest.java b/...gle-cloud-retail-v2/src/main/java/com/google/cloud/retail/v2/CollectUserEventRequest.java
@@ -139,7 +139,7 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
    *
    * <pre>
    * Required. The parent catalog name, such as
-   * "projects/1234/locations/global/catalogs/default_catalog".
+   * `projects/1234/locations/global/catalogs/default_catalog`.
    * </pre>
    *
    * <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED];</code>
@@ -163,7 +163,7 @@ public java.lang.String getParent() {
    *
    * <pre>
    * Required. The parent catalog name, such as
-   * "projects/1234/locations/global/catalogs/default_catalog".
+   * `projects/1234/locations/global/catalogs/default_catalog`.
    * </pre>
    *
    * <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED];</code>
@@ -680,7 +680,7 @@ public Builder mergeFrom(
      *
      * <pre>
      * Required. The parent catalog name, such as
-     * "projects/1234/locations/global/catalogs/default_catalog".
+     * `projects/1234/locations/global/catalogs/default_catalog`.
      * </pre>
      *
      * <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED];</code>
@@ -703,7 +703,7 @@ public java.lang.String getParent() {
      *
      * <pre>
      * Required. The parent catalog name, such as
-     * "projects/1234/locations/global/catalogs/default_catalog".
+     * `projects/1234/locations/global/catalogs/default_catalog`.
      * </pre>
      *
      * <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED];</code>
@@ -726,7 +726,7 @@ public com.google.protobuf.ByteString getParentBytes() {
      *
      * <pre>
      * Required. The parent catalog name, such as
-     * "projects/1234/locations/global/catalogs/default_catalog".
+     * `projects/1234/locations/global/catalogs/default_catalog`.
      * </pre>
      *
      * <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED];</code>
@@ -748,7 +748,7 @@ public Builder setParent(java.lang.String value) {
      *
      * <pre>
      * Required. The parent catalog name, such as
-     * "projects/1234/locations/global/catalogs/default_catalog".
+     * `projects/1234/locations/global/catalogs/default_catalog`.
      * </pre>
      *
      * <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED];</code>
@@ -766,7 +766,7 @@ public Builder clearParent() {
      *
      * <pre>
      * Required. The parent catalog name, such as
-     * "projects/1234/locations/global/catalogs/default_catalog".
+     * `projects/1234/locations/global/catalogs/default_catalog`.
      * </pre>
      *
      * <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED];</code>

diff --git a/...-retail-v2/src/main/java/com/google/cloud/retail/v2/CollectUserEventRequestOrBuilder.java b/...-retail-v2/src/main/java/com/google/cloud/retail/v2/CollectUserEventRequestOrBuilder.java
@@ -28,7 +28,7 @@ public interface CollectUserEventRequestOrBuilder
    *
    * <pre>
    * Required. The parent catalog name, such as
-   * "projects/1234/locations/global/catalogs/default_catalog".
+   * `projects/1234/locations/global/catalogs/default_catalog`.
    * </pre>
    *
    * <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED];</code>
@@ -41,7 +41,7 @@ public interface CollectUserEventRequestOrBuilder
    *
    * <pre>
    * Required. The parent catalog name, such as
-   * "projects/1234/locations/global/catalogs/default_catalog".
+   * `projects/1234/locations/global/catalogs/default_catalog`.
    * </pre>
    *
    * <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED];</code>

diff --git a/...google-cloud-retail-v2/src/main/java/com/google/cloud/retail/v2/CreateProductRequest.java b/...google-cloud-retail-v2/src/main/java/com/google/cloud/retail/v2/CreateProductRequest.java
@@ -141,7 +141,7 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
    *
    * <pre>
    * Required. The parent catalog resource name, such as
-   * "projects/&#42;&#47;locations/global/catalogs/default_catalog/branches/default_branch".
+   * `projects/&#42;&#47;locations/global/catalogs/default_catalog/branches/default_branch`.
    * </pre>
    *
    * <code>
@@ -167,7 +167,7 @@ public java.lang.String getParent() {
    *
    * <pre>
    * Required. The parent catalog resource name, such as
-   * "projects/&#42;&#47;locations/global/catalogs/default_catalog/branches/default_branch".
+   * `projects/&#42;&#47;locations/global/catalogs/default_catalog/branches/default_branch`.
    * </pre>
    *
    * <code>
@@ -676,7 +676,7 @@ public Builder mergeFrom(
      *
      * <pre>
      * Required. The parent catalog resource name, such as
-     * "projects/&#42;&#47;locations/global/catalogs/default_catalog/branches/default_branch".
+     * `projects/&#42;&#47;locations/global/catalogs/default_catalog/branches/default_branch`.
      * </pre>
      *
      * <code>
@@ -701,7 +701,7 @@ public java.lang.String getParent() {
      *
      * <pre>
      * Required. The parent catalog resource name, such as
-     * "projects/&#42;&#47;locations/global/catalogs/default_catalog/branches/default_branch".
+     * `projects/&#42;&#47;locations/global/catalogs/default_catalog/branches/default_branch`.
      * </pre>
      *
      * <code>
@@ -726,7 +726,7 @@ public com.google.protobuf.ByteString getParentBytes() {
      *
      * <pre>
      * Required. The parent catalog resource name, such as
-     * "projects/&#42;&#47;locations/global/catalogs/default_catalog/branches/default_branch".
+     * `projects/&#42;&#47;locations/global/catalogs/default_catalog/branches/default_branch`.
      * </pre>
      *
      * <code>
@@ -750,7 +750,7 @@ public Builder setParent(java.lang.String value) {
      *
      * <pre>
      * Required. The parent catalog resource name, such as
-     * "projects/&#42;&#47;locations/global/catalogs/default_catalog/branches/default_branch".
+     * `projects/&#42;&#47;locations/global/catalogs/default_catalog/branches/default_branch`.
      * </pre>
      *
      * <code>
@@ -770,7 +770,7 @@ public Builder clearParent() {
      *
      * <pre>
      * Required. The parent catalog resource name, such as
-     * "projects/&#42;&#47;locations/global/catalogs/default_catalog/branches/default_branch".
+     * `projects/&#42;&#47;locations/global/catalogs/default_catalog/branches/default_branch`.
      * </pre>
      *
      * <code>

diff --git a/...oud-retail-v2/src/main/java/com/google/cloud/retail/v2/CreateProductRequestOrBuilder.java b/...oud-retail-v2/src/main/java/com/google/cloud/retail/v2/CreateProductRequestOrBuilder.java
@@ -28,7 +28,7 @@ public interface CreateProductRequestOrBuilder
    *
    * <pre>
    * Required. The parent catalog resource name, such as
-   * "projects/&#42;&#47;locations/global/catalogs/default_catalog/branches/default_branch".
+   * `projects/&#42;&#47;locations/global/catalogs/default_catalog/branches/default_branch`.
    * </pre>
    *
    * <code>
@@ -43,7 +43,7 @@ public interface CreateProductRequestOrBuilder
    *
    * <pre>
    * Required. The parent catalog resource name, such as
-   * "projects/&#42;&#47;locations/global/catalogs/default_catalog/branches/default_branch".
+   * `projects/&#42;&#47;locations/global/catalogs/default_catalog/branches/default_branch`.
    * </pre>
    *
    * <code>

diff --git a/...google-cloud-retail-v2/src/main/java/com/google/cloud/retail/v2/DeleteProductRequest.java b/...google-cloud-retail-v2/src/main/java/com/google/cloud/retail/v2/DeleteProductRequest.java
@@ -119,7 +119,7 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
    * <pre>
    * Required. Full resource name of [Product][google.cloud.retail.v2.Product],
    * such as
-   * "projects/&#42;&#47;locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id".
+   * `projects/&#42;&#47;locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`.
    * If the caller does not have permission to delete the
    * [Product][google.cloud.retail.v2.Product], regardless of whether or not it
    * exists, a PERMISSION_DENIED error is returned.
@@ -151,7 +151,7 @@ public java.lang.String getName() {
    * <pre>
    * Required. Full resource name of [Product][google.cloud.retail.v2.Product],
    * such as
-   * "projects/&#42;&#47;locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id".
+   * `projects/&#42;&#47;locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`.
    * If the caller does not have permission to delete the
    * [Product][google.cloud.retail.v2.Product], regardless of whether or not it
    * exists, a PERMISSION_DENIED error is returned.
@@ -502,7 +502,7 @@ public Builder mergeFrom(
      * <pre>
      * Required. Full resource name of [Product][google.cloud.retail.v2.Product],
      * such as
-     * "projects/&#42;&#47;locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id".
+     * `projects/&#42;&#47;locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`.
      * If the caller does not have permission to delete the
      * [Product][google.cloud.retail.v2.Product], regardless of whether or not it
      * exists, a PERMISSION_DENIED error is returned.
@@ -533,7 +533,7 @@ public java.lang.String getName() {
      * <pre>
      * Required. Full resource name of [Product][google.cloud.retail.v2.Product],
      * such as
-     * "projects/&#42;&#47;locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id".
+     * `projects/&#42;&#47;locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`.
      * If the caller does not have permission to delete the
      * [Product][google.cloud.retail.v2.Product], regardless of whether or not it
      * exists, a PERMISSION_DENIED error is returned.
@@ -564,7 +564,7 @@ public com.google.protobuf.ByteString getNameBytes() {
      * <pre>
      * Required. Full resource name of [Product][google.cloud.retail.v2.Product],
      * such as
-     * "projects/&#42;&#47;locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id".
+     * `projects/&#42;&#47;locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`.
      * If the caller does not have permission to delete the
      * [Product][google.cloud.retail.v2.Product], regardless of whether or not it
      * exists, a PERMISSION_DENIED error is returned.
@@ -594,7 +594,7 @@ public Builder setName(java.lang.String value) {
      * <pre>
      * Required. Full resource name of [Product][google.cloud.retail.v2.Product],
      * such as
-     * "projects/&#42;&#47;locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id".
+     * `projects/&#42;&#47;locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`.
      * If the caller does not have permission to delete the
      * [Product][google.cloud.retail.v2.Product], regardless of whether or not it
      * exists, a PERMISSION_DENIED error is returned.
@@ -620,7 +620,7 @@ public Builder clearName() {
      * <pre>
      * Required. Full resource name of [Product][google.cloud.retail.v2.Product],
      * such as
-     * "projects/&#42;&#47;locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id".
+     * `projects/&#42;&#47;locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`.
      * If the caller does not have permission to delete the
      * [Product][google.cloud.retail.v2.Product], regardless of whether or not it
      * exists, a PERMISSION_DENIED error is returned.