Skip to content

Commit 7c8d161

Browse files
Google APIscopybara-github
authored andcommitted
docs: place paths in code spans
chore: update python package name to `google-cloud-recomendations-ai` PiperOrigin-RevId: 365829960
1 parent c539b9b commit 7c8d161

6 files changed

Lines changed: 17 additions & 16 deletions

File tree

google/cloud/recommendationengine/v1beta1/BUILD.bazel

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,7 @@ py_gapic_library(
174174
name = "recommendationengine_py_gapic",
175175
srcs = [":recommendationengine_proto"],
176176
grpc_service_config = "recommendationengine_grpc_service_config.json",
177+
opt_args = ["warehouse-package-name=google-cloud-recommendations-ai"]
177178
)
178179

179180
# Open Source Packages

google/cloud/recommendationengine/v1beta1/catalog_service.proto

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ service CatalogService {
110110
// Request message for CreateCatalogItem method.
111111
message CreateCatalogItemRequest {
112112
// Required. The parent catalog resource name, such as
113-
// "projects/*/locations/global/catalogs/default_catalog".
113+
// `projects/*/locations/global/catalogs/default_catalog`.
114114
string parent = 1 [
115115
(google.api.field_behavior) = REQUIRED,
116116
(google.api.resource_reference) = {
@@ -125,7 +125,7 @@ message CreateCatalogItemRequest {
125125
// Request message for GetCatalogItem method.
126126
message GetCatalogItemRequest {
127127
// Required. Full resource name of catalog item, such as
128-
// "projects/*/locations/global/catalogs/default_catalog/catalogitems/some_catalog_item_id".
128+
// `projects/*/locations/global/catalogs/default_catalog/catalogitems/some_catalog_item_id`.
129129
string name = 1 [
130130
(google.api.field_behavior) = REQUIRED,
131131
(google.api.resource_reference) = {
@@ -137,7 +137,7 @@ message GetCatalogItemRequest {
137137
// Request message for ListCatalogItems method.
138138
message ListCatalogItemsRequest {
139139
// Required. The parent catalog resource name, such as
140-
// "projects/*/locations/global/catalogs/default_catalog".
140+
// `projects/*/locations/global/catalogs/default_catalog`.
141141
string parent = 1 [
142142
(google.api.field_behavior) = REQUIRED,
143143
(google.api.resource_reference) = {
@@ -189,7 +189,7 @@ message UpdateCatalogItemRequest {
189189
// Request message for DeleteCatalogItem method.
190190
message DeleteCatalogItemRequest {
191191
// Required. Full resource name of catalog item, such as
192-
// "projects/*/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id".
192+
// `projects/*/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id`.
193193
string name = 1 [
194194
(google.api.field_behavior) = REQUIRED,
195195
(google.api.resource_reference) = {

google/cloud/recommendationengine/v1beta1/import.proto

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ option ruby_package = "Google::Cloud::RecommendationEngine::V1beta1";
3838
message GcsSource {
3939
// Required. Google Cloud Storage URIs to input files. URI can be up to
4040
// 2000 characters long. URIs can match the full object path (for example,
41-
// gs://bucket/directory/object.json) or a pattern matching one or more
42-
// files, such as gs://bucket/directory/*.json. A request can
41+
// `gs://bucket/directory/object.json`) or a pattern matching one or more
42+
// files, such as `gs://bucket/directory/*.json`. A request can
4343
// contain at most 100 files, and each file can be up to 2 GB. See
4444
// [Importing catalog information](/recommendations-ai/docs/upload-catalog)
4545
// for the expected file format and setup instructions.
@@ -74,7 +74,7 @@ message ImportErrorsConfig {
7474

7575
// Request message for Import methods.
7676
message ImportCatalogItemsRequest {
77-
// Required. "projects/1234/locations/global/catalogs/default_catalog"
77+
// Required. `projects/1234/locations/global/catalogs/default_catalog`
7878
string parent = 1 [
7979
(google.api.field_behavior) = REQUIRED,
8080
(google.api.resource_reference) = {
@@ -98,7 +98,7 @@ message ImportCatalogItemsRequest {
9898
// Request message for the ImportUserEvents request.
9999
message ImportUserEventsRequest {
100100
// Required.
101-
// "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store"
101+
// `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`
102102
string parent = 1 [
103103
(google.api.field_behavior) = REQUIRED,
104104
(google.api.resource_reference) = {

google/cloud/recommendationengine/v1beta1/prediction_apikey_registry_service.proto

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ message PredictionApiKeyRegistration {
8383
// Request message for the `CreatePredictionApiKeyRegistration` method.
8484
message CreatePredictionApiKeyRegistrationRequest {
8585
// Required. The parent resource path.
86-
// "projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store".
86+
// `projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store`.
8787
string parent = 1 [
8888
(google.api.field_behavior) = REQUIRED,
8989
(google.api.resource_reference) = {
@@ -99,7 +99,7 @@ message CreatePredictionApiKeyRegistrationRequest {
9999
// Request message for the `ListPredictionApiKeyRegistrations`.
100100
message ListPredictionApiKeyRegistrationsRequest {
101101
// Required. The parent placement resource name such as
102-
// "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store"
102+
// `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`
103103
string parent = 1 [
104104
(google.api.field_behavior) = REQUIRED,
105105
(google.api.resource_reference) = {
@@ -128,7 +128,7 @@ message ListPredictionApiKeyRegistrationsResponse {
128128
// Request message for `DeletePredictionApiKeyRegistration` method.
129129
message DeletePredictionApiKeyRegistrationRequest {
130130
// Required. The API key to unregister including full resource path.
131-
// "projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/predictionApiKeyRegistrations/<YOUR_API_KEY>"
131+
// `projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/predictionApiKeyRegistrations/<YOUR_API_KEY>`
132132
string name = 1 [
133133
(google.api.field_behavior) = REQUIRED,
134134
(google.api.resource_reference) = {

google/cloud/recommendationengine/v1beta1/prediction_service.proto

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ service PredictionService {
5353
// Request message for Predict method.
5454
message PredictRequest {
5555
// Required. Full resource name of the format:
56-
// {name=projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/placements/*}
56+
// `{name=projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/placements/*}`
5757
// The id of the recommendation engine placement. This id is used to identify
5858
// the set of models that will be used to make the prediction.
5959
//

google/cloud/recommendationengine/v1beta1/user_event_service.proto

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ service UserEventService {
113113
message PurgeUserEventsRequest {
114114
// Required. The resource name of the event_store under which the events are
115115
// created. The format is
116-
// "projects/${projectId}/locations/global/catalogs/${catalogId}/eventStores/${eventStoreId}"
116+
// `projects/${projectId}/locations/global/catalogs/${catalogId}/eventStores/${eventStoreId}`
117117
string parent = 1 [
118118
(google.api.field_behavior) = REQUIRED,
119119
(google.api.resource_reference) = {
@@ -172,7 +172,7 @@ message PurgeUserEventsResponse {
172172
// Request message for WriteUserEvent method.
173173
message WriteUserEventRequest {
174174
// Required. The parent eventStore resource name, such as
175-
// "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store".
175+
// `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`.
176176
string parent = 1 [
177177
(google.api.field_behavior) = REQUIRED,
178178
(google.api.resource_reference) = {
@@ -187,7 +187,7 @@ message WriteUserEventRequest {
187187
// Request message for CollectUserEvent method.
188188
message CollectUserEventRequest {
189189
// Required. The parent eventStore name, such as
190-
// "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store".
190+
// `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`.
191191
string parent = 1 [
192192
(google.api.field_behavior) = REQUIRED,
193193
(google.api.resource_reference) = {
@@ -213,7 +213,7 @@ message CollectUserEventRequest {
213213
// Request message for ListUserEvents method.
214214
message ListUserEventsRequest {
215215
// Required. The parent eventStore resource name, such as
216-
// "projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store".
216+
// `projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store`.
217217
string parent = 1 [
218218
(google.api.field_behavior) = REQUIRED,
219219
(google.api.resource_reference) = {

0 commit comments

Comments
 (0)