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

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

Merged
merged 2 commits into from Feb 10, 2021
Merged

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

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
b28a4fa
docs: Put resource paths in code spans and use absolute URLs
yoshi-automation Jan 20, 2021
707db8a
Merge branch 'master' into autosynth-googleapis
Neenu1995 Feb 10, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 6 additions & 6 deletions google-cloud-retail/src/main/java/com/google/cloud/retail/v2/ProductServiceClient.java
View file
Open in desktop
Expand Up @@ -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/*/locations/global/catalogs/default_catalog/branches/default_branch".
* `projects/*/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
Expand Down Expand Up @@ -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/*/locations/global/catalogs/default_catalog/branches/default_branch".
* `projects/*/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
Expand Down Expand Up @@ -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.
Expand All @@ -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.
Expand Down Expand Up @@ -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.
Expand All @@ -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.
Expand Down
14 changes: 7 additions & 7 deletions proto-google-cloud-retail-v2/src/main/java/com/google/cloud/retail/v2/BigQuerySource.java
View file
Open in desktop
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions ...gle-cloud-retail-v2/src/main/java/com/google/cloud/retail/v2/BigQuerySourceOrBuilder.java
View file
Open in desktop
Expand Up @@ -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.
Expand All @@ -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.
Expand Down
14 changes: 7 additions & 7 deletions ...gle-cloud-retail-v2/src/main/java/com/google/cloud/retail/v2/CollectUserEventRequest.java
View file
Open in desktop
Expand Up @@ -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>
Expand All @@ -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>
Expand Down Expand Up @@ -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>
Expand All @@ -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>
Expand All @@ -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>
Expand All @@ -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>
Expand All @@ -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>
Expand Down
4 changes: 2 additions & 2 deletions ...-retail-v2/src/main/java/com/google/cloud/retail/v2/CollectUserEventRequestOrBuilder.java
View file
Open in desktop
Expand Up @@ -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>
Expand All @@ -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>
Expand Down
14 changes: 7 additions & 7 deletions ...google-cloud-retail-v2/src/main/java/com/google/cloud/retail/v2/CreateProductRequest.java
View file
Open in desktop
Expand Up @@ -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>
Expand All @@ -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>
Expand Down Expand Up @@ -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>
Expand All @@ -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>
Expand All @@ -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>
Expand All @@ -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>
Expand All @@ -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>
Expand Down
4 changes: 2 additions & 2 deletions ...oud-retail-v2/src/main/java/com/google/cloud/retail/v2/CreateProductRequestOrBuilder.java
View file
Open in desktop
Expand Up @@ -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>
Expand All @@ -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>
Expand Down
14 changes: 7 additions & 7 deletions ...google-cloud-retail-v2/src/main/java/com/google/cloud/retail/v2/DeleteProductRequest.java
View file
Open in desktop
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand All @@ -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.
Expand Down