-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathGoogle.Api.CommonProtos.xml
6484 lines (6090 loc) · 306 KB
/
Google.Api.CommonProtos.xml
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
<?xml version="1.0"?>
<doc>
<assembly>
<name>Google.Api.CommonProtos</name>
</assembly>
<members>
<member name="T:Google.Api.AnnotationsReflection">
<summary>Holder for reflection information generated from google/api/annotations.proto</summary>
</member>
<member name="P:Google.Api.AnnotationsReflection.Descriptor">
<summary>File descriptor for google/api/annotations.proto</summary>
</member>
<member name="T:Google.Api.AnnotationsExtensions">
<summary>Holder for extension identifiers generated from the top level of google/api/annotations.proto</summary>
</member>
<member name="F:Google.Api.AnnotationsExtensions.Http">
<summary>
See `HttpRule`.
</summary>
</member>
<member name="T:Google.Api.AuthReflection">
<summary>Holder for reflection information generated from google/api/auth.proto</summary>
</member>
<member name="P:Google.Api.AuthReflection.Descriptor">
<summary>File descriptor for google/api/auth.proto</summary>
</member>
<member name="T:Google.Api.Authentication">
<summary>
`Authentication` defines the authentication configuration for an API.
Example for an API targeted for external use:
name: calendar.googleapis.com
authentication:
providers:
- id: google_calendar_auth
jwks_uri: https://www.googleapis.com/oauth2/v1/certs
issuer: https://securetoken.google.com
rules:
- selector: "*"
requirements:
provider_id: google_calendar_auth
</summary>
</member>
<member name="F:Google.Api.Authentication.RulesFieldNumber">
<summary>Field number for the "rules" field.</summary>
</member>
<member name="P:Google.Api.Authentication.Rules">
<summary>
A list of authentication rules that apply to individual API methods.
**NOTE:** All service configuration rules follow "last one wins" order.
</summary>
</member>
<member name="F:Google.Api.Authentication.ProvidersFieldNumber">
<summary>Field number for the "providers" field.</summary>
</member>
<member name="P:Google.Api.Authentication.Providers">
<summary>
Defines a set of authentication providers that a service supports.
</summary>
</member>
<member name="T:Google.Api.AuthenticationRule">
<summary>
Authentication rules for the service.
By default, if a method has any authentication requirements, every request
must include a valid credential matching one of the requirements.
It's an error to include more than one kind of credential in a single
request.
If a method doesn't have any auth requirements, request credentials will be
ignored.
</summary>
</member>
<member name="F:Google.Api.AuthenticationRule.SelectorFieldNumber">
<summary>Field number for the "selector" field.</summary>
</member>
<member name="P:Google.Api.AuthenticationRule.Selector">
<summary>
Selects the methods to which this rule applies.
Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
</summary>
</member>
<member name="F:Google.Api.AuthenticationRule.OauthFieldNumber">
<summary>Field number for the "oauth" field.</summary>
</member>
<member name="P:Google.Api.AuthenticationRule.Oauth">
<summary>
The requirements for OAuth credentials.
</summary>
</member>
<member name="F:Google.Api.AuthenticationRule.AllowWithoutCredentialFieldNumber">
<summary>Field number for the "allow_without_credential" field.</summary>
</member>
<member name="P:Google.Api.AuthenticationRule.AllowWithoutCredential">
<summary>
If true, the service accepts API keys without any other credential.
</summary>
</member>
<member name="F:Google.Api.AuthenticationRule.RequirementsFieldNumber">
<summary>Field number for the "requirements" field.</summary>
</member>
<member name="P:Google.Api.AuthenticationRule.Requirements">
<summary>
Requirements for additional authentication providers.
</summary>
</member>
<member name="T:Google.Api.JwtLocation">
<summary>
Specifies a location to extract JWT from an API request.
</summary>
</member>
<member name="F:Google.Api.JwtLocation.HeaderFieldNumber">
<summary>Field number for the "header" field.</summary>
</member>
<member name="P:Google.Api.JwtLocation.Header">
<summary>
Specifies HTTP header name to extract JWT token.
</summary>
</member>
<member name="F:Google.Api.JwtLocation.QueryFieldNumber">
<summary>Field number for the "query" field.</summary>
</member>
<member name="P:Google.Api.JwtLocation.Query">
<summary>
Specifies URL query parameter name to extract JWT token.
</summary>
</member>
<member name="F:Google.Api.JwtLocation.ValuePrefixFieldNumber">
<summary>Field number for the "value_prefix" field.</summary>
</member>
<member name="P:Google.Api.JwtLocation.ValuePrefix">
<summary>
The value prefix. The value format is "value_prefix{token}"
Only applies to "in" header type. Must be empty for "in" query type.
If not empty, the header value has to match (case sensitive) this prefix.
If not matched, JWT will not be extracted. If matched, JWT will be
extracted after the prefix is removed.
For example, for "Authorization: Bearer {JWT}",
value_prefix="Bearer " with a space at the end.
</summary>
</member>
<member name="T:Google.Api.JwtLocation.InOneofCase">
<summary>Enum of possible cases for the "in" oneof.</summary>
</member>
<member name="T:Google.Api.AuthProvider">
<summary>
Configuration for an authentication provider, including support for
[JSON Web Token
(JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
</summary>
</member>
<member name="F:Google.Api.AuthProvider.IdFieldNumber">
<summary>Field number for the "id" field.</summary>
</member>
<member name="P:Google.Api.AuthProvider.Id">
<summary>
The unique identifier of the auth provider. It will be referred to by
`AuthRequirement.provider_id`.
Example: "bookstore_auth".
</summary>
</member>
<member name="F:Google.Api.AuthProvider.IssuerFieldNumber">
<summary>Field number for the "issuer" field.</summary>
</member>
<member name="P:Google.Api.AuthProvider.Issuer">
<summary>
Identifies the principal that issued the JWT. See
https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1
Usually a URL or an email address.
Example: https://securetoken.google.com
Example: [email protected]
</summary>
</member>
<member name="F:Google.Api.AuthProvider.JwksUriFieldNumber">
<summary>Field number for the "jwks_uri" field.</summary>
</member>
<member name="P:Google.Api.AuthProvider.JwksUri">
<summary>
URL of the provider's public key set to validate signature of the JWT. See
[OpenID
Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).
Optional if the key set document:
- can be retrieved from
[OpenID
Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of
the issuer.
- can be inferred from the email domain of the issuer (e.g. a Google
service account).
Example: https://www.googleapis.com/oauth2/v1/certs
</summary>
</member>
<member name="F:Google.Api.AuthProvider.AudiencesFieldNumber">
<summary>Field number for the "audiences" field.</summary>
</member>
<member name="P:Google.Api.AuthProvider.Audiences">
<summary>
The list of JWT
[audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).
that are allowed to access. A JWT containing any of these audiences will
be accepted. When this setting is absent, JWTs with audiences:
- "https://[service.name]/[google.protobuf.Api.name]"
- "https://[service.name]/"
will be accepted.
For example, if no audiences are in the setting, LibraryService API will
accept JWTs with the following audiences:
-
https://library-example.googleapis.com/google.example.library.v1.LibraryService
- https://library-example.googleapis.com/
Example:
audiences: bookstore_android.apps.googleusercontent.com,
bookstore_web.apps.googleusercontent.com
</summary>
</member>
<member name="F:Google.Api.AuthProvider.AuthorizationUrlFieldNumber">
<summary>Field number for the "authorization_url" field.</summary>
</member>
<member name="P:Google.Api.AuthProvider.AuthorizationUrl">
<summary>
Redirect URL if JWT token is required but not present or is expired.
Implement authorizationUrl of securityDefinitions in OpenAPI spec.
</summary>
</member>
<member name="F:Google.Api.AuthProvider.JwtLocationsFieldNumber">
<summary>Field number for the "jwt_locations" field.</summary>
</member>
<member name="P:Google.Api.AuthProvider.JwtLocations">
<summary>
Defines the locations to extract the JWT.
JWT locations can be either from HTTP headers or URL query parameters.
The rule is that the first match wins. The checking order is: checking
all headers first, then URL query parameters.
If not specified, default to use following 3 locations:
1) Authorization: Bearer
2) x-goog-iap-jwt-assertion
3) access_token query parameter
Default locations can be specified as followings:
jwt_locations:
- header: Authorization
value_prefix: "Bearer "
- header: x-goog-iap-jwt-assertion
- query: access_token
</summary>
</member>
<member name="T:Google.Api.OAuthRequirements">
<summary>
OAuth scopes are a way to define data and permissions on data. For example,
there are scopes defined for "Read-only access to Google Calendar" and
"Access to Cloud Platform". Users can consent to a scope for an application,
giving it permission to access that data on their behalf.
OAuth scope specifications should be fairly coarse grained; a user will need
to see and understand the text description of what your scope means.
In most cases: use one or at most two OAuth scopes for an entire family of
products. If your product has multiple APIs, you should probably be sharing
the OAuth scope across all of those APIs.
When you need finer grained OAuth consent screens: talk with your product
management about how developers will use them in practice.
Please note that even though each of the canonical scopes is enough for a
request to be accepted and passed to the backend, a request can still fail
due to the backend requiring additional scopes or permissions.
</summary>
</member>
<member name="F:Google.Api.OAuthRequirements.CanonicalScopesFieldNumber">
<summary>Field number for the "canonical_scopes" field.</summary>
</member>
<member name="P:Google.Api.OAuthRequirements.CanonicalScopes">
<summary>
The list of publicly documented OAuth scopes that are allowed access. An
OAuth token containing any of these scopes will be accepted.
Example:
canonical_scopes: https://www.googleapis.com/auth/calendar,
https://www.googleapis.com/auth/calendar.read
</summary>
</member>
<member name="T:Google.Api.AuthRequirement">
<summary>
User-defined authentication requirements, including support for
[JSON Web Token
(JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
</summary>
</member>
<member name="F:Google.Api.AuthRequirement.ProviderIdFieldNumber">
<summary>Field number for the "provider_id" field.</summary>
</member>
<member name="P:Google.Api.AuthRequirement.ProviderId">
<summary>
[id][google.api.AuthProvider.id] from authentication provider.
Example:
provider_id: bookstore_auth
</summary>
</member>
<member name="F:Google.Api.AuthRequirement.AudiencesFieldNumber">
<summary>Field number for the "audiences" field.</summary>
</member>
<member name="P:Google.Api.AuthRequirement.Audiences">
<summary>
NOTE: This will be deprecated soon, once AuthProvider.audiences is
implemented and accepted in all the runtime components.
The list of JWT
[audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).
that are allowed to access. A JWT containing any of these audiences will
be accepted. When this setting is absent, only JWTs with audience
"https://[Service_name][google.api.Service.name]/[API_name][google.protobuf.Api.name]"
will be accepted. For example, if no audiences are in the setting,
LibraryService API will only accept JWTs with the following audience
"https://library-example.googleapis.com/google.example.library.v1.LibraryService".
Example:
audiences: bookstore_android.apps.googleusercontent.com,
bookstore_web.apps.googleusercontent.com
</summary>
</member>
<member name="T:Google.Api.BackendReflection">
<summary>Holder for reflection information generated from google/api/backend.proto</summary>
</member>
<member name="P:Google.Api.BackendReflection.Descriptor">
<summary>File descriptor for google/api/backend.proto</summary>
</member>
<member name="T:Google.Api.Backend">
<summary>
`Backend` defines the backend configuration for a service.
</summary>
</member>
<member name="F:Google.Api.Backend.RulesFieldNumber">
<summary>Field number for the "rules" field.</summary>
</member>
<member name="P:Google.Api.Backend.Rules">
<summary>
A list of API backend rules that apply to individual API methods.
**NOTE:** All service configuration rules follow "last one wins" order.
</summary>
</member>
<member name="T:Google.Api.BackendRule">
<summary>
A backend rule provides configuration for an individual API element.
</summary>
</member>
<member name="F:Google.Api.BackendRule.SelectorFieldNumber">
<summary>Field number for the "selector" field.</summary>
</member>
<member name="P:Google.Api.BackendRule.Selector">
<summary>
Selects the methods to which this rule applies.
Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
</summary>
</member>
<member name="F:Google.Api.BackendRule.AddressFieldNumber">
<summary>Field number for the "address" field.</summary>
</member>
<member name="P:Google.Api.BackendRule.Address">
<summary>
The address of the API backend.
The scheme is used to determine the backend protocol and security.
The following schemes are accepted:
SCHEME PROTOCOL SECURITY
http:// HTTP None
https:// HTTP TLS
grpc:// gRPC None
grpcs:// gRPC TLS
It is recommended to explicitly include a scheme. Leaving out the scheme
may cause constrasting behaviors across platforms.
If the port is unspecified, the default is:
- 80 for schemes without TLS
- 443 for schemes with TLS
For HTTP backends, use [protocol][google.api.BackendRule.protocol]
to specify the protocol version.
</summary>
</member>
<member name="F:Google.Api.BackendRule.DeadlineFieldNumber">
<summary>Field number for the "deadline" field.</summary>
</member>
<member name="P:Google.Api.BackendRule.Deadline">
<summary>
The number of seconds to wait for a response from a request. The default
varies based on the request protocol and deployment environment.
</summary>
</member>
<member name="F:Google.Api.BackendRule.MinDeadlineFieldNumber">
<summary>Field number for the "min_deadline" field.</summary>
</member>
<member name="P:Google.Api.BackendRule.MinDeadline">
<summary>
Minimum deadline in seconds needed for this method. Calls having deadline
value lower than this will be rejected.
</summary>
</member>
<member name="F:Google.Api.BackendRule.OperationDeadlineFieldNumber">
<summary>Field number for the "operation_deadline" field.</summary>
</member>
<member name="P:Google.Api.BackendRule.OperationDeadline">
<summary>
The number of seconds to wait for the completion of a long running
operation. The default is no deadline.
</summary>
</member>
<member name="F:Google.Api.BackendRule.PathTranslationFieldNumber">
<summary>Field number for the "path_translation" field.</summary>
</member>
<member name="F:Google.Api.BackendRule.JwtAudienceFieldNumber">
<summary>Field number for the "jwt_audience" field.</summary>
</member>
<member name="P:Google.Api.BackendRule.JwtAudience">
<summary>
The JWT audience is used when generating a JWT ID token for the backend.
This ID token will be added in the HTTP "authorization" header, and sent
to the backend.
</summary>
</member>
<member name="F:Google.Api.BackendRule.DisableAuthFieldNumber">
<summary>Field number for the "disable_auth" field.</summary>
</member>
<member name="P:Google.Api.BackendRule.DisableAuth">
<summary>
When disable_auth is true, a JWT ID token won't be generated and the
original "Authorization" HTTP header will be preserved. If the header is
used to carry the original token and is expected by the backend, this
field must be set to true to preserve the header.
</summary>
</member>
<member name="F:Google.Api.BackendRule.ProtocolFieldNumber">
<summary>Field number for the "protocol" field.</summary>
</member>
<member name="P:Google.Api.BackendRule.Protocol">
<summary>
The protocol used for sending a request to the backend.
The supported values are "http/1.1" and "h2".
The default value is inferred from the scheme in the
[address][google.api.BackendRule.address] field:
SCHEME PROTOCOL
http:// http/1.1
https:// http/1.1
grpc:// h2
grpcs:// h2
For secure HTTP backends (https://) that support HTTP/2, set this field
to "h2" for improved performance.
Configuring this field to non-default values is only supported for secure
HTTP backends. This field will be ignored for all other backends.
See
https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids
for more details on the supported values.
</summary>
</member>
<member name="T:Google.Api.BackendRule.AuthenticationOneofCase">
<summary>Enum of possible cases for the "authentication" oneof.</summary>
</member>
<member name="T:Google.Api.BackendRule.Types">
<summary>Container for nested types declared in the BackendRule message type.</summary>
</member>
<member name="T:Google.Api.BackendRule.Types.PathTranslation">
<summary>
Path Translation specifies how to combine the backend address with the
request path in order to produce the appropriate forwarding URL for the
request.
Path Translation is applicable only to HTTP-based backends. Backends which
do not accept requests over HTTP/HTTPS should leave `path_translation`
unspecified.
</summary>
</member>
<member name="F:Google.Api.BackendRule.Types.PathTranslation.ConstantAddress">
<summary>
Use the backend address as-is, with no modification to the path. If the
URL pattern contains variables, the variable names and values will be
appended to the query string. If a query string parameter and a URL
pattern variable have the same name, this may result in duplicate keys in
the query string.
# Examples
Given the following operation config:
Method path: /api/company/{cid}/user/{uid}
Backend address: https://example.cloudfunctions.net/getUser
Requests to the following request paths will call the backend at the
translated path:
Request path: /api/company/widgetworks/user/johndoe
Translated:
https://example.cloudfunctions.net/getUser?cid=widgetworks&uid=johndoe
Request path: /api/company/widgetworks/user/johndoe?timezone=EST
Translated:
https://example.cloudfunctions.net/getUser?timezone=EST&cid=widgetworks&uid=johndoe
</summary>
</member>
<member name="F:Google.Api.BackendRule.Types.PathTranslation.AppendPathToAddress">
<summary>
The request path will be appended to the backend address.
# Examples
Given the following operation config:
Method path: /api/company/{cid}/user/{uid}
Backend address: https://example.appspot.com
Requests to the following request paths will call the backend at the
translated path:
Request path: /api/company/widgetworks/user/johndoe
Translated:
https://example.appspot.com/api/company/widgetworks/user/johndoe
Request path: /api/company/widgetworks/user/johndoe?timezone=EST
Translated:
https://example.appspot.com/api/company/widgetworks/user/johndoe?timezone=EST
</summary>
</member>
<member name="T:Google.Api.BillingReflection">
<summary>Holder for reflection information generated from google/api/billing.proto</summary>
</member>
<member name="P:Google.Api.BillingReflection.Descriptor">
<summary>File descriptor for google/api/billing.proto</summary>
</member>
<member name="T:Google.Api.Billing">
<summary>
Billing related configuration of the service.
The following example shows how to configure monitored resources and metrics
for billing, `consumer_destinations` is the only supported destination and
the monitored resources need at least one label key
`cloud.googleapis.com/location` to indicate the location of the billing
usage, using different monitored resources between monitoring and billing is
recommended so they can be evolved independently:
monitored_resources:
- type: library.googleapis.com/billing_branch
labels:
- key: cloud.googleapis.com/location
description: |
Predefined label to support billing location restriction.
- key: city
description: |
Custom label to define the city where the library branch is located
in.
- key: name
description: Custom label to define the name of the library branch.
metrics:
- name: library.googleapis.com/book/borrowed_count
metric_kind: DELTA
value_type: INT64
unit: "1"
billing:
consumer_destinations:
- monitored_resource: library.googleapis.com/billing_branch
metrics:
- library.googleapis.com/book/borrowed_count
</summary>
</member>
<member name="F:Google.Api.Billing.ConsumerDestinationsFieldNumber">
<summary>Field number for the "consumer_destinations" field.</summary>
</member>
<member name="P:Google.Api.Billing.ConsumerDestinations">
<summary>
Billing configurations for sending metrics to the consumer project.
There can be multiple consumer destinations per service, each one must have
a different monitored resource type. A metric can be used in at most
one consumer destination.
</summary>
</member>
<member name="T:Google.Api.Billing.Types">
<summary>Container for nested types declared in the Billing message type.</summary>
</member>
<member name="T:Google.Api.Billing.Types.BillingDestination">
<summary>
Configuration of a specific billing destination (Currently only support
bill against consumer project).
</summary>
</member>
<member name="F:Google.Api.Billing.Types.BillingDestination.MonitoredResourceFieldNumber">
<summary>Field number for the "monitored_resource" field.</summary>
</member>
<member name="P:Google.Api.Billing.Types.BillingDestination.MonitoredResource">
<summary>
The monitored resource type. The type must be defined in
[Service.monitored_resources][google.api.Service.monitored_resources] section.
</summary>
</member>
<member name="F:Google.Api.Billing.Types.BillingDestination.MetricsFieldNumber">
<summary>Field number for the "metrics" field.</summary>
</member>
<member name="P:Google.Api.Billing.Types.BillingDestination.Metrics">
<summary>
Names of the metrics to report to this billing destination.
Each name must be defined in [Service.metrics][google.api.Service.metrics] section.
</summary>
</member>
<member name="T:Google.Api.ClientReflection">
<summary>Holder for reflection information generated from google/api/client.proto</summary>
</member>
<member name="P:Google.Api.ClientReflection.Descriptor">
<summary>File descriptor for google/api/client.proto</summary>
</member>
<member name="T:Google.Api.ClientExtensions">
<summary>Holder for extension identifiers generated from the top level of google/api/client.proto</summary>
</member>
<member name="F:Google.Api.ClientExtensions.MethodSignature">
<summary>
A definition of a client library method signature.
In client libraries, each proto RPC corresponds to one or more methods
which the end user is able to call, and calls the underlying RPC.
Normally, this method receives a single argument (a struct or instance
corresponding to the RPC request object). Defining this field will
add one or more overloads providing flattened or simpler method signatures
in some languages.
The fields on the method signature are provided as a comma-separated
string.
For example, the proto RPC and annotation:
rpc CreateSubscription(CreateSubscriptionRequest)
returns (Subscription) {
option (google.api.method_signature) = "name,topic";
}
Would add the following Java overload (in addition to the method accepting
the request object):
public final Subscription createSubscription(String name, String topic)
The following backwards-compatibility guidelines apply:
* Adding this annotation to an unannotated method is backwards
compatible.
* Adding this annotation to a method which already has existing
method signature annotations is backwards compatible if and only if
the new method signature annotation is last in the sequence.
* Modifying or removing an existing method signature annotation is
a breaking change.
* Re-ordering existing method signature annotations is a breaking
change.
</summary>
</member>
<member name="F:Google.Api.ClientExtensions.DefaultHost">
<summary>
The hostname for this service.
This should be specified with no prefix or protocol.
Example:
service Foo {
option (google.api.default_host) = "foo.googleapi.com";
...
}
</summary>
</member>
<member name="F:Google.Api.ClientExtensions.OauthScopes">
<summary>
OAuth scopes needed for the client.
Example:
service Foo {
option (google.api.oauth_scopes) = \
"https://www.googleapis.com/auth/cloud-platform";
...
}
If there is more than one scope, use a comma-separated string:
Example:
service Foo {
option (google.api.oauth_scopes) = \
"https://www.googleapis.com/auth/cloud-platform,"
"https://www.googleapis.com/auth/monitoring";
...
}
</summary>
</member>
<member name="T:Google.Api.ConfigChangeReflection">
<summary>Holder for reflection information generated from google/api/config_change.proto</summary>
</member>
<member name="P:Google.Api.ConfigChangeReflection.Descriptor">
<summary>File descriptor for google/api/config_change.proto</summary>
</member>
<member name="T:Google.Api.ChangeType">
<summary>
Classifies set of possible modifications to an object in the service
configuration.
</summary>
</member>
<member name="F:Google.Api.ChangeType.Unspecified">
<summary>
No value was provided.
</summary>
</member>
<member name="F:Google.Api.ChangeType.Added">
<summary>
The changed object exists in the 'new' service configuration, but not
in the 'old' service configuration.
</summary>
</member>
<member name="F:Google.Api.ChangeType.Removed">
<summary>
The changed object exists in the 'old' service configuration, but not
in the 'new' service configuration.
</summary>
</member>
<member name="F:Google.Api.ChangeType.Modified">
<summary>
The changed object exists in both service configurations, but its value
is different.
</summary>
</member>
<member name="T:Google.Api.ConfigChange">
<summary>
Output generated from semantically comparing two versions of a service
configuration.
Includes detailed information about a field that have changed with
applicable advice about potential consequences for the change, such as
backwards-incompatibility.
</summary>
</member>
<member name="F:Google.Api.ConfigChange.ElementFieldNumber">
<summary>Field number for the "element" field.</summary>
</member>
<member name="P:Google.Api.ConfigChange.Element">
<summary>
Object hierarchy path to the change, with levels separated by a '.'
character. For repeated fields, an applicable unique identifier field is
used for the index (usually selector, name, or id). For maps, the term
'key' is used. If the field has no unique identifier, the numeric index
is used.
Examples:
- visibility.rules[selector=="google.LibraryService.ListBooks"].restriction
- quota.metric_rules[selector=="google"].metric_costs[key=="reads"].value
- logging.producer_destinations[0]
</summary>
</member>
<member name="F:Google.Api.ConfigChange.OldValueFieldNumber">
<summary>Field number for the "old_value" field.</summary>
</member>
<member name="P:Google.Api.ConfigChange.OldValue">
<summary>
Value of the changed object in the old Service configuration,
in JSON format. This field will not be populated if ChangeType == ADDED.
</summary>
</member>
<member name="F:Google.Api.ConfigChange.NewValueFieldNumber">
<summary>Field number for the "new_value" field.</summary>
</member>
<member name="P:Google.Api.ConfigChange.NewValue">
<summary>
Value of the changed object in the new Service configuration,
in JSON format. This field will not be populated if ChangeType == REMOVED.
</summary>
</member>
<member name="F:Google.Api.ConfigChange.ChangeTypeFieldNumber">
<summary>Field number for the "change_type" field.</summary>
</member>
<member name="P:Google.Api.ConfigChange.ChangeType">
<summary>
The type for this change, either ADDED, REMOVED, or MODIFIED.
</summary>
</member>
<member name="F:Google.Api.ConfigChange.AdvicesFieldNumber">
<summary>Field number for the "advices" field.</summary>
</member>
<member name="P:Google.Api.ConfigChange.Advices">
<summary>
Collection of advice provided for this change, useful for determining the
possible impact of this change.
</summary>
</member>
<member name="T:Google.Api.Advice">
<summary>
Generated advice about this change, used for providing more
information about how a change will affect the existing service.
</summary>
</member>
<member name="F:Google.Api.Advice.DescriptionFieldNumber">
<summary>Field number for the "description" field.</summary>
</member>
<member name="P:Google.Api.Advice.Description">
<summary>
Useful description for why this advice was applied and what actions should
be taken to mitigate any implied risks.
</summary>
</member>
<member name="T:Google.Api.ConsumerReflection">
<summary>Holder for reflection information generated from google/api/consumer.proto</summary>
</member>
<member name="P:Google.Api.ConsumerReflection.Descriptor">
<summary>File descriptor for google/api/consumer.proto</summary>
</member>
<member name="T:Google.Api.ProjectProperties">
<summary>
A descriptor for defining project properties for a service. One service may
have many consumer projects, and the service may want to behave differently
depending on some properties on the project. For example, a project may be
associated with a school, or a business, or a government agency, a business
type property on the project may affect how a service responds to the client.
This descriptor defines which properties are allowed to be set on a project.
Example:
project_properties:
properties:
- name: NO_WATERMARK
type: BOOL
description: Allows usage of the API without watermarks.
- name: EXTENDED_TILE_CACHE_PERIOD
type: INT64
</summary>
</member>
<member name="F:Google.Api.ProjectProperties.PropertiesFieldNumber">
<summary>Field number for the "properties" field.</summary>
</member>
<member name="P:Google.Api.ProjectProperties.Properties">
<summary>
List of per consumer project-specific properties.
</summary>
</member>
<member name="T:Google.Api.Property">
<summary>
Defines project properties.
API services can define properties that can be assigned to consumer projects
so that backends can perform response customization without having to make
additional calls or maintain additional storage. For example, Maps API
defines properties that controls map tile cache period, or whether to embed a
watermark in a result.
These values can be set via API producer console. Only API providers can
define and set these properties.
</summary>
</member>
<member name="F:Google.Api.Property.NameFieldNumber">
<summary>Field number for the "name" field.</summary>
</member>
<member name="P:Google.Api.Property.Name">
<summary>
The name of the property (a.k.a key).
</summary>
</member>
<member name="F:Google.Api.Property.TypeFieldNumber">
<summary>Field number for the "type" field.</summary>
</member>
<member name="P:Google.Api.Property.Type">
<summary>
The type of this property.
</summary>
</member>
<member name="F:Google.Api.Property.DescriptionFieldNumber">
<summary>Field number for the "description" field.</summary>
</member>
<member name="P:Google.Api.Property.Description">
<summary>
The description of the property
</summary>
</member>
<member name="T:Google.Api.Property.Types">
<summary>Container for nested types declared in the Property message type.</summary>
</member>
<member name="T:Google.Api.Property.Types.PropertyType">
<summary>
Supported data type of the property values
</summary>
</member>
<member name="F:Google.Api.Property.Types.PropertyType.Unspecified">
<summary>
The type is unspecified, and will result in an error.
</summary>
</member>
<member name="F:Google.Api.Property.Types.PropertyType.Int64">
<summary>
The type is `int64`.
</summary>
</member>
<member name="F:Google.Api.Property.Types.PropertyType.Bool">
<summary>
The type is `bool`.
</summary>
</member>
<member name="F:Google.Api.Property.Types.PropertyType.String">
<summary>
The type is `string`.
</summary>
</member>
<member name="F:Google.Api.Property.Types.PropertyType.Double">
<summary>
The type is 'double'.
</summary>
</member>
<member name="T:Google.Api.ContextReflection">
<summary>Holder for reflection information generated from google/api/context.proto</summary>
</member>
<member name="P:Google.Api.ContextReflection.Descriptor">
<summary>File descriptor for google/api/context.proto</summary>
</member>
<member name="T:Google.Api.Context">
<summary>
`Context` defines which contexts an API requests.
Example:
context:
rules:
- selector: "*"
requested:
- google.rpc.context.ProjectContext
- google.rpc.context.OriginContext
The above specifies that all methods in the API request
`google.rpc.context.ProjectContext` and
`google.rpc.context.OriginContext`.
Available context types are defined in package
`google.rpc.context`.
This also provides mechanism to whitelist any protobuf message extension that
can be sent in grpc metadata using “x-goog-ext-<extension_id>-bin” and
“x-goog-ext-<extension_id>-jspb” format. For example, list any service
specific protobuf types that can appear in grpc metadata as follows in your
yaml file:
Example:
context:
rules:
- selector: "google.example.library.v1.LibraryService.CreateBook"
allowed_request_extensions:
- google.foo.v1.NewExtension
allowed_response_extensions:
- google.foo.v1.NewExtension
You can also specify extension ID instead of fully qualified extension name
here.
</summary>
</member>
<member name="F:Google.Api.Context.RulesFieldNumber">
<summary>Field number for the "rules" field.</summary>
</member>
<member name="P:Google.Api.Context.Rules">
<summary>
A list of RPC context rules that apply to individual API methods.
**NOTE:** All service configuration rules follow "last one wins" order.
</summary>
</member>
<member name="T:Google.Api.ContextRule">
<summary>
A context rule provides information about the context for an individual API
element.
</summary>
</member>
<member name="F:Google.Api.ContextRule.SelectorFieldNumber">
<summary>Field number for the "selector" field.</summary>
</member>
<member name="P:Google.Api.ContextRule.Selector">
<summary>
Selects the methods to which this rule applies.
Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
</summary>
</member>
<member name="F:Google.Api.ContextRule.RequestedFieldNumber">
<summary>Field number for the "requested" field.</summary>
</member>
<member name="P:Google.Api.ContextRule.Requested">
<summary>
A list of full type names of requested contexts.