forked from googleapis/google-api-go-client
/
documentai-gen.go
8288 lines (7131 loc) · 367 KB
/
documentai-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 2020 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 documentai provides access to the Cloud Document AI API.
//
// For product documentation, see: https://cloud.google.com/document-ai/docs/
//
// Creating a client
//
// Usage example:
//
// import "google.golang.org/api/documentai/v1beta3"
// ...
// ctx := context.Background()
// documentaiService, err := documentai.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:
//
// documentaiService, err := documentai.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, ...)
// documentaiService, err := documentai.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
//
// See https://godoc.org/google.golang.org/api/option/ for details on options.
package documentai // import "google.golang.org/api/documentai/v1beta3"
import (
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"io"
"net/http"
"net/url"
"strconv"
"strings"
googleapi "google.golang.org/api/googleapi"
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 = "documentai:v1beta3"
const apiName = "documentai"
const apiVersion = "v1beta3"
const basePath = "https://documentai.googleapis.com/"
const mtlsBasePath = "https://documentai.mtls.googleapis.com/"
// OAuth2 scopes used by this API.
const (
// View and manage your data across Google Cloud Platform services
CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
)
// NewService creates a new Service.
func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error) {
scopesOption := option.WithScopes(
"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)
return rs
}
type ProjectsService struct {
s *Service
Locations *ProjectsLocationsService
}
func NewProjectsLocationsService(s *Service) *ProjectsLocationsService {
rs := &ProjectsLocationsService{s: s}
rs.Operations = NewProjectsLocationsOperationsService(s)
rs.Processors = NewProjectsLocationsProcessorsService(s)
return rs
}
type ProjectsLocationsService struct {
s *Service
Operations *ProjectsLocationsOperationsService
Processors *ProjectsLocationsProcessorsService
}
func NewProjectsLocationsOperationsService(s *Service) *ProjectsLocationsOperationsService {
rs := &ProjectsLocationsOperationsService{s: s}
return rs
}
type ProjectsLocationsOperationsService struct {
s *Service
}
func NewProjectsLocationsProcessorsService(s *Service) *ProjectsLocationsProcessorsService {
rs := &ProjectsLocationsProcessorsService{s: s}
rs.HumanReviewConfig = NewProjectsLocationsProcessorsHumanReviewConfigService(s)
rs.ProcessorVersions = NewProjectsLocationsProcessorsProcessorVersionsService(s)
return rs
}
type ProjectsLocationsProcessorsService struct {
s *Service
HumanReviewConfig *ProjectsLocationsProcessorsHumanReviewConfigService
ProcessorVersions *ProjectsLocationsProcessorsProcessorVersionsService
}
func NewProjectsLocationsProcessorsHumanReviewConfigService(s *Service) *ProjectsLocationsProcessorsHumanReviewConfigService {
rs := &ProjectsLocationsProcessorsHumanReviewConfigService{s: s}
return rs
}
type ProjectsLocationsProcessorsHumanReviewConfigService struct {
s *Service
}
func NewProjectsLocationsProcessorsProcessorVersionsService(s *Service) *ProjectsLocationsProcessorsProcessorVersionsService {
rs := &ProjectsLocationsProcessorsProcessorVersionsService{s: s}
return rs
}
type ProjectsLocationsProcessorsProcessorVersionsService struct {
s *Service
}
// GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata: The common
// metadata for long running operations.
type GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata struct {
// CreateTime: The creation time of the operation.
CreateTime string `json:"createTime,omitempty"`
// State: The state of the operation.
//
// Possible values:
// "STATE_UNSPECIFIED" - Unspecified state.
// "RUNNING" - Operation is still running.
// "CANCELLING" - Operation is being cancelled.
// "SUCCEEDED" - Operation succeeded.
// "FAILED" - Operation failed.
// "CANCELLED" - Operation is cancelled.
State string `json:"state,omitempty"`
// StateMessage: A message providing more details about the current
// state of processing.
StateMessage string `json:"stateMessage,omitempty"`
// UpdateTime: The last update time of the operation.
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 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 *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata) MarshalJSON() ([]byte, error) {
type NoMethod GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata: The
// long running operation metadata for CreateLabelerPool.
type GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata struct {
// CommonMetadata: The basic metadata of the long running operation.
CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`
// ForceSendFields is a list of field names (e.g. "CommonMetadata") to
// unconditionally include in API requests. By default, fields with
// empty 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. "CommonMetadata") 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 *GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata) MarshalJSON() ([]byte, error) {
type NoMethod GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleCloudDocumentaiUiv1beta3CreateProcessorVersionMetadata: The
// metadata that represents a processor version being created.
type GoogleCloudDocumentaiUiv1beta3CreateProcessorVersionMetadata struct {
// CreateTime: The creation time of the operation.
CreateTime string `json:"createTime,omitempty"`
// State: The state of the current disable processor operation.
//
// Possible values:
// "STATE_UNSPECIFIED" - The training state is unspecified.
// "QUEUED" - The training request has been issued but processing has
// not yet begun.
// "PREPARING" - The service is preparing to execute the training.
// "RUNNING" - The training is in progress.
// "SUCCEEDED" - The training completed successfully.
// "FAILED" - The training failed. `error` should contain the details
// of the failure.
// "CANCELLING" - The training is being cancelled. `error` should
// describe the reason for the cancellation.
// "CANCELLED" - The training has been cancelled. `error` should
// describe the reason for the cancellation.
State string `json:"state,omitempty"`
// UpdateTime: The last update time of the operation.
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 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 *GoogleCloudDocumentaiUiv1beta3CreateProcessorVersionMetadata) MarshalJSON() ([]byte, error) {
type NoMethod GoogleCloudDocumentaiUiv1beta3CreateProcessorVersionMetadata
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata: The
// long running operation metadata for DeleteLabelerPool.
type GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata struct {
// CommonMetadata: The basic metadata of the long running operation.
CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`
// ForceSendFields is a list of field names (e.g. "CommonMetadata") to
// unconditionally include in API requests. By default, fields with
// empty 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. "CommonMetadata") 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 *GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata) MarshalJSON() ([]byte, error) {
type NoMethod GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata: The long
// running operation metadata for delete processor method.
type GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata struct {
// CommonMetadata: The basic metadata of the long running operation.
CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`
// CreateTime: The creation time of the operation.
CreateTime string `json:"createTime,omitempty"`
// State: The state of the current delete processor operation.
//
// Possible values:
// "STATE_UNSPECIFIED" - The default value. This value is used if the
// state is omitted.
// "WAITING" - Request operation is waiting for scheduling.
// "RUNNING" - Request is being processed.
// "SUCCEEDED" - The operation is completed successfully.
// "FAILED" - The operation has failed.
State string `json:"state,omitempty"`
// StateMessage: A message providing more details about the current
// state of processing. For example, the error message if the operation
// is failed.
StateMessage string `json:"stateMessage,omitempty"`
// UpdateTime: The last update time of the operation.
UpdateTime string `json:"updateTime,omitempty"`
// ForceSendFields is a list of field names (e.g. "CommonMetadata") to
// unconditionally include in API requests. By default, fields with
// empty 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. "CommonMetadata") 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 *GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata) MarshalJSON() ([]byte, error) {
type NoMethod GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata: The
// long running operation metadata for delete processor version method.
type GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata struct {
// CommonMetadata: The basic metadata of the long running operation.
CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`
// ForceSendFields is a list of field names (e.g. "CommonMetadata") to
// unconditionally include in API requests. By default, fields with
// empty 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. "CommonMetadata") 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 *GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata) MarshalJSON() ([]byte, error) {
type NoMethod GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata: The
// long running operation metadata for deploy processor version method.
type GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata struct {
// CommonMetadata: The basic metadata of the long running operation.
CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`
// ForceSendFields is a list of field names (e.g. "CommonMetadata") to
// unconditionally include in API requests. By default, fields with
// empty 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. "CommonMetadata") 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 *GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata) MarshalJSON() ([]byte, error) {
type NoMethod GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionResponse:
// Response message for the deploy processor version method.
type GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionResponse struct {
}
// GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata: The long
// running operation metadata for disable processor method.
type GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata struct {
// CommonMetadata: The basic metadata of the long running operation.
CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`
// CreateTime: The creation time of the operation.
CreateTime string `json:"createTime,omitempty"`
// State: The state of the current disable processor operation.
//
// Possible values:
// "STATE_UNSPECIFIED" - The default value. This value is used if the
// state is omitted.
// "WAITING" - Request operation is waiting for scheduling.
// "RUNNING" - Request is being processed.
// "SUCCEEDED" - The operation is completed successfully.
// "CANCELLING" - The operation was being cancelled.
// "CANCELLED" - The operation was cancelled.
// "FAILED" - The operation has failed.
State string `json:"state,omitempty"`
// StateMessage: A message providing more details about the current
// state of processing. For example, the error message if the operation
// is failed.
StateMessage string `json:"stateMessage,omitempty"`
// UpdateTime: The last update time of the operation.
UpdateTime string `json:"updateTime,omitempty"`
// ForceSendFields is a list of field names (e.g. "CommonMetadata") to
// unconditionally include in API requests. By default, fields with
// empty 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. "CommonMetadata") 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 *GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata) MarshalJSON() ([]byte, error) {
type NoMethod GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleCloudDocumentaiUiv1beta3DisableProcessorResponse: Response
// message for the disable processor method. Intentionally empty proto
// for adding fields in future.
type GoogleCloudDocumentaiUiv1beta3DisableProcessorResponse struct {
}
// GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata: The long
// running operation metadata for enable processor method.
type GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata struct {
// CommonMetadata: The basic metadata of the long running operation.
CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`
// CreateTime: The creation time of the operation.
CreateTime string `json:"createTime,omitempty"`
// State: The state of the current enable processor operation.
//
// Possible values:
// "STATE_UNSPECIFIED" - The default value. This value is used if the
// state is omitted.
// "WAITING" - Request operation is waiting for scheduling.
// "RUNNING" - Request is being processed.
// "SUCCEEDED" - The operation is completed successfully.
// "CANCELLING" - The operation was being cancelled.
// "CANCELLED" - The operation was cancelled.
// "FAILED" - The operation has failed.
State string `json:"state,omitempty"`
// StateMessage: A message providing more details about the current
// state of processing. For example, the error message if the operation
// is failed.
StateMessage string `json:"stateMessage,omitempty"`
// UpdateTime: The last update time of the operation.
UpdateTime string `json:"updateTime,omitempty"`
// ForceSendFields is a list of field names (e.g. "CommonMetadata") to
// unconditionally include in API requests. By default, fields with
// empty 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. "CommonMetadata") 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 *GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata) MarshalJSON() ([]byte, error) {
type NoMethod GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse: Response
// message for the enable processor method. Intentionally empty proto
// for adding fields in future.
type GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse struct {
}
// GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata: The
// long running operation metadata for the undeploy processor version
// method.
type GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata struct {
// CommonMetadata: The basic metadata of the long running operation.
CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`
// ForceSendFields is a list of field names (e.g. "CommonMetadata") to
// unconditionally include in API requests. By default, fields with
// empty 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. "CommonMetadata") 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 *GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata) MarshalJSON() ([]byte, error) {
type NoMethod GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse:
// Response message for the undeploy processor version method.
type GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse struct {
}
// GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata: The
// long running operation metadata for updating the human review
// configuration.
type GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata struct {
// CommonMetadata: The basic metadata of the long running operation.
CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`
// ForceSendFields is a list of field names (e.g. "CommonMetadata") to
// unconditionally include in API requests. By default, fields with
// empty 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. "CommonMetadata") 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 *GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata) MarshalJSON() ([]byte, error) {
type NoMethod GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata: The
// long running operation metadata for UpdateLabelerPool.
type GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata struct {
// CommonMetadata: The basic metadata of the long running operation.
CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`
// ForceSendFields is a list of field names (e.g. "CommonMetadata") to
// unconditionally include in API requests. By default, fields with
// empty 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. "CommonMetadata") 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 *GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata) MarshalJSON() ([]byte, error) {
type NoMethod GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleCloudDocumentaiV1beta1BatchProcessDocumentsResponse: Response
// to an batch document processing request. This is returned in the LRO
// Operation after the operation is complete.
type GoogleCloudDocumentaiV1beta1BatchProcessDocumentsResponse struct {
// Responses: Responses for each individual document.
Responses []*GoogleCloudDocumentaiV1beta1ProcessDocumentResponse `json:"responses,omitempty"`
// ForceSendFields is a list of field names (e.g. "Responses") to
// unconditionally include in API requests. By default, fields with
// empty 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. "Responses") 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 *GoogleCloudDocumentaiV1beta1BatchProcessDocumentsResponse) MarshalJSON() ([]byte, error) {
type NoMethod GoogleCloudDocumentaiV1beta1BatchProcessDocumentsResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleCloudDocumentaiV1beta1BoundingPoly: A bounding polygon for the
// detected image annotation.
type GoogleCloudDocumentaiV1beta1BoundingPoly struct {
// NormalizedVertices: The bounding polygon normalized vertices.
NormalizedVertices []*GoogleCloudDocumentaiV1beta1NormalizedVertex `json:"normalizedVertices,omitempty"`
// Vertices: The bounding polygon vertices.
Vertices []*GoogleCloudDocumentaiV1beta1Vertex `json:"vertices,omitempty"`
// ForceSendFields is a list of field names (e.g. "NormalizedVertices")
// to unconditionally include in API requests. By default, fields with
// empty 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. "NormalizedVertices") 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 *GoogleCloudDocumentaiV1beta1BoundingPoly) MarshalJSON() ([]byte, error) {
type NoMethod GoogleCloudDocumentaiV1beta1BoundingPoly
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleCloudDocumentaiV1beta1Document: Document represents the
// canonical document resource in Document Understanding AI. It is an
// interchange format that provides insights into documents and allows
// for collaboration between users and Document Understanding AI to
// iterate and optimize for quality.
type GoogleCloudDocumentaiV1beta1Document struct {
// Content: Inline document content, represented as a stream of bytes.
// Note: As with all `bytes` fields, protobuffers use a pure binary
// representation, whereas JSON representations use base64.
Content string `json:"content,omitempty"`
// Entities: A list of entities detected on Document.text. For document
// shards, entities in this list may cross shard boundaries.
Entities []*GoogleCloudDocumentaiV1beta1DocumentEntity `json:"entities,omitempty"`
// EntityRelations: Relationship among Document.entities.
EntityRelations []*GoogleCloudDocumentaiV1beta1DocumentEntityRelation `json:"entityRelations,omitempty"`
// Error: Any error that occurred while processing this document.
Error *GoogleRpcStatus `json:"error,omitempty"`
// MimeType: An IANA published MIME type (also referred to as media
// type). For more information, see
// https://www.iana.org/assignments/media-types/media-types.xhtml.
MimeType string `json:"mimeType,omitempty"`
// Pages: Visual page layout for the Document.
Pages []*GoogleCloudDocumentaiV1beta1DocumentPage `json:"pages,omitempty"`
// Revisions: Revision history of this document.
Revisions []*GoogleCloudDocumentaiV1beta1DocumentRevision `json:"revisions,omitempty"`
// ShardInfo: Information about the sharding if this document is sharded
// part of a larger document. If the document is not sharded, this
// message is not specified.
ShardInfo *GoogleCloudDocumentaiV1beta1DocumentShardInfo `json:"shardInfo,omitempty"`
// Text: UTF-8 encoded text in reading order from the document.
Text string `json:"text,omitempty"`
// TextChanges: A list of text corrections made to [Document.text]. This
// is usually used for annotating corrections to OCR mistakes. Text
// changes for a given revision may not overlap with each other.
TextChanges []*GoogleCloudDocumentaiV1beta1DocumentTextChange `json:"textChanges,omitempty"`
// TextStyles: Styles for the Document.text.
TextStyles []*GoogleCloudDocumentaiV1beta1DocumentStyle `json:"textStyles,omitempty"`
// Translations: A list of translations on Document.text. For document
// shards, translations in this list may cross shard boundaries.
Translations []*GoogleCloudDocumentaiV1beta1DocumentTranslation `json:"translations,omitempty"`
// Uri: Currently supports Google Cloud Storage URI of the form
// `gs://bucket_name/object_name`. Object versioning is not supported.
// See [Google Cloud Storage Request
// URIs](https://cloud.google.com/storage/docs/reference-uris) for more
// info.
Uri string `json:"uri,omitempty"`
// ForceSendFields is a list of field names (e.g. "Content") to
// unconditionally include in API requests. By default, fields with
// empty 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. "Content") 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 *GoogleCloudDocumentaiV1beta1Document) MarshalJSON() ([]byte, error) {
type NoMethod GoogleCloudDocumentaiV1beta1Document
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleCloudDocumentaiV1beta1DocumentEntity: A phrase in the text that
// is a known entity type, such as a person, an organization, or
// location.
type GoogleCloudDocumentaiV1beta1DocumentEntity struct {
// Confidence: Optional. Confidence of detected Schema entity. Range [0,
// 1].
Confidence float64 `json:"confidence,omitempty"`
// Id: Optional. Canonical id. This will be a unique value in the entity
// list for this document.
Id string `json:"id,omitempty"`
// MentionId: Deprecated. Use `id` field instead.
MentionId string `json:"mentionId,omitempty"`
// MentionText: Text value in the document e.g. `1600 Amphitheatre
// Pkwy`.
MentionText string `json:"mentionText,omitempty"`
// NormalizedValue: Optional. Normalized entity value. Absent if the
// extracted value could not be converted or the type (e.g. address) is
// not supported for certain parsers. This field is also only populated
// for certain supported document types.
NormalizedValue *GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue `json:"normalizedValue,omitempty"`
// PageAnchor: Optional. Represents the provenance of this entity wrt.
// the location on the page where it was found.
PageAnchor *GoogleCloudDocumentaiV1beta1DocumentPageAnchor `json:"pageAnchor,omitempty"`
// Properties: Optional. Entities can be nested to form a hierarchical
// data structure representing the content in the document.
Properties []*GoogleCloudDocumentaiV1beta1DocumentEntity `json:"properties,omitempty"`
// Provenance: Optional. The history of this annotation.
Provenance *GoogleCloudDocumentaiV1beta1DocumentProvenance `json:"provenance,omitempty"`
// Redacted: Optional. Whether the entity will be redacted for
// de-identification purposes.
Redacted bool `json:"redacted,omitempty"`
// TextAnchor: Provenance of the entity. Text anchor indexing into the
// Document.text.
TextAnchor *GoogleCloudDocumentaiV1beta1DocumentTextAnchor `json:"textAnchor,omitempty"`
// Type: Entity type from a schema e.g. `Address`.
Type string `json:"type,omitempty"`
// ForceSendFields is a list of field names (e.g. "Confidence") to
// unconditionally include in API requests. By default, fields with
// empty 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. "Confidence") 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 *GoogleCloudDocumentaiV1beta1DocumentEntity) MarshalJSON() ([]byte, error) {
type NoMethod GoogleCloudDocumentaiV1beta1DocumentEntity
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
func (s *GoogleCloudDocumentaiV1beta1DocumentEntity) UnmarshalJSON(data []byte) error {
type NoMethod GoogleCloudDocumentaiV1beta1DocumentEntity
var s1 struct {
Confidence gensupport.JSONFloat64 `json:"confidence"`
*NoMethod
}
s1.NoMethod = (*NoMethod)(s)
if err := json.Unmarshal(data, &s1); err != nil {
return err
}
s.Confidence = float64(s1.Confidence)
return nil
}
// GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue: Parsed and
// normalized entity value.
type GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue struct {
// AddressValue: Postal address. See also:
// https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
AddressValue *GoogleTypePostalAddress `json:"addressValue,omitempty"`
// DateValue: Date value. Includes year, month, day. See also:
// https://github.com/googleapis/googleapis/blob/master/google/type/date.proto
DateValue *GoogleTypeDate `json:"dateValue,omitempty"`
// DatetimeValue: DateTime value. Includes date, time, and timezone. See
// also:
// https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto
DatetimeValue *GoogleTypeDateTime `json:"datetimeValue,omitempty"`
// MoneyValue: Money value. See also:
// https://github.com/googleapis/googleapis/blob/master/google/type/money.proto
MoneyValue *GoogleTypeMoney `json:"moneyValue,omitempty"`
// Text: Required. Normalized entity value stored as a string. This
// field is populated for supported document type (e.g. Invoice). For
// some entity types, one of respective 'structured_value' fields may
// also be populated. - Money/Currency type (`money_value`) is in the
// ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601
// text format. - Datetime type (`datetime_value`) is in the ISO 8601
// text format.
Text string `json:"text,omitempty"`
// ForceSendFields is a list of field names (e.g. "AddressValue") to
// unconditionally include in API requests. By default, fields with
// empty 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. "AddressValue") 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 *GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue) MarshalJSON() ([]byte, error) {
type NoMethod GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleCloudDocumentaiV1beta1DocumentEntityRelation: Relationship
// between Entities.
type GoogleCloudDocumentaiV1beta1DocumentEntityRelation struct {
// ObjectId: Object entity id.
ObjectId string `json:"objectId,omitempty"`
// Relation: Relationship description.
Relation string `json:"relation,omitempty"`
// SubjectId: Subject entity id.
SubjectId string `json:"subjectId,omitempty"`
// ForceSendFields is a list of field names (e.g. "ObjectId") to
// unconditionally include in API requests. By default, fields with
// empty 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. "ObjectId") 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