/
apigee_v1.organizations.environments.html
977 lines (870 loc) 路 86.1 KB
/
apigee_v1.organizations.environments.html
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
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="apigee_v1.html">Apigee API</a> . <a href="apigee_v1.organizations.html">organizations</a> . <a href="apigee_v1.organizations.environments.html">environments</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="apigee_v1.organizations.environments.analytics.html">analytics()</a></code>
</p>
<p class="firstline">Returns the analytics Resource.</p>
<p class="toc_element">
<code><a href="apigee_v1.organizations.environments.apis.html">apis()</a></code>
</p>
<p class="firstline">Returns the apis Resource.</p>
<p class="toc_element">
<code><a href="apigee_v1.organizations.environments.caches.html">caches()</a></code>
</p>
<p class="firstline">Returns the caches Resource.</p>
<p class="toc_element">
<code><a href="apigee_v1.organizations.environments.deployments.html">deployments()</a></code>
</p>
<p class="firstline">Returns the deployments Resource.</p>
<p class="toc_element">
<code><a href="apigee_v1.organizations.environments.flowhooks.html">flowhooks()</a></code>
</p>
<p class="firstline">Returns the flowhooks Resource.</p>
<p class="toc_element">
<code><a href="apigee_v1.organizations.environments.keystores.html">keystores()</a></code>
</p>
<p class="firstline">Returns the keystores Resource.</p>
<p class="toc_element">
<code><a href="apigee_v1.organizations.environments.keyvaluemaps.html">keyvaluemaps()</a></code>
</p>
<p class="firstline">Returns the keyvaluemaps Resource.</p>
<p class="toc_element">
<code><a href="apigee_v1.organizations.environments.optimizedStats.html">optimizedStats()</a></code>
</p>
<p class="firstline">Returns the optimizedStats Resource.</p>
<p class="toc_element">
<code><a href="apigee_v1.organizations.environments.queries.html">queries()</a></code>
</p>
<p class="firstline">Returns the queries Resource.</p>
<p class="toc_element">
<code><a href="apigee_v1.organizations.environments.references.html">references()</a></code>
</p>
<p class="firstline">Returns the references Resource.</p>
<p class="toc_element">
<code><a href="apigee_v1.organizations.environments.resourcefiles.html">resourcefiles()</a></code>
</p>
<p class="firstline">Returns the resourcefiles Resource.</p>
<p class="toc_element">
<code><a href="apigee_v1.organizations.environments.sharedflows.html">sharedflows()</a></code>
</p>
<p class="firstline">Returns the sharedflows Resource.</p>
<p class="toc_element">
<code><a href="apigee_v1.organizations.environments.stats.html">stats()</a></code>
</p>
<p class="firstline">Returns the stats Resource.</p>
<p class="toc_element">
<code><a href="apigee_v1.organizations.environments.targetservers.html">targetservers()</a></code>
</p>
<p class="firstline">Returns the targetservers Resource.</p>
<p class="toc_element">
<code><a href="apigee_v1.organizations.environments.traceConfig.html">traceConfig()</a></code>
</p>
<p class="firstline">Returns the traceConfig Resource.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, name=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates an environment in an organization.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes an environment from an organization.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets environment details.</p>
<p class="toc_element">
<code><a href="#getDebugmask">getDebugmask(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the debug mask singleton resource for an environment.</p>
<p class="toc_element">
<code><a href="#getDeployedConfig">getDeployedConfig(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the deployed configuration for an environment.</p>
<p class="toc_element">
<code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the IAM policy on an environment. For more information, see [Manage users, roles, and permissions using the API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). You must have the `apigee.environments.getIamPolicy` permission to call this API.</p>
<p class="toc_element">
<code><a href="#getTraceConfig">getTraceConfig(name, x__xgafv=None)</a></code></p>
<p class="firstline">Get distributed trace configuration in an environment.</p>
<p class="toc_element">
<code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Sets the IAM policy on an environment, if the policy already exists it will be replaced. For more information, see [Manage users, roles, and permissions using the API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). You must have the `apigee.environments.setIamPolicy` permission to call this API.</p>
<p class="toc_element">
<code><a href="#subscribe">subscribe(parent, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a subscription for the environment's Pub/Sub topic. The server will assign a random name for this subscription. The "name" and "push_config" must *not* be specified.</p>
<p class="toc_element">
<code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Tests the permissions of a user on an environment, and returns a subset of permissions that the user has on the environment. If the environment does not exist, an empty permission set is returned (a NOT_FOUND error is not returned).</p>
<p class="toc_element">
<code><a href="#unsubscribe">unsubscribe(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a subscription for the environment's Pub/Sub topic.</p>
<p class="toc_element">
<code><a href="#update">update(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing environment. When updating properties, you must pass all existing properties to the API, even if they are not being changed. If you omit properties from the payload, the properties are removed. To get the current list of properties for the environment, use the [Get Environment API](get).</p>
<p class="toc_element">
<code><a href="#updateDebugmask">updateDebugmask(name, body=None, replaceRepeatedFields=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the debug mask singleton resource for an environment.</p>
<p class="toc_element">
<code><a href="#updateEnvironment">updateEnvironment(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing environment. When updating properties, you must pass all existing properties to the API, even if they are not being changed. If you omit properties from the payload, the properties are removed. To get the current list of properties for the environment, use the [Get Environment API](get).</p>
<p class="toc_element">
<code><a href="#updateTraceConfig">updateTraceConfig(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the trace configurations in an environment. Note that the repeated fields have replace semantics when included in the field mask and that they will be overwritten by the value of the fields in the request body.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, name=None, x__xgafv=None)</code>
<pre>Creates an environment in an organization.
Args:
parent: string, Required. Name of the organization in which the environment will be created. Use the following structure in your request: `organizations/{org}` (required)
body: object, The request body.
The object takes the form of:
{
"createdAt": "A String", # Output only. Creation time of this environment as milliseconds since epoch.
"description": "A String", # Optional. Description of the environment.
"displayName": "A String", # Optional. Display name for this environment.
"lastModifiedAt": "A String", # Output only. Last modification time of this environment as milliseconds since epoch.
"name": "A String", # Required. Name of the environment. Values must match the regular expression `^[.\\p{Alnum}-_]{1,255}$`
"properties": { # Message for compatibility with legacy Edge specification for Java Properties object in JSON. # Optional. Key-value pairs that may be used for customizing the environment.
"property": [ # List of all properties in the object
{ # A single property entry in the Properties message.
"name": "A String", # The property key
"value": "A String", # The property value
},
],
},
"state": "A String", # Output only. State of the environment. Values other than ACTIVE means the resource is not ready to use.
}
name: string, Optional. Name of the environment. Alternatively, the name may be specified in the request body in the name field.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes an environment from an organization.
Args:
name: string, Required. Name of the environment. Use the following structure in your request: `organizations/{org}/environments/{env}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets environment details.
Args:
name: string, Required. Name of the environment. Use the following structure in your request: `organizations/{org}/environments/{env}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"createdAt": "A String", # Output only. Creation time of this environment as milliseconds since epoch.
"description": "A String", # Optional. Description of the environment.
"displayName": "A String", # Optional. Display name for this environment.
"lastModifiedAt": "A String", # Output only. Last modification time of this environment as milliseconds since epoch.
"name": "A String", # Required. Name of the environment. Values must match the regular expression `^[.\\p{Alnum}-_]{1,255}$`
"properties": { # Message for compatibility with legacy Edge specification for Java Properties object in JSON. # Optional. Key-value pairs that may be used for customizing the environment.
"property": [ # List of all properties in the object
{ # A single property entry in the Properties message.
"name": "A String", # The property key
"value": "A String", # The property value
},
],
},
"state": "A String", # Output only. State of the environment. Values other than ACTIVE means the resource is not ready to use.
}</pre>
</div>
<div class="method">
<code class="details" id="getDebugmask">getDebugmask(name, x__xgafv=None)</code>
<pre>Gets the debug mask singleton resource for an environment.
Args:
name: string, Required. Name of the debug mask. Use the following structure in your request: `organizations/{org}/environments/{env}/debugmask`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"faultJSONPaths": [ # List of JSON paths that specify the JSON elements to be filtered from JSON payloads in error flows.
"A String",
],
"faultXPaths": [ # List of XPaths that specify the XML elements to be filtered from XML payloads in error flows.
"A String",
],
"name": "A String", # Name of the debug mask.
"namespaces": { # Map of namespaces to URIs.
"a_key": "A String",
},
"requestJSONPaths": [ # List of JSON paths that specify the JSON elements to be filtered from JSON request message payloads.
"A String",
],
"requestXPaths": [ # List of XPaths that specify the XML elements to be filtered from XML request message payloads.
"A String",
],
"responseJSONPaths": [ # List of JSON paths that specify the JSON elements to be filtered from JSON response message payloads.
"A String",
],
"responseXPaths": [ # List of XPaths that specify the XML elements to be filtered from XML response message payloads.
"A String",
],
"variables": [ # List of variables that should be masked from the debug output.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="getDeployedConfig">getDeployedConfig(name, x__xgafv=None)</code>
<pre>Gets the deployed configuration for an environment.
Args:
name: string, Required. Name of the environment deployed configuration resource. Use the following structure in your request: `organizations/{org}/environments/{env}/deployedConfig` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"createTime": "A String", # Time that the environment configuration was created.
"dataCollectors": [ # List of data collectors used by the deployments in the environment.
{ # Data collector and its configuration.
"name": "A String", # Name of the data collector in the following format: `organizations/{org}/datacollectors/{datacollector}`
"type": "A String", # Data type accepted by the data collector.
},
],
"debugMask": { # Debug mask that applies to all deployments in the environment.
"faultJSONPaths": [ # List of JSON paths that specify the JSON elements to be filtered from JSON payloads in error flows.
"A String",
],
"faultXPaths": [ # List of XPaths that specify the XML elements to be filtered from XML payloads in error flows.
"A String",
],
"name": "A String", # Name of the debug mask.
"namespaces": { # Map of namespaces to URIs.
"a_key": "A String",
},
"requestJSONPaths": [ # List of JSON paths that specify the JSON elements to be filtered from JSON request message payloads.
"A String",
],
"requestXPaths": [ # List of XPaths that specify the XML elements to be filtered from XML request message payloads.
"A String",
],
"responseJSONPaths": [ # List of JSON paths that specify the JSON elements to be filtered from JSON response message payloads.
"A String",
],
"responseXPaths": [ # List of XPaths that specify the XML elements to be filtered from XML response message payloads.
"A String",
],
"variables": [ # List of variables that should be masked from the debug output.
"A String",
],
},
"deployments": [ # List of deployments in the environment.
{
"attributes": { # Additional key-value metadata for the deployment.
"a_key": "A String",
},
"basePath": "A String", # Base path where the application will be hosted. Defaults to "/".
"location": "A String", # Location of the API proxy bundle as a URI.
"name": "A String", # Name of the API or shared flow revision to be deployed in the following format: `organizations/{org}/apis/{api}/revisions/{rev}` or `organizations/{org}/sharedflows/{sharedflow}/revisions/{rev}`
"proxyUid": "A String", # Unique ID of the API proxy revision.
"uid": "A String", # Unique ID. The ID will only change if the deployment is deleted and recreated.
},
],
"featureFlags": { # Feature flags inherited from the organization and environment.
"a_key": "A String",
},
"flowhooks": [ # List of flow hooks in the environment.
{
"continueOnError": True or False, # Flag that specifies whether the flow should abort after an error in the flow hook. Defaults to `true` (continue on error).
"name": "A String", # Name of the flow hook in the following format: `organizations/{org}/environments/{env}/flowhooks/{point}`. Valid `point` values include: `PreProxyFlowHook`, `PostProxyFlowHook`, `PreTargetFlowHook`, and `PostTargetFlowHook`
"sharedFlowName": "A String", # Name of the shared flow to invoke in the following format: `organizations/{org}/sharedflows/{sharedflow}`
},
],
"keystores": [ # List of keystores in the environment.
{
"aliases": [ # Aliases in the keystore.
{
"location": "A String", # Location of the alias file. For example, a Google Cloud Storage URI.
"name": "A String", # Name of the alias revision included in the keystore in the following format: `organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}/revisions/{rev}`
"type": "A String",
},
],
"name": "A String", # Resource name in the following format: `organizations/{org}/environments/{env}/keystores/{keystore}`
},
],
"name": "A String", # Name of the environment configuration in the following format: `organizations/{org}/environments/{env}/configs/{config}`
"provider": "A String", # Used by the Control plane to add context information to help detect the source of the document during diagnostics and debugging.
"pubsubTopic": "A String", # Name of the PubSub topic for the environment.
"resourceReferences": [ # List of resource references in the environment.
{
"name": "A String", # Name of the reference in the following format: `organizations/{org}/environments/{env}/references/{reference}`
"resourceName": "A String", # Name of the referenced resource in the following format: `organizations/{org}/environments/{env}/keystores/{keystore}` Only references to keystore resources are supported.
},
],
"resources": [ # List of resource versions in the environment.
{
"location": "A String", # Location of the resource as a URI.
"name": "A String", # Resource name in the following format: `organizations/{org}/environments/{env}/resourcefiles/{type}/{file}/revisions/{rev}` Only environment-scoped resource files are supported.
},
],
"revisionId": "A String", # Revision ID of the environment configuration. The higher the value, the more recently the configuration was deployed.
"sequenceNumber": "A String", # DEPRECATED: Use revision_id.
"targets": [ # List of target servers in the environment. Disabled target servers are not displayed.
{
"host": "A String", # Host name of the target server.
"name": "A String", # Target server revision name in the following format: `organizations/{org}/environments/{env}/targetservers/{targetserver}/revisions/{rev}`
"port": 42, # Port number for the target server.
"protocol": "A String", # The protocol used by this target server.
"tlsInfo": { # TLS settings for the target server.
"ciphers": [ # List of ciphers that are granted access.
"A String",
],
"clientAuthEnabled": True or False, # Flag that specifies whether client-side authentication is enabled for the target server. Enables two-way TLS.
"commonName": { # Common name to validate the target server against.
"matchWildCards": True or False,
"name": "A String",
},
"enabled": True or False, # Flag that specifies whether one-way TLS is enabled. Set to `true` to enable one-way TLS.
"ignoreValidationErrors": True or False, # Flag that specifies whether to ignore TLS certificate validation errors. Set to `true` to ignore errors.
"keyAlias": "A String", # Name of the alias used for client-side authentication in the following format: `organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}`
"keyAliasReference": { # Reference name and alias pair to use for client-side authentication.
"aliasId": "A String", # Alias ID. Must exist in the keystore referred to by the reference.
"reference": "A String", # Reference name in the following format: `organizations/{org}/environments/{env}/references/{reference}`
},
"protocols": [ # List of TLS protocols that are granted access.
"A String",
],
"trustStore": "A String", # Name of the keystore or keystore reference containing trusted certificates for the server in the following format: `organizations/{org}/environments/{env}/keystores/{keystore}` or `organizations/{org}/environments/{env}/references/{reference}`
},
},
],
"traceConfig": { # NEXT ID: 8 RuntimeTraceConfig defines the configurations for distributed trace in an environment. # Trace configurations. Contains config for the environment and config overrides for specific API proxies.
"endpoint": "A String", # Endpoint of the exporter.
"exporter": "A String", # Exporter that is used to view the distributed trace captured using OpenCensus. An exporter sends traces to any backend that is capable of consuming them. Recorded spans can be exported by registered exporters.
"name": "A String", # Name of the trace config in the following format: `organizations/{org}/environment/{env}/traceConfig`
"overrides": [ # List of trace configuration overrides for spicific API proxies.
{ # NEXT ID: 7 Trace configuration override for a specific API proxy in an environment.
"apiProxy": "A String", # Name of the API proxy that will have its trace configuration overridden following format: `organizations/{org}/apis/{api}`
"name": "A String", # Name of the trace config override in the following format: `organizations/{org}/environment/{env}/traceConfig/overrides/{override}`
"revisionCreateTime": "A String", # The timestamp that the revision was created or updated.
"revisionId": "A String", # Revision number which can be used by the runtime to detect if the trace config override has changed between two versions.
"samplingConfig": { # NEXT ID: 3 RuntimeTraceSamplingConfig represents the detail settings of distributed tracing. Only the fields that are defined in the distributed trace configuration can be overridden using the distribute trace configuration override APIs. # Trace configuration override for a specific API proxy in an environment.
"sampler": "A String", # Sampler of distributed tracing. OFF is the default value.
"samplingRate": 3.14, # Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5.
},
"uid": "A String", # Unique ID for the configuration override. The ID will only change if the override is deleted and recreated. Corresponds to name's "override" field.
},
],
"revisionCreateTime": "A String", # The timestamp that the revision was created or updated.
"revisionId": "A String", # Revision number which can be used by the runtime to detect if the trace config has changed between two versions.
"samplingConfig": { # NEXT ID: 3 RuntimeTraceSamplingConfig represents the detail settings of distributed tracing. Only the fields that are defined in the distributed trace configuration can be overridden using the distribute trace configuration override APIs. # Trace configuration for all API proxies in an environment.
"sampler": "A String", # Sampler of distributed tracing. OFF is the default value.
"samplingRate": 3.14, # Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5.
},
},
"uid": "A String", # Unique ID for the environment configuration. The ID will only change if the environment is deleted and recreated.
}</pre>
</div>
<div class="method">
<code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code>
<pre>Gets the IAM policy on an environment. For more information, see [Manage users, roles, and permissions using the API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). You must have the `apigee.environments.getIamPolicy` permission to call this API.
Args:
resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required)
options_requestedPolicyVersion: integer, Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
"auditLogConfigs": [ # The configuration for logging of each type of permission.
{ # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
"A String",
],
"logType": "A String", # The log type that this config enables.
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
},
],
"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
},
"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
"A String",
],
"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
},
],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
}</pre>
</div>
<div class="method">
<code class="details" id="getTraceConfig">getTraceConfig(name, x__xgafv=None)</code>
<pre>Get distributed trace configuration in an environment.
Args:
name: string, Required. Name of the trace configuration. Use the following structure in your request: "organizations/*/environments/*/traceConfig". (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # TraceConfig defines the configurations in an environment of distributed trace.
"endpoint": "A String", # Required. Endpoint of the exporter.
"exporter": "A String", # Required. Exporter that is used to view the distributed trace captured using OpenCensus. An exporter sends traces to any backend that is capable of consuming them. Recorded spans can be exported by registered exporters.
"samplingConfig": { # TraceSamplingConfig represents the detail settings of distributed tracing. Only the fields that are defined in the distributed trace configuration can be overridden using the distribute trace configuration override APIs. # Distributed trace configuration for all API proxies in an environment. You can also override the configuration for a specific API proxy using the distributed trace configuration overrides API.
"sampler": "A String", # Sampler of distributed tracing. OFF is the default value.
"samplingRate": 3.14, # Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5.
},
}</pre>
</div>
<div class="method">
<code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
<pre>Sets the IAM policy on an environment, if the policy already exists it will be replaced. For more information, see [Manage users, roles, and permissions using the API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). You must have the `apigee.environments.setIamPolicy` permission to call this API.
Args:
resource: string, REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for `SetIamPolicy` method.
"policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
"auditLogConfigs": [ # The configuration for logging of each type of permission.
{ # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
"A String",
],
"logType": "A String", # The log type that this config enables.
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
},
],
"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
},
"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
"A String",
],
"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
},
],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
},
"updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
"auditLogConfigs": [ # The configuration for logging of each type of permission.
{ # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
"A String",
],
"logType": "A String", # The log type that this config enables.
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
},
],
"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
},
"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
"A String",
],
"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
},
],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
}</pre>
</div>
<div class="method">
<code class="details" id="subscribe">subscribe(parent, x__xgafv=None)</code>
<pre>Creates a subscription for the environment's Pub/Sub topic. The server will assign a random name for this subscription. The "name" and "push_config" must *not* be specified.
Args:
parent: string, Required. Name of the environment. Use the following structure in your request: `organizations/{org}/environments/{env}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Pub/Sub subscription of an environment.
"name": "A String", # Full name of the Pub/Sub subcription. Use the following structure in your request: `subscription "projects/foo/subscription/bar"`
}</pre>
</div>
<div class="method">
<code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
<pre>Tests the permissions of a user on an environment, and returns a subset of permissions that the user has on the environment. If the environment does not exist, an empty permission set is returned (a NOT_FOUND error is not returned).
Args:
resource: string, REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for `TestIamPermissions` method.
"permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
"A String",
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for `TestIamPermissions` method.
"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="unsubscribe">unsubscribe(parent, body=None, x__xgafv=None)</code>
<pre>Deletes a subscription for the environment's Pub/Sub topic.
Args:
parent: string, Required. Name of the environment. Use the following structure in your request: `organizations/{org}/environments/{env}` (required)
body: object, The request body.
The object takes the form of:
{ # Pub/Sub subscription of an environment.
"name": "A String", # Full name of the Pub/Sub subcription. Use the following structure in your request: `subscription "projects/foo/subscription/bar"`
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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); } The JSON representation for `Empty` is empty JSON object `{}`.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(name, body=None, x__xgafv=None)</code>
<pre>Updates an existing environment. When updating properties, you must pass all existing properties to the API, even if they are not being changed. If you omit properties from the payload, the properties are removed. To get the current list of properties for the environment, use the [Get Environment API](get).
Args:
name: string, Required. Name of the environment. Use the following structure in your request: `organizations/{org}/environments/{env}` (required)
body: object, The request body.
The object takes the form of:
{
"createdAt": "A String", # Output only. Creation time of this environment as milliseconds since epoch.
"description": "A String", # Optional. Description of the environment.
"displayName": "A String", # Optional. Display name for this environment.
"lastModifiedAt": "A String", # Output only. Last modification time of this environment as milliseconds since epoch.
"name": "A String", # Required. Name of the environment. Values must match the regular expression `^[.\\p{Alnum}-_]{1,255}$`
"properties": { # Message for compatibility with legacy Edge specification for Java Properties object in JSON. # Optional. Key-value pairs that may be used for customizing the environment.
"property": [ # List of all properties in the object
{ # A single property entry in the Properties message.
"name": "A String", # The property key
"value": "A String", # The property value
},
],
},
"state": "A String", # Output only. State of the environment. Values other than ACTIVE means the resource is not ready to use.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"createdAt": "A String", # Output only. Creation time of this environment as milliseconds since epoch.
"description": "A String", # Optional. Description of the environment.
"displayName": "A String", # Optional. Display name for this environment.
"lastModifiedAt": "A String", # Output only. Last modification time of this environment as milliseconds since epoch.
"name": "A String", # Required. Name of the environment. Values must match the regular expression `^[.\\p{Alnum}-_]{1,255}$`
"properties": { # Message for compatibility with legacy Edge specification for Java Properties object in JSON. # Optional. Key-value pairs that may be used for customizing the environment.
"property": [ # List of all properties in the object
{ # A single property entry in the Properties message.
"name": "A String", # The property key
"value": "A String", # The property value
},
],
},
"state": "A String", # Output only. State of the environment. Values other than ACTIVE means the resource is not ready to use.
}</pre>
</div>
<div class="method">
<code class="details" id="updateDebugmask">updateDebugmask(name, body=None, replaceRepeatedFields=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates the debug mask singleton resource for an environment.
Args:
name: string, Name of the debug mask. (required)
body: object, The request body.
The object takes the form of:
{
"faultJSONPaths": [ # List of JSON paths that specify the JSON elements to be filtered from JSON payloads in error flows.
"A String",
],
"faultXPaths": [ # List of XPaths that specify the XML elements to be filtered from XML payloads in error flows.
"A String",
],
"name": "A String", # Name of the debug mask.
"namespaces": { # Map of namespaces to URIs.
"a_key": "A String",
},
"requestJSONPaths": [ # List of JSON paths that specify the JSON elements to be filtered from JSON request message payloads.
"A String",
],
"requestXPaths": [ # List of XPaths that specify the XML elements to be filtered from XML request message payloads.
"A String",
],
"responseJSONPaths": [ # List of JSON paths that specify the JSON elements to be filtered from JSON response message payloads.
"A String",
],
"responseXPaths": [ # List of XPaths that specify the XML elements to be filtered from XML response message payloads.
"A String",
],
"variables": [ # List of variables that should be masked from the debug output.
"A String",
],
}
replaceRepeatedFields: boolean, Boolean flag that specifies whether to replace existing values in the debug mask when doing an update. Set to true to replace existing values. The default behavior is to append the values (false).
updateMask: string, Field debug mask to support partial updates.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"faultJSONPaths": [ # List of JSON paths that specify the JSON elements to be filtered from JSON payloads in error flows.
"A String",
],
"faultXPaths": [ # List of XPaths that specify the XML elements to be filtered from XML payloads in error flows.
"A String",
],
"name": "A String", # Name of the debug mask.
"namespaces": { # Map of namespaces to URIs.
"a_key": "A String",
},
"requestJSONPaths": [ # List of JSON paths that specify the JSON elements to be filtered from JSON request message payloads.
"A String",
],
"requestXPaths": [ # List of XPaths that specify the XML elements to be filtered from XML request message payloads.
"A String",
],
"responseJSONPaths": [ # List of JSON paths that specify the JSON elements to be filtered from JSON response message payloads.
"A String",
],
"responseXPaths": [ # List of XPaths that specify the XML elements to be filtered from XML response message payloads.
"A String",
],
"variables": [ # List of variables that should be masked from the debug output.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="updateEnvironment">updateEnvironment(name, body=None, x__xgafv=None)</code>
<pre>Updates an existing environment. When updating properties, you must pass all existing properties to the API, even if they are not being changed. If you omit properties from the payload, the properties are removed. To get the current list of properties for the environment, use the [Get Environment API](get).
Args:
name: string, Required. Name of the environment. Use the following structure in your request: `organizations/{org}/environments/{env}` (required)
body: object, The request body.
The object takes the form of:
{
"createdAt": "A String", # Output only. Creation time of this environment as milliseconds since epoch.
"description": "A String", # Optional. Description of the environment.
"displayName": "A String", # Optional. Display name for this environment.
"lastModifiedAt": "A String", # Output only. Last modification time of this environment as milliseconds since epoch.
"name": "A String", # Required. Name of the environment. Values must match the regular expression `^[.\\p{Alnum}-_]{1,255}$`
"properties": { # Message for compatibility with legacy Edge specification for Java Properties object in JSON. # Optional. Key-value pairs that may be used for customizing the environment.
"property": [ # List of all properties in the object
{ # A single property entry in the Properties message.
"name": "A String", # The property key
"value": "A String", # The property value
},
],
},
"state": "A String", # Output only. State of the environment. Values other than ACTIVE means the resource is not ready to use.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"createdAt": "A String", # Output only. Creation time of this environment as milliseconds since epoch.
"description": "A String", # Optional. Description of the environment.
"displayName": "A String", # Optional. Display name for this environment.
"lastModifiedAt": "A String", # Output only. Last modification time of this environment as milliseconds since epoch.
"name": "A String", # Required. Name of the environment. Values must match the regular expression `^[.\\p{Alnum}-_]{1,255}$`
"properties": { # Message for compatibility with legacy Edge specification for Java Properties object in JSON. # Optional. Key-value pairs that may be used for customizing the environment.
"property": [ # List of all properties in the object
{ # A single property entry in the Properties message.
"name": "A String", # The property key
"value": "A String", # The property value
},
],
},
"state": "A String", # Output only. State of the environment. Values other than ACTIVE means the resource is not ready to use.
}</pre>
</div>
<div class="method">
<code class="details" id="updateTraceConfig">updateTraceConfig(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates the trace configurations in an environment. Note that the repeated fields have replace semantics when included in the field mask and that they will be overwritten by the value of the fields in the request body.
Args:
name: string, Required. Name of the trace configuration. Use the following structure in your request: "organizations/*/environments/*/traceConfig". (required)
body: object, The request body.
The object takes the form of:
{ # TraceConfig defines the configurations in an environment of distributed trace.
"endpoint": "A String", # Required. Endpoint of the exporter.
"exporter": "A String", # Required. Exporter that is used to view the distributed trace captured using OpenCensus. An exporter sends traces to any backend that is capable of consuming them. Recorded spans can be exported by registered exporters.
"samplingConfig": { # TraceSamplingConfig represents the detail settings of distributed tracing. Only the fields that are defined in the distributed trace configuration can be overridden using the distribute trace configuration override APIs. # Distributed trace configuration for all API proxies in an environment. You can also override the configuration for a specific API proxy using the distributed trace configuration overrides API.
"sampler": "A String", # Sampler of distributed tracing. OFF is the default value.
"samplingRate": 3.14, # Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5.
},
}
updateMask: string, List of fields to be updated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # TraceConfig defines the configurations in an environment of distributed trace.
"endpoint": "A String", # Required. Endpoint of the exporter.
"exporter": "A String", # Required. Exporter that is used to view the distributed trace captured using OpenCensus. An exporter sends traces to any backend that is capable of consuming them. Recorded spans can be exported by registered exporters.
"samplingConfig": { # TraceSamplingConfig represents the detail settings of distributed tracing. Only the fields that are defined in the distributed trace configuration can be overridden using the distribute trace configuration override APIs. # Distributed trace configuration for all API proxies in an environment. You can also override the configuration for a specific API proxy using the distributed trace configuration overrides API.
"sampler": "A String", # Sampler of distributed tracing. OFF is the default value.
"samplingRate": 3.14, # Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5.
},
}</pre>
</div>
</body></html>