-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
datastore-gen.go
6000 lines (5374 loc) · 236 KB
/
datastore-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 datastore provides access to the Cloud Datastore API.
//
// This package is DEPRECATED. Use package cloud.google.com/go/datastore instead.
//
// For product documentation, see: https://cloud.google.com/datastore/
//
// # Creating a client
//
// Usage example:
//
// import "google.golang.org/api/datastore/v1"
// ...
// ctx := context.Background()
// datastoreService, err := datastore.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
//
// By default, all available scopes (see "Constants") are used to authenticate. To restrict scopes, use option.WithScopes:
//
// datastoreService, err := datastore.NewService(ctx, option.WithScopes(datastore.DatastoreScope))
//
// To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:
//
// datastoreService, err := datastore.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, ...)
// datastoreService, err := datastore.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
//
// See https://godoc.org/google.golang.org/api/option/ for details on options.
package datastore // import "google.golang.org/api/datastore/v1"
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 = "datastore:v1"
const apiName = "datastore"
const apiVersion = "v1"
const basePath = "https://datastore.googleapis.com/"
const mtlsBasePath = "https://datastore.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"
// View and manage your Google Cloud Datastore data
DatastoreScope = "https://www.googleapis.com/auth/datastore"
)
// 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",
"https://www.googleapis.com/auth/datastore",
)
// 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.Indexes = NewProjectsIndexesService(s)
rs.Operations = NewProjectsOperationsService(s)
return rs
}
type ProjectsService struct {
s *Service
Indexes *ProjectsIndexesService
Operations *ProjectsOperationsService
}
func NewProjectsIndexesService(s *Service) *ProjectsIndexesService {
rs := &ProjectsIndexesService{s: s}
return rs
}
type ProjectsIndexesService struct {
s *Service
}
func NewProjectsOperationsService(s *Service) *ProjectsOperationsService {
rs := &ProjectsOperationsService{s: s}
return rs
}
type ProjectsOperationsService struct {
s *Service
}
// Aggregation: Defines a aggregation that produces a single result.
type Aggregation struct {
// Alias: Optional. Optional name of the property to store the result of
// the aggregation. If not provided, Datastore will pick a default name
// following the format `property_`. For example: ``` AGGREGATE
// COUNT_UP_TO(1) AS count_up_to_1, COUNT_UP_TO(2), COUNT_UP_TO(3) AS
// count_up_to_3, COUNT_UP_TO(4) OVER ( ... ); ``` becomes: ```
// AGGREGATE COUNT_UP_TO(1) AS count_up_to_1, COUNT_UP_TO(2) AS
// property_1, COUNT_UP_TO(3) AS count_up_to_3, COUNT_UP_TO(4) AS
// property_2 OVER ( ... ); ``` Requires: * Must be unique across all
// aggregation aliases. * Conform to entity property name limitations.
Alias string `json:"alias,omitempty"`
// Count: Count aggregator.
Count *Count `json:"count,omitempty"`
// ForceSendFields is a list of field names (e.g. "Alias") 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. "Alias") 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 *Aggregation) MarshalJSON() ([]byte, error) {
type NoMethod Aggregation
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// AggregationQuery: Datastore query for running an aggregation over a
// Query.
type AggregationQuery struct {
// Aggregations: Optional. Series of aggregations to apply over the
// results of the `nested_query`. Requires: * A minimum of one and
// maximum of five aggregations per query.
Aggregations []*Aggregation `json:"aggregations,omitempty"`
// NestedQuery: Nested query for aggregation
NestedQuery *Query `json:"nestedQuery,omitempty"`
// ForceSendFields is a list of field names (e.g. "Aggregations") 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. "Aggregations") 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 *AggregationQuery) MarshalJSON() ([]byte, error) {
type NoMethod AggregationQuery
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// AggregationResult: The result of a single bucket from a Datastore
// aggregation query. The keys of `aggregate_properties` are the same
// for all results in an aggregation query, unlike entity queries which
// can have different fields present for each result.
type AggregationResult struct {
// AggregateProperties: The result of the aggregation functions, ex:
// `COUNT(*) AS total_entities`. The key is the alias assigned to the
// aggregation function on input and the size of this map equals the
// number of aggregation functions in the query.
AggregateProperties map[string]Value `json:"aggregateProperties,omitempty"`
// ForceSendFields is a list of field names (e.g. "AggregateProperties")
// 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. "AggregateProperties") 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 *AggregationResult) MarshalJSON() ([]byte, error) {
type NoMethod AggregationResult
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// AggregationResultBatch: A batch of aggregation results produced by an
// aggregation query.
type AggregationResultBatch struct {
// AggregationResults: The aggregation results for this batch.
AggregationResults []*AggregationResult `json:"aggregationResults,omitempty"`
// MoreResults: The state of the query after the current batch. Only
// COUNT(*) aggregations are supported in the initial launch. Therefore,
// expected result type is limited to `NO_MORE_RESULTS`.
//
// Possible values:
// "MORE_RESULTS_TYPE_UNSPECIFIED" - Unspecified. This value is never
// used.
// "NOT_FINISHED" - There may be additional batches to fetch from this
// query.
// "MORE_RESULTS_AFTER_LIMIT" - The query is finished, but there may
// be more results after the limit.
// "MORE_RESULTS_AFTER_CURSOR" - The query is finished, but there may
// be more results after the end cursor.
// "NO_MORE_RESULTS" - The query is finished, and there are no more
// results.
MoreResults string `json:"moreResults,omitempty"`
// ReadTime: Read timestamp this batch was returned from. In a single
// transaction, subsequent query result batches for the same query can
// have a greater timestamp. Each batch's read timestamp is valid for
// all preceding batches.
ReadTime string `json:"readTime,omitempty"`
// ForceSendFields is a list of field names (e.g. "AggregationResults")
// 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. "AggregationResults") 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 *AggregationResultBatch) MarshalJSON() ([]byte, error) {
type NoMethod AggregationResultBatch
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// AllocateIdsRequest: The request for Datastore.AllocateIds.
type AllocateIdsRequest struct {
// DatabaseId: The ID of the database against which to make the request.
// '(default)' is not allowed; please use empty string '' to refer the
// default database.
DatabaseId string `json:"databaseId,omitempty"`
// Keys: Required. A list of keys with incomplete key paths for which to
// allocate IDs. No key may be reserved/read-only.
Keys []*Key `json:"keys,omitempty"`
// ForceSendFields is a list of field names (e.g. "DatabaseId") 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. "DatabaseId") 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 *AllocateIdsRequest) MarshalJSON() ([]byte, error) {
type NoMethod AllocateIdsRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// AllocateIdsResponse: The response for Datastore.AllocateIds.
type AllocateIdsResponse struct {
// Keys: The keys specified in the request (in the same order), each
// with its key path completed with a newly allocated ID.
Keys []*Key `json:"keys,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Keys") 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. "Keys") 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 *AllocateIdsResponse) MarshalJSON() ([]byte, error) {
type NoMethod AllocateIdsResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// ArrayValue: An array value.
type ArrayValue struct {
// Values: Values in the array. The order of values in an array is
// preserved as long as all values have identical settings for
// 'exclude_from_indexes'.
Values []*Value `json:"values,omitempty"`
// ForceSendFields is a list of field names (e.g. "Values") 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. "Values") 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 *ArrayValue) MarshalJSON() ([]byte, error) {
type NoMethod ArrayValue
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// BeginTransactionRequest: The request for Datastore.BeginTransaction.
type BeginTransactionRequest struct {
// DatabaseId: The ID of the database against which to make the request.
// '(default)' is not allowed; please use empty string '' to refer the
// default database.
DatabaseId string `json:"databaseId,omitempty"`
// TransactionOptions: Options for a new transaction.
TransactionOptions *TransactionOptions `json:"transactionOptions,omitempty"`
// ForceSendFields is a list of field names (e.g. "DatabaseId") 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. "DatabaseId") 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 *BeginTransactionRequest) MarshalJSON() ([]byte, error) {
type NoMethod BeginTransactionRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// BeginTransactionResponse: The response for
// Datastore.BeginTransaction.
type BeginTransactionResponse struct {
// Transaction: The transaction identifier (always present).
Transaction string `json:"transaction,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Transaction") 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. "Transaction") 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 *BeginTransactionResponse) MarshalJSON() ([]byte, error) {
type NoMethod BeginTransactionResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// CommitRequest: The request for Datastore.Commit.
type CommitRequest struct {
// DatabaseId: The ID of the database against which to make the request.
// '(default)' is not allowed; please use empty string '' to refer the
// default database.
DatabaseId string `json:"databaseId,omitempty"`
// Mode: The type of commit to perform. Defaults to `TRANSACTIONAL`.
//
// Possible values:
// "MODE_UNSPECIFIED" - Unspecified. This value must not be used.
// "TRANSACTIONAL" - Transactional: The mutations are either all
// applied, or none are applied. Learn about transactions
// [here](https://cloud.google.com/datastore/docs/concepts/transactions).
// "NON_TRANSACTIONAL" - Non-transactional: The mutations may not
// apply as all or none.
Mode string `json:"mode,omitempty"`
// Mutations: The mutations to perform. When mode is `TRANSACTIONAL`,
// mutations affecting a single entity are applied in order. The
// following sequences of mutations affecting a single entity are not
// permitted in a single `Commit` request: - `insert` followed by
// `insert` - `update` followed by `insert` - `upsert` followed by
// `insert` - `delete` followed by `update` When mode is
// `NON_TRANSACTIONAL`, no two mutations may affect a single entity.
Mutations []*Mutation `json:"mutations,omitempty"`
// Transaction: The identifier of the transaction associated with the
// commit. A transaction identifier is returned by a call to
// Datastore.BeginTransaction.
Transaction string `json:"transaction,omitempty"`
// ForceSendFields is a list of field names (e.g. "DatabaseId") 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. "DatabaseId") 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 *CommitRequest) MarshalJSON() ([]byte, error) {
type NoMethod CommitRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// CommitResponse: The response for Datastore.Commit.
type CommitResponse struct {
// CommitTime: The transaction commit timestamp. Not set for
// non-transactional commits.
CommitTime string `json:"commitTime,omitempty"`
// IndexUpdates: The number of index entries updated during the commit,
// or zero if none were updated.
IndexUpdates int64 `json:"indexUpdates,omitempty"`
// MutationResults: The result of performing the mutations. The i-th
// mutation result corresponds to the i-th mutation in the request.
MutationResults []*MutationResult `json:"mutationResults,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "CommitTime") 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. "CommitTime") 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 *CommitResponse) MarshalJSON() ([]byte, error) {
type NoMethod CommitResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// CompositeFilter: A filter that merges multiple other filters using
// the given operator.
type CompositeFilter struct {
// Filters: The list of filters to combine. Requires: * At least one
// filter is present.
Filters []*Filter `json:"filters,omitempty"`
// Op: The operator for combining multiple filters.
//
// Possible values:
// "OPERATOR_UNSPECIFIED" - Unspecified. This value must not be used.
// "AND" - The results are required to satisfy each of the combined
// filters.
Op string `json:"op,omitempty"`
// ForceSendFields is a list of field names (e.g. "Filters") 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. "Filters") 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 *CompositeFilter) MarshalJSON() ([]byte, error) {
type NoMethod CompositeFilter
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Count: Count of entities that match the query. The `COUNT(*)`
// aggregation function operates on the entire entity so it does not
// require a field reference.
type Count struct {
// UpTo: Optional. Optional constraint on the maximum number of entities
// to count. This provides a way to set an upper bound on the number of
// entities to scan, limiting latency and cost. Unspecified is
// interpreted as no bound. If a zero value is provided, a count result
// of zero should always be expected. High-Level Example: ``` AGGREGATE
// COUNT_UP_TO(1000) OVER ( SELECT * FROM k ); ``` Requires: * Must be
// non-negative when present.
UpTo int64 `json:"upTo,omitempty,string"`
// ForceSendFields is a list of field names (e.g. "UpTo") 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. "UpTo") 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 *Count) MarshalJSON() ([]byte, error) {
type NoMethod Count
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Empty: A generic empty message that you can re-use to avoid defining
// duplicated empty messages in your APIs. A typical example is to use
// it as the request or the response type of an API method. For
// instance: service Foo { rpc Bar(google.protobuf.Empty) returns
// (google.protobuf.Empty); }
type Empty struct {
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
}
// Entity: A Datastore data object. An entity is limited to 1 megabyte
// when stored. That _roughly_ corresponds to a limit of 1 megabyte for
// the serialized form of this message.
type Entity struct {
// Key: The entity's key. An entity must have a key, unless otherwise
// documented (for example, an entity in `Value.entity_value` may have
// no key). An entity's kind is its key path's last element's kind, or
// null if it has no key.
Key *Key `json:"key,omitempty"`
// Properties: The entity's properties. The map's keys are property
// names. A property name matching regex `__.*__` is reserved. A
// reserved property name is forbidden in certain documented contexts.
// The name must not contain more than 500 characters. The name cannot
// be "".
Properties map[string]Value `json:"properties,omitempty"`
// ForceSendFields is a list of field names (e.g. "Key") 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. "Key") 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 *Entity) MarshalJSON() ([]byte, error) {
type NoMethod Entity
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// EntityResult: The result of fetching an entity from Datastore.
type EntityResult struct {
// Cursor: A cursor that points to the position after the result entity.
// Set only when the `EntityResult` is part of a `QueryResultBatch`
// message.
Cursor string `json:"cursor,omitempty"`
// Entity: The resulting entity.
Entity *Entity `json:"entity,omitempty"`
// UpdateTime: The time at which the entity was last changed. This field
// is set for `FULL` entity results. If this entity is missing, this
// field will not be set.
UpdateTime string `json:"updateTime,omitempty"`
// Version: The version of the entity, a strictly positive number that
// monotonically increases with changes to the entity. This field is set
// for `FULL` entity results. For missing entities in `LookupResponse`,
// this is the version of the snapshot that was used to look up the
// entity, and it is always set except for eventually consistent reads.
Version int64 `json:"version,omitempty,string"`
// ForceSendFields is a list of field names (e.g. "Cursor") 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. "Cursor") 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 *EntityResult) MarshalJSON() ([]byte, error) {
type NoMethod EntityResult
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Filter: A holder for any type of filter.
type Filter struct {
// CompositeFilter: A composite filter.
CompositeFilter *CompositeFilter `json:"compositeFilter,omitempty"`
// PropertyFilter: A filter on a property.
PropertyFilter *PropertyFilter `json:"propertyFilter,omitempty"`
// ForceSendFields is a list of field names (e.g. "CompositeFilter") 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. "CompositeFilter") 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 *Filter) MarshalJSON() ([]byte, error) {
type NoMethod Filter
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleDatastoreAdminV1CommonMetadata: Metadata common to all
// Datastore Admin operations.
type GoogleDatastoreAdminV1CommonMetadata struct {
// EndTime: The time the operation ended, either successfully or
// otherwise.
EndTime string `json:"endTime,omitempty"`
// Labels: The client-assigned labels which were provided when the
// operation was created. May also include additional labels.
Labels map[string]string `json:"labels,omitempty"`
// OperationType: The type of the operation. Can be used as a filter in
// ListOperationsRequest.
//
// Possible values:
// "OPERATION_TYPE_UNSPECIFIED" - Unspecified.
// "EXPORT_ENTITIES" - ExportEntities.
// "IMPORT_ENTITIES" - ImportEntities.
// "CREATE_INDEX" - CreateIndex.
// "DELETE_INDEX" - DeleteIndex.
OperationType string `json:"operationType,omitempty"`
// StartTime: The time that work began on the operation.
StartTime string `json:"startTime,omitempty"`
// State: The current state of the Operation.
//
// Possible values:
// "STATE_UNSPECIFIED" - Unspecified.
// "INITIALIZING" - Request is being prepared for processing.
// "PROCESSING" - Request is actively being processed.
// "CANCELLING" - Request is in the process of being cancelled after
// user called google.longrunning.Operations.CancelOperation on the
// operation.
// "FINALIZING" - Request has been processed and is in its
// finalization stage.
// "SUCCESSFUL" - Request has completed successfully.
// "FAILED" - Request has finished being processed, but encountered an
// error.
// "CANCELLED" - Request has finished being cancelled after user
// called google.longrunning.Operations.CancelOperation.
State string `json:"state,omitempty"`
// ForceSendFields is a list of field names (e.g. "EndTime") 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. "EndTime") 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 *GoogleDatastoreAdminV1CommonMetadata) MarshalJSON() ([]byte, error) {
type NoMethod GoogleDatastoreAdminV1CommonMetadata
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleDatastoreAdminV1DatastoreFirestoreMigrationMetadata: Metadata
// for Datastore to Firestore migration operations. The
// DatastoreFirestoreMigration operation is not started by the end-user
// via an explicit "creation" method. This is an intentional deviation
// from the LRO design pattern. This singleton resource can be accessed
// at: "projects/{project_id}/operations/datastore-firestore-migration"
type GoogleDatastoreAdminV1DatastoreFirestoreMigrationMetadata struct {
// MigrationState: The current state of migration from Cloud Datastore
// to Cloud Firestore in Datastore mode.
//
// Possible values:
// "MIGRATION_STATE_UNSPECIFIED" - Unspecified.
// "RUNNING" - The migration is running.
// "PAUSED" - The migration is paused.
// "COMPLETE" - The migration is complete.
MigrationState string `json:"migrationState,omitempty"`
// MigrationStep: The current step of migration from Cloud Datastore to
// Cloud Firestore in Datastore mode.
//
// Possible values:
// "MIGRATION_STEP_UNSPECIFIED" - Unspecified.
// "PREPARE" - Pre-migration: the database is prepared for migration.
// "START" - Start of migration.
// "APPLY_WRITES_SYNCHRONOUSLY" - Writes are applied synchronously to
// at least one replica.
// "COPY_AND_VERIFY" - Data is copied to Cloud Firestore and then
// verified to match the data in Cloud Datastore.
// "REDIRECT_EVENTUALLY_CONSISTENT_READS" - Eventually-consistent
// reads are redirected to Cloud Firestore.
// "REDIRECT_STRONGLY_CONSISTENT_READS" - Strongly-consistent reads
// are redirected to Cloud Firestore.
// "REDIRECT_WRITES" - Writes are redirected to Cloud Firestore.
MigrationStep string `json:"migrationStep,omitempty"`
// ForceSendFields is a list of field names (e.g. "MigrationState") 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. "MigrationState") 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 *GoogleDatastoreAdminV1DatastoreFirestoreMigrationMetadata) MarshalJSON() ([]byte, error) {
type NoMethod GoogleDatastoreAdminV1DatastoreFirestoreMigrationMetadata
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleDatastoreAdminV1EntityFilter: Identifies a subset of entities
// in a project. This is specified as combinations of kinds and
// namespaces (either or both of which may be all, as described in the
// following examples). Example usage: Entire project: kinds=[],
// namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo',
// 'Bar'], namespace_ids=[] Kinds Foo and Bar only in the default
// namespace: kinds=['Foo', 'Bar'], namespace_ids=[”] Kinds Foo and Bar
// in both the default and Baz namespaces: kinds=['Foo', 'Bar'],
// namespace_ids=[”, 'Baz'] The entire Baz namespace: kinds=[],
// namespace_ids=['Baz']
type GoogleDatastoreAdminV1EntityFilter struct {
// Kinds: If empty, then this represents all kinds.
Kinds []string `json:"kinds,omitempty"`
// NamespaceIds: An empty list represents all namespaces. This is the
// preferred usage for projects that don't use namespaces. An empty
// string element represents the default namespace. This should be used
// if the project has data in non-default namespaces, but doesn't want
// to include them. Each namespace in this list must be unique.
NamespaceIds []string `json:"namespaceIds,omitempty"`
// ForceSendFields is a list of field names (e.g. "Kinds") 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. "Kinds") 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 *GoogleDatastoreAdminV1EntityFilter) MarshalJSON() ([]byte, error) {
type NoMethod GoogleDatastoreAdminV1EntityFilter
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleDatastoreAdminV1ExportEntitiesMetadata: Metadata for
// ExportEntities operations.
type GoogleDatastoreAdminV1ExportEntitiesMetadata struct {
// Common: Metadata common to all Datastore Admin operations.
Common *GoogleDatastoreAdminV1CommonMetadata `json:"common,omitempty"`
// EntityFilter: Description of which entities are being exported.
EntityFilter *GoogleDatastoreAdminV1EntityFilter `json:"entityFilter,omitempty"`
// OutputUrlPrefix: Location for the export metadata and data files.
// This will be the same value as the
// google.datastore.admin.v1.ExportEntitiesRequest.output_url_prefix
// field. The final output location is provided in
// google.datastore.admin.v1.ExportEntitiesResponse.output_url.
OutputUrlPrefix string `json:"outputUrlPrefix,omitempty"`
// ProgressBytes: An estimate of the number of bytes processed.
ProgressBytes *GoogleDatastoreAdminV1Progress `json:"progressBytes,omitempty"`
// ProgressEntities: An estimate of the number of entities processed.
ProgressEntities *GoogleDatastoreAdminV1Progress `json:"progressEntities,omitempty"`
// ForceSendFields is a list of field names (e.g. "Common") 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.