/
product_service.pb.go
executable file
·3153 lines (2935 loc) · 144 KB
/
product_service.pb.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright 2021 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// Code generated by protoc-gen-go. DO NOT EDIT.
// versions:
// protoc-gen-go v1.32.0
// protoc v4.25.2
// source: google/cloud/retail/v2/product_service.proto
package retailpb
import (
context "context"
reflect "reflect"
sync "sync"
longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
_ "google.golang.org/genproto/googleapis/api/annotations"
grpc "google.golang.org/grpc"
codes "google.golang.org/grpc/codes"
status "google.golang.org/grpc/status"
protoreflect "google.golang.org/protobuf/reflect/protoreflect"
protoimpl "google.golang.org/protobuf/runtime/protoimpl"
emptypb "google.golang.org/protobuf/types/known/emptypb"
fieldmaskpb "google.golang.org/protobuf/types/known/fieldmaskpb"
timestamppb "google.golang.org/protobuf/types/known/timestamppb"
)
const (
// Verify that this generated code is sufficiently up-to-date.
_ = protoimpl.EnforceVersion(20 - protoimpl.MinVersion)
// Verify that runtime/protoimpl is sufficiently up-to-date.
_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
)
// Request message for
// [ProductService.CreateProduct][google.cloud.retail.v2.ProductService.CreateProduct]
// method.
type CreateProductRequest struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// Required. The parent catalog resource name, such as
// `projects/*/locations/global/catalogs/default_catalog/branches/default_branch`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The [Product][google.cloud.retail.v2.Product] to create.
Product *Product `protobuf:"bytes,2,opt,name=product,proto3" json:"product,omitempty"`
// Required. The ID to use for the [Product][google.cloud.retail.v2.Product],
// which will become the final component of the
// [Product.name][google.cloud.retail.v2.Product.name].
//
// If the caller does not have permission to create the
// [Product][google.cloud.retail.v2.Product], regardless of whether or not it
// exists, a PERMISSION_DENIED error is returned.
//
// This field must be unique among all
// [Product][google.cloud.retail.v2.Product]s with the same
// [parent][google.cloud.retail.v2.CreateProductRequest.parent]. Otherwise, an
// ALREADY_EXISTS error is returned.
//
// This field must be a UTF-8 encoded string with a length limit of 128
// characters. Otherwise, an INVALID_ARGUMENT error is returned.
ProductId string `protobuf:"bytes,3,opt,name=product_id,json=productId,proto3" json:"product_id,omitempty"`
}
func (x *CreateProductRequest) Reset() {
*x = CreateProductRequest{}
if protoimpl.UnsafeEnabled {
mi := &file_google_cloud_retail_v2_product_service_proto_msgTypes[0]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *CreateProductRequest) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*CreateProductRequest) ProtoMessage() {}
func (x *CreateProductRequest) ProtoReflect() protoreflect.Message {
mi := &file_google_cloud_retail_v2_product_service_proto_msgTypes[0]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use CreateProductRequest.ProtoReflect.Descriptor instead.
func (*CreateProductRequest) Descriptor() ([]byte, []int) {
return file_google_cloud_retail_v2_product_service_proto_rawDescGZIP(), []int{0}
}
func (x *CreateProductRequest) GetParent() string {
if x != nil {
return x.Parent
}
return ""
}
func (x *CreateProductRequest) GetProduct() *Product {
if x != nil {
return x.Product
}
return nil
}
func (x *CreateProductRequest) GetProductId() string {
if x != nil {
return x.ProductId
}
return ""
}
// Request message for
// [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct]
// method.
type GetProductRequest struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// Required. Full resource name of [Product][google.cloud.retail.v2.Product],
// such as
// `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`.
//
// 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.
//
// If the requested [Product][google.cloud.retail.v2.Product] does not exist,
// a NOT_FOUND error is returned.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
}
func (x *GetProductRequest) Reset() {
*x = GetProductRequest{}
if protoimpl.UnsafeEnabled {
mi := &file_google_cloud_retail_v2_product_service_proto_msgTypes[1]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *GetProductRequest) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*GetProductRequest) ProtoMessage() {}
func (x *GetProductRequest) ProtoReflect() protoreflect.Message {
mi := &file_google_cloud_retail_v2_product_service_proto_msgTypes[1]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use GetProductRequest.ProtoReflect.Descriptor instead.
func (*GetProductRequest) Descriptor() ([]byte, []int) {
return file_google_cloud_retail_v2_product_service_proto_rawDescGZIP(), []int{1}
}
func (x *GetProductRequest) GetName() string {
if x != nil {
return x.Name
}
return ""
}
// Request message for
// [ProductService.UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct]
// method.
type UpdateProductRequest struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// Required. The product to update/create.
//
// If the caller does not have permission to update the
// [Product][google.cloud.retail.v2.Product], regardless of whether or not it
// exists, a PERMISSION_DENIED error is returned.
//
// If the [Product][google.cloud.retail.v2.Product] to update does not exist
// and
// [allow_missing][google.cloud.retail.v2.UpdateProductRequest.allow_missing]
// is not set, a NOT_FOUND error is returned.
Product *Product `protobuf:"bytes,1,opt,name=product,proto3" json:"product,omitempty"`
// Indicates which fields in the provided
// [Product][google.cloud.retail.v2.Product] to update. The immutable and
// output only fields are NOT supported. If not set, all supported fields (the
// fields that are neither immutable nor output only) are updated.
//
// If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
// is returned.
//
// The attribute key can be updated by setting the mask path as
// "attributes.${key_name}". If a key name is present in the mask but not in
// the patching product from the request, this key will be deleted after the
// update.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// If set to true, and the [Product][google.cloud.retail.v2.Product] is not
// found, a new [Product][google.cloud.retail.v2.Product] will be created. In
// this situation, `update_mask` is ignored.
AllowMissing bool `protobuf:"varint,3,opt,name=allow_missing,json=allowMissing,proto3" json:"allow_missing,omitempty"`
}
func (x *UpdateProductRequest) Reset() {
*x = UpdateProductRequest{}
if protoimpl.UnsafeEnabled {
mi := &file_google_cloud_retail_v2_product_service_proto_msgTypes[2]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *UpdateProductRequest) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*UpdateProductRequest) ProtoMessage() {}
func (x *UpdateProductRequest) ProtoReflect() protoreflect.Message {
mi := &file_google_cloud_retail_v2_product_service_proto_msgTypes[2]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use UpdateProductRequest.ProtoReflect.Descriptor instead.
func (*UpdateProductRequest) Descriptor() ([]byte, []int) {
return file_google_cloud_retail_v2_product_service_proto_rawDescGZIP(), []int{2}
}
func (x *UpdateProductRequest) GetProduct() *Product {
if x != nil {
return x.Product
}
return nil
}
func (x *UpdateProductRequest) GetUpdateMask() *fieldmaskpb.FieldMask {
if x != nil {
return x.UpdateMask
}
return nil
}
func (x *UpdateProductRequest) GetAllowMissing() bool {
if x != nil {
return x.AllowMissing
}
return false
}
// Request message for
// [ProductService.DeleteProduct][google.cloud.retail.v2.ProductService.DeleteProduct]
// method.
type DeleteProductRequest struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// Required. Full resource name of [Product][google.cloud.retail.v2.Product],
// such as
// `projects/*/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.
//
// If the [Product][google.cloud.retail.v2.Product] to delete does not exist,
// a NOT_FOUND error is returned.
//
// The [Product][google.cloud.retail.v2.Product] to delete can neither be a
// [Product.Type.COLLECTION][google.cloud.retail.v2.Product.Type.COLLECTION]
// [Product][google.cloud.retail.v2.Product] member nor a
// [Product.Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY]
// [Product][google.cloud.retail.v2.Product] with more than one
// [variants][google.cloud.retail.v2.Product.Type.VARIANT]. Otherwise, an
// INVALID_ARGUMENT error is returned.
//
// All inventory information for the named
// [Product][google.cloud.retail.v2.Product] will be deleted.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
}
func (x *DeleteProductRequest) Reset() {
*x = DeleteProductRequest{}
if protoimpl.UnsafeEnabled {
mi := &file_google_cloud_retail_v2_product_service_proto_msgTypes[3]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *DeleteProductRequest) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*DeleteProductRequest) ProtoMessage() {}
func (x *DeleteProductRequest) ProtoReflect() protoreflect.Message {
mi := &file_google_cloud_retail_v2_product_service_proto_msgTypes[3]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use DeleteProductRequest.ProtoReflect.Descriptor instead.
func (*DeleteProductRequest) Descriptor() ([]byte, []int) {
return file_google_cloud_retail_v2_product_service_proto_rawDescGZIP(), []int{3}
}
func (x *DeleteProductRequest) GetName() string {
if x != nil {
return x.Name
}
return ""
}
// Request message for
// [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts]
// method.
type ListProductsRequest struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// Required. The parent branch resource name, such as
// `projects/*/locations/global/catalogs/default_catalog/branches/0`. Use
// `default_branch` as the branch ID, to list products under the default
// branch.
//
// If the caller does not have permission to list
// [Product][google.cloud.retail.v2.Product]s under this branch, regardless of
// whether or not this branch exists, a PERMISSION_DENIED error is returned.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Maximum number of [Product][google.cloud.retail.v2.Product]s to return. If
// unspecified, defaults to 100. The maximum allowed value is 1000. Values
// above 1000 will be coerced to 1000.
//
// If this field is negative, an INVALID_ARGUMENT error is returned.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// A page token
// [ListProductsResponse.next_page_token][google.cloud.retail.v2.ListProductsResponse.next_page_token],
// received from a previous
// [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts]
// call. Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to
// [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts]
// must match the call that provided the page token. Otherwise, an
// INVALID_ARGUMENT error is returned.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// A filter to apply on the list results. Supported features:
//
// * List all the products under the parent branch if
// [filter][google.cloud.retail.v2.ListProductsRequest.filter] is unset.
// * List [Product.Type.VARIANT][google.cloud.retail.v2.Product.Type.VARIANT]
// [Product][google.cloud.retail.v2.Product]s sharing the same
//
// [Product.Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY]
// [Product][google.cloud.retail.v2.Product]. For example:
// `primary_product_id = "some_product_id"`
//
// * List [Product][google.cloud.retail.v2.Product]s bundled in a
// [Product.Type.COLLECTION][google.cloud.retail.v2.Product.Type.COLLECTION]
// [Product][google.cloud.retail.v2.Product].
//
// For example:
// `collection_product_id = "some_product_id"`
//
// * List [Product][google.cloud.retail.v2.Product]s with a partibular type.
// For example:
//
// `type = "PRIMARY"`
// `type = "VARIANT"`
// `type = "COLLECTION"`
//
// If the field is unrecognizable, an INVALID_ARGUMENT error is returned.
//
// If the specified
// [Product.Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY]
// [Product][google.cloud.retail.v2.Product] or
// [Product.Type.COLLECTION][google.cloud.retail.v2.Product.Type.COLLECTION]
// [Product][google.cloud.retail.v2.Product] does not exist, a NOT_FOUND error
// is returned.
Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
// The fields of [Product][google.cloud.retail.v2.Product] to return in the
// responses. If not set or empty, the following fields are returned:
//
// * [Product.name][google.cloud.retail.v2.Product.name]
// * [Product.id][google.cloud.retail.v2.Product.id]
// * [Product.title][google.cloud.retail.v2.Product.title]
// * [Product.uri][google.cloud.retail.v2.Product.uri]
// * [Product.images][google.cloud.retail.v2.Product.images]
// * [Product.price_info][google.cloud.retail.v2.Product.price_info]
// * [Product.brands][google.cloud.retail.v2.Product.brands]
//
// If "*" is provided, all fields are returned.
// [Product.name][google.cloud.retail.v2.Product.name] is always returned no
// matter what mask is set.
//
// If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
// is returned.
ReadMask *fieldmaskpb.FieldMask `protobuf:"bytes,5,opt,name=read_mask,json=readMask,proto3" json:"read_mask,omitempty"`
}
func (x *ListProductsRequest) Reset() {
*x = ListProductsRequest{}
if protoimpl.UnsafeEnabled {
mi := &file_google_cloud_retail_v2_product_service_proto_msgTypes[4]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *ListProductsRequest) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*ListProductsRequest) ProtoMessage() {}
func (x *ListProductsRequest) ProtoReflect() protoreflect.Message {
mi := &file_google_cloud_retail_v2_product_service_proto_msgTypes[4]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use ListProductsRequest.ProtoReflect.Descriptor instead.
func (*ListProductsRequest) Descriptor() ([]byte, []int) {
return file_google_cloud_retail_v2_product_service_proto_rawDescGZIP(), []int{4}
}
func (x *ListProductsRequest) GetParent() string {
if x != nil {
return x.Parent
}
return ""
}
func (x *ListProductsRequest) GetPageSize() int32 {
if x != nil {
return x.PageSize
}
return 0
}
func (x *ListProductsRequest) GetPageToken() string {
if x != nil {
return x.PageToken
}
return ""
}
func (x *ListProductsRequest) GetFilter() string {
if x != nil {
return x.Filter
}
return ""
}
func (x *ListProductsRequest) GetReadMask() *fieldmaskpb.FieldMask {
if x != nil {
return x.ReadMask
}
return nil
}
// Response message for
// [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts]
// method.
type ListProductsResponse struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// The [Product][google.cloud.retail.v2.Product]s.
Products []*Product `protobuf:"bytes,1,rep,name=products,proto3" json:"products,omitempty"`
// A token that can be sent as
// [ListProductsRequest.page_token][google.cloud.retail.v2.ListProductsRequest.page_token]
// to retrieve the next page. If this field is omitted, there are no
// subsequent pages.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
}
func (x *ListProductsResponse) Reset() {
*x = ListProductsResponse{}
if protoimpl.UnsafeEnabled {
mi := &file_google_cloud_retail_v2_product_service_proto_msgTypes[5]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *ListProductsResponse) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*ListProductsResponse) ProtoMessage() {}
func (x *ListProductsResponse) ProtoReflect() protoreflect.Message {
mi := &file_google_cloud_retail_v2_product_service_proto_msgTypes[5]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use ListProductsResponse.ProtoReflect.Descriptor instead.
func (*ListProductsResponse) Descriptor() ([]byte, []int) {
return file_google_cloud_retail_v2_product_service_proto_rawDescGZIP(), []int{5}
}
func (x *ListProductsResponse) GetProducts() []*Product {
if x != nil {
return x.Products
}
return nil
}
func (x *ListProductsResponse) GetNextPageToken() string {
if x != nil {
return x.NextPageToken
}
return ""
}
// Request message for
// [ProductService.SetInventory][google.cloud.retail.v2.ProductService.SetInventory]
// method.
type SetInventoryRequest struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// Required. The inventory information to update. The allowable fields to
// update are:
//
// * [Product.price_info][google.cloud.retail.v2.Product.price_info]
// * [Product.availability][google.cloud.retail.v2.Product.availability]
// * [Product.available_quantity][google.cloud.retail.v2.Product.available_quantity]
// * [Product.fulfillment_info][google.cloud.retail.v2.Product.fulfillment_info]
// The updated inventory fields must be specified in
// [SetInventoryRequest.set_mask][google.cloud.retail.v2.SetInventoryRequest.set_mask].
//
// If
// [SetInventoryRequest.inventory.name][google.cloud.retail.v2.Product.name]
// is empty or invalid, an INVALID_ARGUMENT error is returned.
//
// If the caller does not have permission to update the
// [Product][google.cloud.retail.v2.Product] named in
// [Product.name][google.cloud.retail.v2.Product.name], regardless of whether
// or not it exists, a PERMISSION_DENIED error is returned.
//
// If the [Product][google.cloud.retail.v2.Product] to update does not have
// existing inventory information, the provided inventory information will be
// inserted.
//
// If the [Product][google.cloud.retail.v2.Product] to update has existing
// inventory information, the provided inventory information will be merged
// while respecting the last update time for each inventory field, using the
// provided or default value for
// [SetInventoryRequest.set_time][google.cloud.retail.v2.SetInventoryRequest.set_time].
//
// The caller can replace place IDs for a subset of fulfillment types in the
// following ways:
//
// * Adds "fulfillment_info" in
// [SetInventoryRequest.set_mask][google.cloud.retail.v2.SetInventoryRequest.set_mask]
// * Specifies only the desired fulfillment types and corresponding place IDs
// to update in
// [SetInventoryRequest.inventory.fulfillment_info][google.cloud.retail.v2.Product.fulfillment_info]
//
// The caller can clear all place IDs from a subset of fulfillment types in
// the following ways:
//
// * Adds "fulfillment_info" in
// [SetInventoryRequest.set_mask][google.cloud.retail.v2.SetInventoryRequest.set_mask]
// * Specifies only the desired fulfillment types to clear in
// [SetInventoryRequest.inventory.fulfillment_info][google.cloud.retail.v2.Product.fulfillment_info]
// * Checks that only the desired fulfillment info types have empty
// [SetInventoryRequest.inventory.fulfillment_info.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids]
//
// The last update time is recorded for the following inventory fields:
// * [Product.price_info][google.cloud.retail.v2.Product.price_info]
// * [Product.availability][google.cloud.retail.v2.Product.availability]
// * [Product.available_quantity][google.cloud.retail.v2.Product.available_quantity]
// * [Product.fulfillment_info][google.cloud.retail.v2.Product.fulfillment_info]
//
// If a full overwrite of inventory information while ignoring timestamps is
// needed,
// [ProductService.UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct]
// should be invoked instead.
Inventory *Product `protobuf:"bytes,1,opt,name=inventory,proto3" json:"inventory,omitempty"`
// Indicates which inventory fields in the provided
// [Product][google.cloud.retail.v2.Product] to update.
//
// At least one field must be provided.
//
// If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
// is returned and the entire update will be ignored.
SetMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=set_mask,json=setMask,proto3" json:"set_mask,omitempty"`
// The time when the request is issued, used to prevent
// out-of-order updates on inventory fields with the last update time
// recorded. If not provided, the internal system time will be used.
SetTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=set_time,json=setTime,proto3" json:"set_time,omitempty"`
// If set to true, and the [Product][google.cloud.retail.v2.Product] with name
// [Product.name][google.cloud.retail.v2.Product.name] is not found, the
// inventory update will still be processed and retained for at most 1 day
// until the [Product][google.cloud.retail.v2.Product] is created. If set to
// false, a NOT_FOUND error is returned if the
// [Product][google.cloud.retail.v2.Product] is not found.
AllowMissing bool `protobuf:"varint,4,opt,name=allow_missing,json=allowMissing,proto3" json:"allow_missing,omitempty"`
}
func (x *SetInventoryRequest) Reset() {
*x = SetInventoryRequest{}
if protoimpl.UnsafeEnabled {
mi := &file_google_cloud_retail_v2_product_service_proto_msgTypes[6]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *SetInventoryRequest) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*SetInventoryRequest) ProtoMessage() {}
func (x *SetInventoryRequest) ProtoReflect() protoreflect.Message {
mi := &file_google_cloud_retail_v2_product_service_proto_msgTypes[6]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use SetInventoryRequest.ProtoReflect.Descriptor instead.
func (*SetInventoryRequest) Descriptor() ([]byte, []int) {
return file_google_cloud_retail_v2_product_service_proto_rawDescGZIP(), []int{6}
}
func (x *SetInventoryRequest) GetInventory() *Product {
if x != nil {
return x.Inventory
}
return nil
}
func (x *SetInventoryRequest) GetSetMask() *fieldmaskpb.FieldMask {
if x != nil {
return x.SetMask
}
return nil
}
func (x *SetInventoryRequest) GetSetTime() *timestamppb.Timestamp {
if x != nil {
return x.SetTime
}
return nil
}
func (x *SetInventoryRequest) GetAllowMissing() bool {
if x != nil {
return x.AllowMissing
}
return false
}
// Metadata related to the progress of the SetInventory operation.
// Currently empty because there is no meaningful metadata populated from the
// [ProductService.SetInventory][google.cloud.retail.v2.ProductService.SetInventory]
// method.
type SetInventoryMetadata struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
}
func (x *SetInventoryMetadata) Reset() {
*x = SetInventoryMetadata{}
if protoimpl.UnsafeEnabled {
mi := &file_google_cloud_retail_v2_product_service_proto_msgTypes[7]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *SetInventoryMetadata) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*SetInventoryMetadata) ProtoMessage() {}
func (x *SetInventoryMetadata) ProtoReflect() protoreflect.Message {
mi := &file_google_cloud_retail_v2_product_service_proto_msgTypes[7]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use SetInventoryMetadata.ProtoReflect.Descriptor instead.
func (*SetInventoryMetadata) Descriptor() ([]byte, []int) {
return file_google_cloud_retail_v2_product_service_proto_rawDescGZIP(), []int{7}
}
// Response of the SetInventoryRequest. Currently empty because
// there is no meaningful response populated from the
// [ProductService.SetInventory][google.cloud.retail.v2.ProductService.SetInventory]
// method.
type SetInventoryResponse struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
}
func (x *SetInventoryResponse) Reset() {
*x = SetInventoryResponse{}
if protoimpl.UnsafeEnabled {
mi := &file_google_cloud_retail_v2_product_service_proto_msgTypes[8]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *SetInventoryResponse) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*SetInventoryResponse) ProtoMessage() {}
func (x *SetInventoryResponse) ProtoReflect() protoreflect.Message {
mi := &file_google_cloud_retail_v2_product_service_proto_msgTypes[8]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use SetInventoryResponse.ProtoReflect.Descriptor instead.
func (*SetInventoryResponse) Descriptor() ([]byte, []int) {
return file_google_cloud_retail_v2_product_service_proto_rawDescGZIP(), []int{8}
}
// Request message for
// [ProductService.AddFulfillmentPlaces][google.cloud.retail.v2.ProductService.AddFulfillmentPlaces]
// method.
type AddFulfillmentPlacesRequest struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// Required. Full resource name of [Product][google.cloud.retail.v2.Product],
// such as
// `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`.
//
// 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.
Product string `protobuf:"bytes,1,opt,name=product,proto3" json:"product,omitempty"`
// Required. The fulfillment type, including commonly used types (such as
// pickup in store and same day delivery), and custom types.
//
// Supported values:
//
// * "pickup-in-store"
// * "ship-to-store"
// * "same-day-delivery"
// * "next-day-delivery"
// * "custom-type-1"
// * "custom-type-2"
// * "custom-type-3"
// * "custom-type-4"
// * "custom-type-5"
//
// If this field is set to an invalid value other than these, an
// INVALID_ARGUMENT error is returned.
//
// This field directly corresponds to
// [Product.fulfillment_info.type][google.cloud.retail.v2.FulfillmentInfo.type].
Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
// Required. The IDs for this
// [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type], such as
// the store IDs for "pickup-in-store" or the region IDs for
// "same-day-delivery" to be added for this
// [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type]. Duplicate
// IDs will be automatically ignored.
//
// At least 1 value is required, and a maximum of 2000 values are allowed.
// Each value must be a string with a length limit of 10 characters, matching
// the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
// INVALID_ARGUMENT error is returned.
//
// If the total number of place IDs exceeds 2000 for this
// [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type] after
// adding, then the update will be rejected.
PlaceIds []string `protobuf:"bytes,3,rep,name=place_ids,json=placeIds,proto3" json:"place_ids,omitempty"`
// The time when the fulfillment updates are issued, used to prevent
// out-of-order updates on fulfillment information. If not provided, the
// internal system time will be used.
AddTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=add_time,json=addTime,proto3" json:"add_time,omitempty"`
// If set to true, and the [Product][google.cloud.retail.v2.Product] is not
// found, the fulfillment information will still be processed and retained for
// at most 1 day and processed once the
// [Product][google.cloud.retail.v2.Product] is created. If set to false, a
// NOT_FOUND error is returned if the
// [Product][google.cloud.retail.v2.Product] is not found.
AllowMissing bool `protobuf:"varint,5,opt,name=allow_missing,json=allowMissing,proto3" json:"allow_missing,omitempty"`
}
func (x *AddFulfillmentPlacesRequest) Reset() {
*x = AddFulfillmentPlacesRequest{}
if protoimpl.UnsafeEnabled {
mi := &file_google_cloud_retail_v2_product_service_proto_msgTypes[9]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *AddFulfillmentPlacesRequest) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*AddFulfillmentPlacesRequest) ProtoMessage() {}
func (x *AddFulfillmentPlacesRequest) ProtoReflect() protoreflect.Message {
mi := &file_google_cloud_retail_v2_product_service_proto_msgTypes[9]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use AddFulfillmentPlacesRequest.ProtoReflect.Descriptor instead.
func (*AddFulfillmentPlacesRequest) Descriptor() ([]byte, []int) {
return file_google_cloud_retail_v2_product_service_proto_rawDescGZIP(), []int{9}
}
func (x *AddFulfillmentPlacesRequest) GetProduct() string {
if x != nil {
return x.Product
}
return ""
}
func (x *AddFulfillmentPlacesRequest) GetType() string {
if x != nil {
return x.Type
}
return ""
}
func (x *AddFulfillmentPlacesRequest) GetPlaceIds() []string {
if x != nil {
return x.PlaceIds
}
return nil
}
func (x *AddFulfillmentPlacesRequest) GetAddTime() *timestamppb.Timestamp {
if x != nil {
return x.AddTime
}
return nil
}
func (x *AddFulfillmentPlacesRequest) GetAllowMissing() bool {
if x != nil {
return x.AllowMissing
}
return false
}
// Metadata related to the progress of the AddFulfillmentPlaces operation.
// Currently empty because there is no meaningful metadata populated from the
// [ProductService.AddFulfillmentPlaces][google.cloud.retail.v2.ProductService.AddFulfillmentPlaces]
// method.
type AddFulfillmentPlacesMetadata struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
}
func (x *AddFulfillmentPlacesMetadata) Reset() {
*x = AddFulfillmentPlacesMetadata{}
if protoimpl.UnsafeEnabled {
mi := &file_google_cloud_retail_v2_product_service_proto_msgTypes[10]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *AddFulfillmentPlacesMetadata) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*AddFulfillmentPlacesMetadata) ProtoMessage() {}
func (x *AddFulfillmentPlacesMetadata) ProtoReflect() protoreflect.Message {
mi := &file_google_cloud_retail_v2_product_service_proto_msgTypes[10]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use AddFulfillmentPlacesMetadata.ProtoReflect.Descriptor instead.
func (*AddFulfillmentPlacesMetadata) Descriptor() ([]byte, []int) {
return file_google_cloud_retail_v2_product_service_proto_rawDescGZIP(), []int{10}
}
// Response of the AddFulfillmentPlacesRequest. Currently empty because
// there is no meaningful response populated from the
// [ProductService.AddFulfillmentPlaces][google.cloud.retail.v2.ProductService.AddFulfillmentPlaces]
// method.
type AddFulfillmentPlacesResponse struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
}
func (x *AddFulfillmentPlacesResponse) Reset() {
*x = AddFulfillmentPlacesResponse{}
if protoimpl.UnsafeEnabled {
mi := &file_google_cloud_retail_v2_product_service_proto_msgTypes[11]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *AddFulfillmentPlacesResponse) String() string {
return protoimpl.X.MessageStringOf(x)
}