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

docs: place paths in code spans #292

Merged
merged 1 commit into from Mar 30, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Expand Up @@ -181,7 +181,7 @@ public final OperationsClient getOperationsClient() {
* }</pre>
*
* @param parent Required. The parent catalog resource name, such as
* "projects/&#42;/locations/global/catalogs/default_catalog".
* `projects/&#42;/locations/global/catalogs/default_catalog`.
* @param catalogItem Required. The catalog item to create.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
Expand Down Expand Up @@ -209,7 +209,7 @@ public final CatalogItem createCatalogItem(CatalogName parent, CatalogItem catal
* }</pre>
*
* @param parent Required. The parent catalog resource name, such as
* "projects/&#42;/locations/global/catalogs/default_catalog".
* `projects/&#42;/locations/global/catalogs/default_catalog`.
* @param catalogItem Required. The catalog item to create.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
Expand Down Expand Up @@ -282,7 +282,7 @@ public final UnaryCallable<CreateCatalogItemRequest, CatalogItem> createCatalogI
* }</pre>
*
* @param name Required. Full resource name of catalog item, such as
* "projects/&#42;/locations/global/catalogs/default_catalog/catalogitems/some_catalog_item_id".
* `projects/&#42;/locations/global/catalogs/default_catalog/catalogitems/some_catalog_item_id`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final CatalogItem getCatalogItem(CatalogItemPathName name) {
Expand All @@ -307,7 +307,7 @@ public final CatalogItem getCatalogItem(CatalogItemPathName name) {
* }</pre>
*
* @param name Required. Full resource name of catalog item, such as
* "projects/&#42;/locations/global/catalogs/default_catalog/catalogitems/some_catalog_item_id".
* `projects/&#42;/locations/global/catalogs/default_catalog/catalogitems/some_catalog_item_id`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final CatalogItem getCatalogItem(String name) {
Expand Down Expand Up @@ -385,7 +385,7 @@ public final UnaryCallable<GetCatalogItemRequest, CatalogItem> getCatalogItemCal
* }</pre>
*
* @param parent Required. The parent catalog resource name, such as
* "projects/&#42;/locations/global/catalogs/default_catalog".
* `projects/&#42;/locations/global/catalogs/default_catalog`.
* @param filter Optional. A filter to apply on the list results.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
Expand Down Expand Up @@ -416,7 +416,7 @@ public final ListCatalogItemsPagedResponse listCatalogItems(CatalogName parent,
* }</pre>
*
* @param parent Required. The parent catalog resource name, such as
* "projects/&#42;/locations/global/catalogs/default_catalog".
* `projects/&#42;/locations/global/catalogs/default_catalog`.
* @param filter Optional. A filter to apply on the list results.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
Expand Down Expand Up @@ -661,7 +661,7 @@ public final UnaryCallable<UpdateCatalogItemRequest, CatalogItem> updateCatalogI
* }</pre>
*
* @param name Required. Full resource name of catalog item, such as
* "projects/&#42;/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id".
* `projects/&#42;/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteCatalogItem(CatalogItemPathName name) {
Expand All @@ -688,7 +688,7 @@ public final void deleteCatalogItem(CatalogItemPathName name) {
* }</pre>
*
* @param name Required. Full resource name of catalog item, such as
* "projects/&#42;/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id".
* `projects/&#42;/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteCatalogItem(String name) {
Expand Down Expand Up @@ -771,7 +771,7 @@ public final UnaryCallable<DeleteCatalogItemRequest, Empty> deleteCatalogItemCal
* }
* }</pre>
*
* @param parent Required. "projects/1234/locations/global/catalogs/default_catalog"
* @param parent Required. `projects/1234/locations/global/catalogs/default_catalog`
* @param requestId Optional. Unique identifier provided by client, within the ancestor dataset
* scope. Ensures idempotency and used for request deduplication. Server-generated if
* unspecified. Up to 128 characters long. This is returned as
Expand Down Expand Up @@ -818,7 +818,7 @@ public final OperationFuture<ImportCatalogItemsResponse, ImportMetadata> importC
* }
* }</pre>
*
* @param parent Required. "projects/1234/locations/global/catalogs/default_catalog"
* @param parent Required. `projects/1234/locations/global/catalogs/default_catalog`
* @param requestId Optional. Unique identifier provided by client, within the ancestor dataset
* scope. Ensures idempotency and used for request deduplication. Server-generated if
* unspecified. Up to 128 characters long. This is returned as
Expand Down
Expand Up @@ -183,7 +183,7 @@ public PredictionApiKeyRegistryStub getStub() {
* }</pre>
*
* @param parent Required. The parent resource path.
* "projects/&#42;/locations/global/catalogs/default_catalog/eventStores/default_event_store".
* `projects/&#42;/locations/global/catalogs/default_catalog/eventStores/default_event_store`.
* @param predictionApiKeyRegistration Required. The prediction API key registration.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
Expand Down Expand Up @@ -217,7 +217,7 @@ public final PredictionApiKeyRegistration createPredictionApiKeyRegistration(
* }</pre>
*
* @param parent Required. The parent resource path.
* "projects/&#42;/locations/global/catalogs/default_catalog/eventStores/default_event_store".
* `projects/&#42;/locations/global/catalogs/default_catalog/eventStores/default_event_store`.
* @param predictionApiKeyRegistration Required. The prediction API key registration.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
Expand Down Expand Up @@ -310,7 +310,7 @@ public final PredictionApiKeyRegistration createPredictionApiKeyRegistration(
* }</pre>
*
* @param parent Required. The parent placement resource name such as
* "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store"
* `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListPredictionApiKeyRegistrationsPagedResponse listPredictionApiKeyRegistrations(
Expand Down Expand Up @@ -341,7 +341,7 @@ public final ListPredictionApiKeyRegistrationsPagedResponse listPredictionApiKey
* }</pre>
*
* @param parent Required. The parent placement resource name such as
* "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store"
* `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListPredictionApiKeyRegistrationsPagedResponse listPredictionApiKeyRegistrations(
Expand Down Expand Up @@ -479,7 +479,7 @@ public final ListPredictionApiKeyRegistrationsPagedResponse listPredictionApiKey
* }</pre>
*
* @param name Required. The API key to unregister including full resource path.
* "projects/&#42;/locations/global/catalogs/default_catalog/eventStores/default_event_store/predictionApiKeyRegistrations/&lt;YOUR_API_KEY&gt;"
* `projects/&#42;/locations/global/catalogs/default_catalog/eventStores/default_event_store/predictionApiKeyRegistrations/&lt;YOUR_API_KEY&gt;`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deletePredictionApiKeyRegistration(PredictionApiKeyRegistrationName name) {
Expand Down Expand Up @@ -512,7 +512,7 @@ public final void deletePredictionApiKeyRegistration(PredictionApiKeyRegistratio
* }</pre>
*
* @param name Required. The API key to unregister including full resource path.
* "projects/&#42;/locations/global/catalogs/default_catalog/eventStores/default_event_store/predictionApiKeyRegistrations/&lt;YOUR_API_KEY&gt;"
* `projects/&#42;/locations/global/catalogs/default_catalog/eventStores/default_event_store/predictionApiKeyRegistrations/&lt;YOUR_API_KEY&gt;`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deletePredictionApiKeyRegistration(String name) {
Expand Down
Expand Up @@ -178,7 +178,7 @@ public PredictionServiceStub getStub() {
* }</pre>
*
* @param name Required. Full resource name of the format:
* {name=projects/&#42;/locations/global/catalogs/default_catalog/eventStores/default_event_store/placements/&#42;}
* `{name=projects/&#42;/locations/global/catalogs/default_catalog/eventStores/default_event_store/placements/&#42;}`
* The id of the recommendation engine placement. This id is used to identify the set of
* models that will be used to make the prediction.
* <p>We currently support three placements with the following IDs by default:
Expand Down Expand Up @@ -243,7 +243,7 @@ public final PredictPagedResponse predict(PlacementName name, UserEvent userEven
* }</pre>
*
* @param name Required. Full resource name of the format:
* {name=projects/&#42;/locations/global/catalogs/default_catalog/eventStores/default_event_store/placements/&#42;}
* `{name=projects/&#42;/locations/global/catalogs/default_catalog/eventStores/default_event_store/placements/&#42;}`
* The id of the recommendation engine placement. This id is used to identify the set of
* models that will be used to make the prediction.
* <p>We currently support three placements with the following IDs by default:
Expand Down
Expand Up @@ -185,7 +185,7 @@ public final OperationsClient getOperationsClient() {
* }</pre>
*
* @param parent Required. The parent eventStore resource name, such as
* "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store".
* `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`.
* @param userEvent Required. User event to write.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
Expand Down Expand Up @@ -214,7 +214,7 @@ public final UserEvent writeUserEvent(EventStoreName parent, UserEvent userEvent
* }</pre>
*
* @param parent Required. The parent eventStore resource name, such as
* "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store".
* `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`.
* @param userEvent Required. User event to write.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
Expand Down Expand Up @@ -298,7 +298,7 @@ public final UnaryCallable<WriteUserEventRequest, UserEvent> writeUserEventCalla
* }</pre>
*
* @param parent Required. The parent eventStore name, such as
* "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store".
* `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`.
* @param userEvent Required. URL encoded UserEvent proto.
* @param uri Optional. The url including cgi-parameters but excluding the hash fragment. The URL
* must be truncated to 1.5K bytes to conservatively be under the 2K bytes. This is often more
Expand Down Expand Up @@ -342,7 +342,7 @@ public final HttpBody collectUserEvent(
* }</pre>
*
* @param parent Required. The parent eventStore name, such as
* "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store".
* `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`.
* @param userEvent Required. URL encoded UserEvent proto.
* @param uri Optional. The url including cgi-parameters but excluding the hash fragment. The URL
* must be truncated to 1.5K bytes to conservatively be under the 2K bytes. This is often more
Expand Down Expand Up @@ -445,7 +445,7 @@ public final UnaryCallable<CollectUserEventRequest, HttpBody> collectUserEventCa
* }</pre>
*
* @param parent Required. The parent eventStore resource name, such as
* "projects/&#42;/locations/&#42;/catalogs/default_catalog/eventStores/default_event_store".
* `projects/&#42;/locations/&#42;/catalogs/default_catalog/eventStores/default_event_store`.
* @param filter Optional. Filtering expression to specify restrictions over returned events. This
* is a sequence of terms, where each term applies some kind of a restriction to the returned
* user events. Use this expression to restrict results to a specific time range, or filter
Expand Down Expand Up @@ -495,7 +495,7 @@ public final ListUserEventsPagedResponse listUserEvents(EventStoreName parent, S
* }</pre>
*
* @param parent Required. The parent eventStore resource name, such as
* "projects/&#42;/locations/&#42;/catalogs/default_catalog/eventStores/default_event_store".
* `projects/&#42;/locations/&#42;/catalogs/default_catalog/eventStores/default_event_store`.
* @param filter Optional. Filtering expression to specify restrictions over returned events. This
* is a sequence of terms, where each term applies some kind of a restriction to the returned
* user events. Use this expression to restrict results to a specific time range, or filter
Expand Down Expand Up @@ -644,7 +644,7 @@ public final ListUserEventsPagedResponse listUserEvents(ListUserEventsRequest re
*
* @param parent Required. The resource name of the event_store under which the events are
* created. The format is
* "projects/${projectId}/locations/global/catalogs/${catalogId}/eventStores/${eventStoreId}"
* `projects/${projectId}/locations/global/catalogs/${catalogId}/eventStores/${eventStoreId}`
* @param filter Required. The filter string to specify the events to be deleted. Empty string
* filter is not allowed. This filter can also be used with ListUserEvents API to list events
* that will be deleted. The eligible fields for filtering are:
Expand Down Expand Up @@ -698,7 +698,7 @@ public final ListUserEventsPagedResponse listUserEvents(ListUserEventsRequest re
*
* @param parent Required. The resource name of the event_store under which the events are
* created. The format is
* "projects/${projectId}/locations/global/catalogs/${catalogId}/eventStores/${eventStoreId}"
* `projects/${projectId}/locations/global/catalogs/${catalogId}/eventStores/${eventStoreId}`
* @param filter Required. The filter string to specify the events to be deleted. Empty string
* filter is not allowed. This filter can also be used with ListUserEvents API to list events
* that will be deleted. The eligible fields for filtering are:
Expand Down Expand Up @@ -846,7 +846,7 @@ public final UnaryCallable<PurgeUserEventsRequest, Operation> purgeUserEventsCal
* }</pre>
*
* @param parent Required.
* "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store"
* `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`
* @param requestId Optional. Unique identifier provided by client, within the ancestor dataset
* scope. Ensures idempotency for expensive long running operations. Server-generated if
* unspecified. Up to 128 characters long. This is returned as
Expand Down Expand Up @@ -896,7 +896,7 @@ public final OperationFuture<ImportUserEventsResponse, ImportMetadata> importUse
* }</pre>
*
* @param parent Required.
* "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store"
* `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`
* @param requestId Optional. Unique identifier provided by client, within the ancestor dataset
* scope. Ensures idempotency for expensive long running operations. Server-generated if
* unspecified. Up to 128 characters long. This is returned as
Expand Down
Expand Up @@ -139,7 +139,7 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
*
* <pre>
* Required. The parent eventStore name, such as
* "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store".
* `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`.
* </pre>
*
* <code>
Expand All @@ -165,7 +165,7 @@ public java.lang.String getParent() {
*
* <pre>
* Required. The parent eventStore name, such as
* "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store".
* `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`.
* </pre>
*
* <code>
Expand Down Expand Up @@ -691,7 +691,7 @@ public Builder mergeFrom(
*
* <pre>
* Required. The parent eventStore name, such as
* "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store".
* `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`.
* </pre>
*
* <code>
Expand All @@ -716,7 +716,7 @@ public java.lang.String getParent() {
*
* <pre>
* Required. The parent eventStore name, such as
* "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store".
* `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`.
* </pre>
*
* <code>
Expand All @@ -741,7 +741,7 @@ public com.google.protobuf.ByteString getParentBytes() {
*
* <pre>
* Required. The parent eventStore name, such as
* "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store".
* `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`.
* </pre>
*
* <code>
Expand All @@ -765,7 +765,7 @@ public Builder setParent(java.lang.String value) {
*
* <pre>
* Required. The parent eventStore name, such as
* "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store".
* `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`.
* </pre>
*
* <code>
Expand All @@ -785,7 +785,7 @@ public Builder clearParent() {
*
* <pre>
* Required. The parent eventStore name, such as
* "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store".
* `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`.
* </pre>
*
* <code>
Expand Down
Expand Up @@ -28,7 +28,7 @@ public interface CollectUserEventRequestOrBuilder
*
* <pre>
* Required. The parent eventStore name, such as
* "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store".
* `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`.
* </pre>
*
* <code>
Expand All @@ -43,7 +43,7 @@ public interface CollectUserEventRequestOrBuilder
*
* <pre>
* Required. The parent eventStore name, such as
* "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store".
* `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`.
* </pre>
*
* <code>
Expand Down