-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
discoveryengine-gen.go
5734 lines (5177 loc) · 238 KB
/
discoveryengine-gen.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 2023 Google LLC.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
// Code generated file. DO NOT EDIT.
// Package discoveryengine provides access to the Discovery Engine API.
//
// For product documentation, see: https://cloud.google.com/discovery-engine/docs
//
// # Creating a client
//
// Usage example:
//
// import "google.golang.org/api/discoveryengine/v1beta"
// ...
// ctx := context.Background()
// discoveryengineService, err := discoveryengine.NewService(ctx)
//
// In this example, Google Application Default Credentials are used for authentication.
//
// For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.
//
// # Other authentication options
//
// To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:
//
// discoveryengineService, err := discoveryengine.NewService(ctx, option.WithAPIKey("AIza..."))
//
// To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource:
//
// config := &oauth2.Config{...}
// // ...
// token, err := config.Exchange(ctx, ...)
// discoveryengineService, err := discoveryengine.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
//
// See https://godoc.org/google.golang.org/api/option/ for details on options.
package discoveryengine // import "google.golang.org/api/discoveryengine/v1beta"
import (
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"io"
"net/http"
"net/url"
"strconv"
"strings"
googleapi "google.golang.org/api/googleapi"
internal "google.golang.org/api/internal"
gensupport "google.golang.org/api/internal/gensupport"
option "google.golang.org/api/option"
internaloption "google.golang.org/api/option/internaloption"
htransport "google.golang.org/api/transport/http"
)
// Always reference these packages, just in case the auto-generated code
// below doesn't.
var _ = bytes.NewBuffer
var _ = strconv.Itoa
var _ = fmt.Sprintf
var _ = json.NewDecoder
var _ = io.Copy
var _ = url.Parse
var _ = gensupport.MarshalJSON
var _ = googleapi.Version
var _ = errors.New
var _ = strings.Replace
var _ = context.Canceled
var _ = internaloption.WithDefaultEndpoint
const apiId = "discoveryengine:v1beta"
const apiName = "discoveryengine"
const apiVersion = "v1beta"
const basePath = "https://discoveryengine.googleapis.com/"
const mtlsBasePath = "https://discoveryengine.mtls.googleapis.com/"
// OAuth2 scopes used by this API.
const (
// See, edit, configure, and delete your Google Cloud data and see the
// email address for your Google Account.
CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
)
// NewService creates a new Service.
func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error) {
scopesOption := internaloption.WithDefaultScopes(
"https://www.googleapis.com/auth/cloud-platform",
)
// NOTE: prepend, so we don't override user-specified scopes.
opts = append([]option.ClientOption{scopesOption}, opts...)
opts = append(opts, internaloption.WithDefaultEndpoint(basePath))
opts = append(opts, internaloption.WithDefaultMTLSEndpoint(mtlsBasePath))
client, endpoint, err := htransport.NewClient(ctx, opts...)
if err != nil {
return nil, err
}
s, err := New(client)
if err != nil {
return nil, err
}
if endpoint != "" {
s.BasePath = endpoint
}
return s, nil
}
// New creates a new Service. It uses the provided http.Client for requests.
//
// Deprecated: please use NewService instead.
// To provide a custom HTTP client, use option.WithHTTPClient.
// If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
func New(client *http.Client) (*Service, error) {
if client == nil {
return nil, errors.New("client is nil")
}
s := &Service{client: client, BasePath: basePath}
s.Projects = NewProjectsService(s)
return s, nil
}
type Service struct {
client *http.Client
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
Projects *ProjectsService
}
func (s *Service) userAgent() string {
if s.UserAgent == "" {
return googleapi.UserAgent
}
return googleapi.UserAgent + " " + s.UserAgent
}
func NewProjectsService(s *Service) *ProjectsService {
rs := &ProjectsService{s: s}
rs.Locations = NewProjectsLocationsService(s)
rs.Operations = NewProjectsOperationsService(s)
return rs
}
type ProjectsService struct {
s *Service
Locations *ProjectsLocationsService
Operations *ProjectsOperationsService
}
func NewProjectsLocationsService(s *Service) *ProjectsLocationsService {
rs := &ProjectsLocationsService{s: s}
rs.DataStores = NewProjectsLocationsDataStoresService(s)
rs.Operations = NewProjectsLocationsOperationsService(s)
return rs
}
type ProjectsLocationsService struct {
s *Service
DataStores *ProjectsLocationsDataStoresService
Operations *ProjectsLocationsOperationsService
}
func NewProjectsLocationsDataStoresService(s *Service) *ProjectsLocationsDataStoresService {
rs := &ProjectsLocationsDataStoresService{s: s}
rs.Branches = NewProjectsLocationsDataStoresBranchesService(s)
rs.Models = NewProjectsLocationsDataStoresModelsService(s)
rs.Operations = NewProjectsLocationsDataStoresOperationsService(s)
rs.ServingConfigs = NewProjectsLocationsDataStoresServingConfigsService(s)
rs.UserEvents = NewProjectsLocationsDataStoresUserEventsService(s)
return rs
}
type ProjectsLocationsDataStoresService struct {
s *Service
Branches *ProjectsLocationsDataStoresBranchesService
Models *ProjectsLocationsDataStoresModelsService
Operations *ProjectsLocationsDataStoresOperationsService
ServingConfigs *ProjectsLocationsDataStoresServingConfigsService
UserEvents *ProjectsLocationsDataStoresUserEventsService
}
func NewProjectsLocationsDataStoresBranchesService(s *Service) *ProjectsLocationsDataStoresBranchesService {
rs := &ProjectsLocationsDataStoresBranchesService{s: s}
rs.Documents = NewProjectsLocationsDataStoresBranchesDocumentsService(s)
rs.Operations = NewProjectsLocationsDataStoresBranchesOperationsService(s)
return rs
}
type ProjectsLocationsDataStoresBranchesService struct {
s *Service
Documents *ProjectsLocationsDataStoresBranchesDocumentsService
Operations *ProjectsLocationsDataStoresBranchesOperationsService
}
func NewProjectsLocationsDataStoresBranchesDocumentsService(s *Service) *ProjectsLocationsDataStoresBranchesDocumentsService {
rs := &ProjectsLocationsDataStoresBranchesDocumentsService{s: s}
return rs
}
type ProjectsLocationsDataStoresBranchesDocumentsService struct {
s *Service
}
func NewProjectsLocationsDataStoresBranchesOperationsService(s *Service) *ProjectsLocationsDataStoresBranchesOperationsService {
rs := &ProjectsLocationsDataStoresBranchesOperationsService{s: s}
return rs
}
type ProjectsLocationsDataStoresBranchesOperationsService struct {
s *Service
}
func NewProjectsLocationsDataStoresModelsService(s *Service) *ProjectsLocationsDataStoresModelsService {
rs := &ProjectsLocationsDataStoresModelsService{s: s}
rs.Operations = NewProjectsLocationsDataStoresModelsOperationsService(s)
return rs
}
type ProjectsLocationsDataStoresModelsService struct {
s *Service
Operations *ProjectsLocationsDataStoresModelsOperationsService
}
func NewProjectsLocationsDataStoresModelsOperationsService(s *Service) *ProjectsLocationsDataStoresModelsOperationsService {
rs := &ProjectsLocationsDataStoresModelsOperationsService{s: s}
return rs
}
type ProjectsLocationsDataStoresModelsOperationsService struct {
s *Service
}
func NewProjectsLocationsDataStoresOperationsService(s *Service) *ProjectsLocationsDataStoresOperationsService {
rs := &ProjectsLocationsDataStoresOperationsService{s: s}
return rs
}
type ProjectsLocationsDataStoresOperationsService struct {
s *Service
}
func NewProjectsLocationsDataStoresServingConfigsService(s *Service) *ProjectsLocationsDataStoresServingConfigsService {
rs := &ProjectsLocationsDataStoresServingConfigsService{s: s}
return rs
}
type ProjectsLocationsDataStoresServingConfigsService struct {
s *Service
}
func NewProjectsLocationsDataStoresUserEventsService(s *Service) *ProjectsLocationsDataStoresUserEventsService {
rs := &ProjectsLocationsDataStoresUserEventsService{s: s}
return rs
}
type ProjectsLocationsDataStoresUserEventsService struct {
s *Service
}
func NewProjectsLocationsOperationsService(s *Service) *ProjectsLocationsOperationsService {
rs := &ProjectsLocationsOperationsService{s: s}
return rs
}
type ProjectsLocationsOperationsService struct {
s *Service
}
func NewProjectsOperationsService(s *Service) *ProjectsOperationsService {
rs := &ProjectsOperationsService{s: s}
return rs
}
type ProjectsOperationsService struct {
s *Service
}
// GoogleApiHttpBody: Message that represents an arbitrary HTTP body. It
// should only be used for payload formats that can't be represented as
// JSON, such as raw binary or an HTML page. This message can be used
// both in streaming and non-streaming API methods in the request as
// well as the response. It can be used as a top-level request field,
// which is convenient if one wants to extract parameters from either
// the URL or HTTP template into the request fields and also want access
// to the raw HTTP body. Example: message GetResourceRequest { // A
// unique request id. string request_id = 1; // The raw HTTP body is
// bound to this field. google.api.HttpBody http_body = 2; } service
// ResourceService { rpc GetResource(GetResourceRequest) returns
// (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody)
// returns (google.protobuf.Empty); } Example with streaming methods:
// service CaldavService { rpc GetCalendar(stream google.api.HttpBody)
// returns (stream google.api.HttpBody); rpc UpdateCalendar(stream
// google.api.HttpBody) returns (stream google.api.HttpBody); } Use of
// this type only changes how the request and response bodies are
// handled, all other features will continue to work unchanged.
type GoogleApiHttpBody struct {
// ContentType: The HTTP Content-Type header value specifying the
// content type of the body.
ContentType string `json:"contentType,omitempty"`
// Data: The HTTP request/response body as raw binary.
Data string `json:"data,omitempty"`
// Extensions: Application specific response metadata. Must be set in
// the first response for streaming APIs.
Extensions []googleapi.RawMessage `json:"extensions,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "ContentType") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ContentType") to include
// in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *GoogleApiHttpBody) MarshalJSON() ([]byte, error) {
type NoMethod GoogleApiHttpBody
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleCloudDiscoveryengineLoggingErrorContext: A description of the
// context in which an error occurred.
type GoogleCloudDiscoveryengineLoggingErrorContext struct {
// HttpRequest: The HTTP request which was processed when the error was
// triggered.
HttpRequest *GoogleCloudDiscoveryengineLoggingHttpRequestContext `json:"httpRequest,omitempty"`
// ReportLocation: The location in the source code where the decision
// was made to report the error, usually the place where it was logged.
ReportLocation *GoogleCloudDiscoveryengineLoggingSourceLocation `json:"reportLocation,omitempty"`
// ForceSendFields is a list of field names (e.g. "HttpRequest") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "HttpRequest") to include
// in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *GoogleCloudDiscoveryengineLoggingErrorContext) MarshalJSON() ([]byte, error) {
type NoMethod GoogleCloudDiscoveryengineLoggingErrorContext
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleCloudDiscoveryengineLoggingErrorLog: An error log which is
// reported to the Error Reporting system.
type GoogleCloudDiscoveryengineLoggingErrorLog struct {
// Context: A description of the context in which the error occurred.
Context *GoogleCloudDiscoveryengineLoggingErrorContext `json:"context,omitempty"`
// ImportPayload: The error payload that is populated on LRO import
// APIs.
ImportPayload *GoogleCloudDiscoveryengineLoggingImportErrorContext `json:"importPayload,omitempty"`
// Message: A message describing the error.
Message string `json:"message,omitempty"`
// RequestPayload: The API request payload, represented as a protocol
// buffer. Most API request types are supported. For example:
// "type.googleapis.com/google.cloud.discoveryengine.v1alpha.DocumentServ
// ice.CreateDocumentRequest"
// "type.googleapis.com/google.cloud.discoveryengine.v1alpha.UserEventSer
// vice.WriteUserEventRequest"
RequestPayload googleapi.RawMessage `json:"requestPayload,omitempty"`
// ResponsePayload: The API response payload, represented as a protocol
// buffer. This is used to log some "soft errors", where the response is
// valid but we consider there are some quality issues like unjoined
// events. The following API responses are supported and no PII is
// included:
// "google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend"
//
// "google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEvent"
//
// "google.cloud.discoveryengine.v1alpha.UserEventService.CollectUserEven
// t"
ResponsePayload googleapi.RawMessage `json:"responsePayload,omitempty"`
// ServiceContext: The service context in which this error has occurred.
ServiceContext *GoogleCloudDiscoveryengineLoggingServiceContext `json:"serviceContext,omitempty"`
// Status: The RPC status associated with the error log.
Status *GoogleRpcStatus `json:"status,omitempty"`
// ForceSendFields is a list of field names (e.g. "Context") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Context") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *GoogleCloudDiscoveryengineLoggingErrorLog) MarshalJSON() ([]byte, error) {
type NoMethod GoogleCloudDiscoveryengineLoggingErrorLog
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleCloudDiscoveryengineLoggingHttpRequestContext: HTTP request
// data that is related to a reported error.
type GoogleCloudDiscoveryengineLoggingHttpRequestContext struct {
// ResponseStatusCode: The HTTP response status code for the request.
ResponseStatusCode int64 `json:"responseStatusCode,omitempty"`
// ForceSendFields is a list of field names (e.g. "ResponseStatusCode")
// to unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ResponseStatusCode") to
// include in API requests with the JSON null value. By default, fields
// with empty values are omitted from API requests. However, any field
// with an empty value appearing in NullFields will be sent to the
// server as null. It is an error if a field in this list has a
// non-empty value. This may be used to include null fields in Patch
// requests.
NullFields []string `json:"-"`
}
func (s *GoogleCloudDiscoveryengineLoggingHttpRequestContext) MarshalJSON() ([]byte, error) {
type NoMethod GoogleCloudDiscoveryengineLoggingHttpRequestContext
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleCloudDiscoveryengineLoggingImportErrorContext: The error
// payload that is populated on LRO import APIs. Including:
// "google.cloud.discoveryengine.v1alpha.DocumentService.ImportDocuments"
//
// "google.cloud.discoveryengine.v1alpha.UserEventService.ImportUserEvent
// s"
type GoogleCloudDiscoveryengineLoggingImportErrorContext struct {
// Document: The detailed content which caused the error on importing a
// document.
Document string `json:"document,omitempty"`
// GcsPath: Google Cloud Storage file path of the import source. Can be
// set for batch operation error.
GcsPath string `json:"gcsPath,omitempty"`
// LineNumber: Line number of the content in file. Should be empty for
// permission or batch operation error.
LineNumber string `json:"lineNumber,omitempty"`
// Operation: The operation resource name of the LRO.
Operation string `json:"operation,omitempty"`
// UserEvent: The detailed content which caused the error on importing a
// user event.
UserEvent string `json:"userEvent,omitempty"`
// ForceSendFields is a list of field names (e.g. "Document") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Document") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *GoogleCloudDiscoveryengineLoggingImportErrorContext) MarshalJSON() ([]byte, error) {
type NoMethod GoogleCloudDiscoveryengineLoggingImportErrorContext
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleCloudDiscoveryengineLoggingServiceContext: Describes a running
// service that sends errors.
type GoogleCloudDiscoveryengineLoggingServiceContext struct {
// Service: An identifier of the service. For example,
// "discoveryengine.googleapis.com".
Service string `json:"service,omitempty"`
// ForceSendFields is a list of field names (e.g. "Service") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Service") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *GoogleCloudDiscoveryengineLoggingServiceContext) MarshalJSON() ([]byte, error) {
type NoMethod GoogleCloudDiscoveryengineLoggingServiceContext
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleCloudDiscoveryengineLoggingSourceLocation: Indicates a location
// in the source code of the service for which errors are reported.
type GoogleCloudDiscoveryengineLoggingSourceLocation struct {
// FunctionName: Human-readable name of a function or method. For
// example, "
// google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend".
FunctionName string `json:"functionName,omitempty"`
// ForceSendFields is a list of field names (e.g. "FunctionName") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "FunctionName") to include
// in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *GoogleCloudDiscoveryengineLoggingSourceLocation) MarshalJSON() ([]byte, error) {
type NoMethod GoogleCloudDiscoveryengineLoggingSourceLocation
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata: Metadata
// related to the progress of the ImportDocuments operation. This will
// be returned by the google.longrunning.Operation.metadata field.
type GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata struct {
// CreateTime: Operation create time.
CreateTime string `json:"createTime,omitempty"`
// FailureCount: Count of entries that encountered errors while
// processing.
FailureCount int64 `json:"failureCount,omitempty,string"`
// SuccessCount: Count of entries that were processed successfully.
SuccessCount int64 `json:"successCount,omitempty,string"`
// UpdateTime: Operation last update time. If the operation is done,
// this is also the finish time.
UpdateTime string `json:"updateTime,omitempty"`
// ForceSendFields is a list of field names (e.g. "CreateTime") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "CreateTime") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata) MarshalJSON() ([]byte, error) {
type NoMethod GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse: Response of
// the ImportDocumentsRequest. If the long running operation is done,
// then this message is returned by the
// google.longrunning.Operations.response field if the operation was
// successful.
type GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse struct {
// ErrorConfig: Echoes the destination for the complete errors in the
// request if set.
ErrorConfig *GoogleCloudDiscoveryengineV1alphaImportErrorConfig `json:"errorConfig,omitempty"`
// ErrorSamples: A sample of errors encountered while processing the
// request.
ErrorSamples []*GoogleRpcStatus `json:"errorSamples,omitempty"`
// ForceSendFields is a list of field names (e.g. "ErrorConfig") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ErrorConfig") to include
// in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse) MarshalJSON() ([]byte, error) {
type NoMethod GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleCloudDiscoveryengineV1alphaImportErrorConfig: Configuration of
// destination for Import related errors.
type GoogleCloudDiscoveryengineV1alphaImportErrorConfig struct {
// GcsPrefix: Cloud Storage prefix for import errors. This must be an
// empty, existing Cloud Storage directory. Import errors will be
// written to sharded files in this directory, one per line, as a
// JSON-encoded `google.rpc.Status` message.
GcsPrefix string `json:"gcsPrefix,omitempty"`
// ForceSendFields is a list of field names (e.g. "GcsPrefix") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "GcsPrefix") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *GoogleCloudDiscoveryengineV1alphaImportErrorConfig) MarshalJSON() ([]byte, error) {
type NoMethod GoogleCloudDiscoveryengineV1alphaImportErrorConfig
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata: Metadata
// related to the progress of the Import operation. This will be
// returned by the google.longrunning.Operation.metadata field.
type GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata struct {
// CreateTime: Operation create time.
CreateTime string `json:"createTime,omitempty"`
// FailureCount: Count of entries that encountered errors while
// processing.
FailureCount int64 `json:"failureCount,omitempty,string"`
// SuccessCount: Count of entries that were processed successfully.
SuccessCount int64 `json:"successCount,omitempty,string"`
// UpdateTime: Operation last update time. If the operation is done,
// this is also the finish time.
UpdateTime string `json:"updateTime,omitempty"`
// ForceSendFields is a list of field names (e.g. "CreateTime") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "CreateTime") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata) MarshalJSON() ([]byte, error) {
type NoMethod GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse: Response
// of the ImportUserEventsRequest. If the long running operation was
// successful, then this message is returned by the
// google.longrunning.Operations.response field if the operation was
// successful.
type GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse struct {
// ErrorConfig: Echoes the destination for the complete errors if this
// field was set in the request.
ErrorConfig *GoogleCloudDiscoveryengineV1alphaImportErrorConfig `json:"errorConfig,omitempty"`
// ErrorSamples: A sample of errors encountered while processing the
// request.
ErrorSamples []*GoogleRpcStatus `json:"errorSamples,omitempty"`
// JoinedEventsCount: Count of user events imported with complete
// existing Documents.
JoinedEventsCount int64 `json:"joinedEventsCount,omitempty,string"`
// UnjoinedEventsCount: Count of user events imported, but with Document
// information not found in the existing Branch.
UnjoinedEventsCount int64 `json:"unjoinedEventsCount,omitempty,string"`
// ForceSendFields is a list of field names (e.g. "ErrorConfig") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ErrorConfig") to include
// in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse) MarshalJSON() ([]byte, error) {
type NoMethod GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleCloudDiscoveryengineV1betaBigQuerySource: BigQuery source
// import data from.
type GoogleCloudDiscoveryengineV1betaBigQuerySource struct {
// DataSchema: The schema to use when parsing the data from the source.
// Supported values for imports: * `user_event` (default): One JSON
// UserEvent per line. * `document` (default): One JSON Document per
// line. Each document must have a valid document.id.
DataSchema string `json:"dataSchema,omitempty"`
// DatasetId: Required. The BigQuery data set to copy the data from with
// a length limit of 1,024 characters.
DatasetId string `json:"datasetId,omitempty"`
// GcsStagingDir: Intermediate Cloud Storage directory used for the
// import with a length limit of 2,000 characters. Can be specified if
// one wants to have the BigQuery export to a specific Cloud Storage
// directory.
GcsStagingDir string `json:"gcsStagingDir,omitempty"`
// PartitionDate: BigQuery time partitioned table's _PARTITIONDATE in
// YYYY-MM-DD format.
PartitionDate *GoogleTypeDate `json:"partitionDate,omitempty"`
// ProjectId: The project ID (can be project # or ID) that the BigQuery
// source is in with a length limit of 128 characters. If not specified,
// inherits the project ID from the parent request.
ProjectId string `json:"projectId,omitempty"`
// TableId: Required. The BigQuery table to copy the data from with a
// length limit of 1,024 characters.
TableId string `json:"tableId,omitempty"`
// ForceSendFields is a list of field names (e.g. "DataSchema") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DataSchema") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *GoogleCloudDiscoveryengineV1betaBigQuerySource) MarshalJSON() ([]byte, error) {
type NoMethod GoogleCloudDiscoveryengineV1betaBigQuerySource
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleCloudDiscoveryengineV1betaCompletionInfo: Detailed completion
// information including completion attribution token and clicked
// completion info.
type GoogleCloudDiscoveryengineV1betaCompletionInfo struct {
// SelectedPosition: End user selected
// CompleteQueryResponse.CompletionResult.suggestion position, starting
// from 0.
SelectedPosition int64 `json:"selectedPosition,omitempty"`
// SelectedSuggestion: End user selected
// CompleteQueryResponse.CompletionResult.suggestion.
SelectedSuggestion string `json:"selectedSuggestion,omitempty"`
// ForceSendFields is a list of field names (e.g. "SelectedPosition") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "SelectedPosition") to
// include in API requests with the JSON null value. By default, fields
// with empty values are omitted from API requests. However, any field
// with an empty value appearing in NullFields will be sent to the
// server as null. It is an error if a field in this list has a
// non-empty value. This may be used to include null fields in Patch
// requests.
NullFields []string `json:"-"`
}
func (s *GoogleCloudDiscoveryengineV1betaCompletionInfo) MarshalJSON() ([]byte, error) {
type NoMethod GoogleCloudDiscoveryengineV1betaCompletionInfo
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleCloudDiscoveryengineV1betaCustomAttribute: A custom attribute
// that is not explicitly modeled in a resource, e.g. UserEvent.
type GoogleCloudDiscoveryengineV1betaCustomAttribute struct {
// Numbers: The numerical values of this custom attribute. For example,
// `[2.3, 15.4]` when the key is "lengths_cm". Exactly one of text or
// numbers should be set. Otherwise, an INVALID_ARGUMENT error is
// returned.
Numbers []float64 `json:"numbers,omitempty"`
// Text: The textual values of this custom attribute. For example,
// `["yellow", "green"]` when the key is "color". Empty string is not
// allowed. Otherwise, an INVALID_ARGUMENT error is returned. Exactly
// one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT
// error is returned.
Text []string `json:"text,omitempty"`
// ForceSendFields is a list of field names (e.g. "Numbers") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Numbers") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *GoogleCloudDiscoveryengineV1betaCustomAttribute) MarshalJSON() ([]byte, error) {
type NoMethod GoogleCloudDiscoveryengineV1betaCustomAttribute
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleCloudDiscoveryengineV1betaDocument: Document captures all raw
// metadata information of items to be recommended or searched.
type GoogleCloudDiscoveryengineV1betaDocument struct {
// Id: Immutable. The identifier of the document. Id should conform to
// RFC-1034 (https://tools.ietf.org/html/rfc1034) standard with a length
// limit of 63 characters.
Id string `json:"id,omitempty"`
// JsonData: The JSON string representation of the document. It should
// conform to the registered schema or an INVALID_ARGUMENT error is
// thrown.
JsonData string `json:"jsonData,omitempty"`
// Name: Immutable. The full resource name of the document. Format:
// `projects/{project}/locations/{location}/dataStores/{data_store}/branc
// hes/{branch}/documents/{document_id}`. This field must be a UTF-8
// encoded string with a length limit of 1024 characters.
Name string `json:"name,omitempty"`
// ParentDocumentId: The identifier of the parent document. Currently
// supports at most two level document hierarchy. Id should conform to
// RFC-1034 (https://tools.ietf.org/html/rfc1034) standard with a length
// limit of 63 characters.
ParentDocumentId string `json:"parentDocumentId,omitempty"`
// SchemaId: Required. The identifier of the schema located in the same
// data store.
SchemaId string `json:"schemaId,omitempty"`
// StructData: The structured JSON data for the document. It should
// conform to the registered schema or an INVALID_ARGUMENT error is
// thrown.
StructData googleapi.RawMessage `json:"structData,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Id") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Id") to include in API
// requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *GoogleCloudDiscoveryengineV1betaDocument) MarshalJSON() ([]byte, error) {
type NoMethod GoogleCloudDiscoveryengineV1betaDocument
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleCloudDiscoveryengineV1betaDocumentInfo: Detailed document
// information associated with a user event.
type GoogleCloudDiscoveryengineV1betaDocumentInfo struct {
// Id: Required. The Document resource ID.
Id string `json:"id,omitempty"`
// Name: Required. The Document resource full name, of the form:
// projects//locations//dataStores//branches//documents/
Name string `json:"name,omitempty"`
// PromotionIds: The promotion IDs associated with this Document.
// Currently, this field is restricted to at most one ID.
PromotionIds []string `json:"promotionIds,omitempty"`
// Quantity: Quantity of the Document associated with the user event.
// Defaults to 1. For example, this field will be 2 if two quantities of
// the same Document are involved in a `add-to-cart` event. Required for
// events of the following event types: * `add-to-cart` * `purchase`
Quantity int64 `json:"quantity,omitempty"`
// ForceSendFields is a list of field names (e.g. "Id") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.