1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<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> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="apigee_v1.organizations.environments.analytics.html">analytics()</a></code> 79</p> 80<p class="firstline">Returns the analytics Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="apigee_v1.organizations.environments.apis.html">apis()</a></code> 84</p> 85<p class="firstline">Returns the apis Resource.</p> 86 87<p class="toc_element"> 88 <code><a href="apigee_v1.organizations.environments.archiveDeployments.html">archiveDeployments()</a></code> 89</p> 90<p class="firstline">Returns the archiveDeployments Resource.</p> 91 92<p class="toc_element"> 93 <code><a href="apigee_v1.organizations.environments.caches.html">caches()</a></code> 94</p> 95<p class="firstline">Returns the caches Resource.</p> 96 97<p class="toc_element"> 98 <code><a href="apigee_v1.organizations.environments.deployments.html">deployments()</a></code> 99</p> 100<p class="firstline">Returns the deployments Resource.</p> 101 102<p class="toc_element"> 103 <code><a href="apigee_v1.organizations.environments.flowhooks.html">flowhooks()</a></code> 104</p> 105<p class="firstline">Returns the flowhooks Resource.</p> 106 107<p class="toc_element"> 108 <code><a href="apigee_v1.organizations.environments.keystores.html">keystores()</a></code> 109</p> 110<p class="firstline">Returns the keystores Resource.</p> 111 112<p class="toc_element"> 113 <code><a href="apigee_v1.organizations.environments.keyvaluemaps.html">keyvaluemaps()</a></code> 114</p> 115<p class="firstline">Returns the keyvaluemaps Resource.</p> 116 117<p class="toc_element"> 118 <code><a href="apigee_v1.organizations.environments.optimizedStats.html">optimizedStats()</a></code> 119</p> 120<p class="firstline">Returns the optimizedStats Resource.</p> 121 122<p class="toc_element"> 123 <code><a href="apigee_v1.organizations.environments.queries.html">queries()</a></code> 124</p> 125<p class="firstline">Returns the queries Resource.</p> 126 127<p class="toc_element"> 128 <code><a href="apigee_v1.organizations.environments.references.html">references()</a></code> 129</p> 130<p class="firstline">Returns the references Resource.</p> 131 132<p class="toc_element"> 133 <code><a href="apigee_v1.organizations.environments.resourcefiles.html">resourcefiles()</a></code> 134</p> 135<p class="firstline">Returns the resourcefiles Resource.</p> 136 137<p class="toc_element"> 138 <code><a href="apigee_v1.organizations.environments.sharedflows.html">sharedflows()</a></code> 139</p> 140<p class="firstline">Returns the sharedflows Resource.</p> 141 142<p class="toc_element"> 143 <code><a href="apigee_v1.organizations.environments.stats.html">stats()</a></code> 144</p> 145<p class="firstline">Returns the stats Resource.</p> 146 147<p class="toc_element"> 148 <code><a href="apigee_v1.organizations.environments.targetservers.html">targetservers()</a></code> 149</p> 150<p class="firstline">Returns the targetservers Resource.</p> 151 152<p class="toc_element"> 153 <code><a href="apigee_v1.organizations.environments.traceConfig.html">traceConfig()</a></code> 154</p> 155<p class="firstline">Returns the traceConfig Resource.</p> 156 157<p class="toc_element"> 158 <code><a href="#close">close()</a></code></p> 159<p class="firstline">Close httplib2 connections.</p> 160<p class="toc_element"> 161 <code><a href="#create">create(parent, body=None, name=None, x__xgafv=None)</a></code></p> 162<p class="firstline">Creates an environment in an organization.</p> 163<p class="toc_element"> 164 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 165<p class="firstline">Deletes an environment from an organization.</p> 166<p class="toc_element"> 167 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 168<p class="firstline">Gets environment details.</p> 169<p class="toc_element"> 170 <code><a href="#getDebugmask">getDebugmask(name, x__xgafv=None)</a></code></p> 171<p class="firstline">Gets the debug mask singleton resource for an environment.</p> 172<p class="toc_element"> 173 <code><a href="#getDeployedConfig">getDeployedConfig(name, x__xgafv=None)</a></code></p> 174<p class="firstline">Gets the deployed configuration for an environment.</p> 175<p class="toc_element"> 176 <code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p> 177<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> 178<p class="toc_element"> 179 <code><a href="#getTraceConfig">getTraceConfig(name, x__xgafv=None)</a></code></p> 180<p class="firstline">Get distributed trace configuration in an environment.</p> 181<p class="toc_element"> 182 <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p> 183<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> 184<p class="toc_element"> 185 <code><a href="#subscribe">subscribe(parent, x__xgafv=None)</a></code></p> 186<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> 187<p class="toc_element"> 188 <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p> 189<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> 190<p class="toc_element"> 191 <code><a href="#unsubscribe">unsubscribe(parent, body=None, x__xgafv=None)</a></code></p> 192<p class="firstline">Deletes a subscription for the environment's Pub/Sub topic.</p> 193<p class="toc_element"> 194 <code><a href="#update">update(name, body=None, x__xgafv=None)</a></code></p> 195<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> 196<p class="toc_element"> 197 <code><a href="#updateDebugmask">updateDebugmask(name, body=None, replaceRepeatedFields=None, updateMask=None, x__xgafv=None)</a></code></p> 198<p class="firstline">Updates the debug mask singleton resource for an environment.</p> 199<p class="toc_element"> 200 <code><a href="#updateEnvironment">updateEnvironment(name, body=None, x__xgafv=None)</a></code></p> 201<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> 202<p class="toc_element"> 203 <code><a href="#updateTraceConfig">updateTraceConfig(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> 204<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> 205<h3>Method Details</h3> 206<div class="method"> 207 <code class="details" id="close">close()</code> 208 <pre>Close httplib2 connections.</pre> 209</div> 210 211<div class="method"> 212 <code class="details" id="create">create(parent, body=None, name=None, x__xgafv=None)</code> 213 <pre>Creates an environment in an organization. 214 215Args: 216 parent: string, Required. Name of the organization in which the environment will be created. Use the following structure in your request: `organizations/{org}` (required) 217 body: object, The request body. 218 The object takes the form of: 219 220{ 221 "apiProxyType": "A String", # Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed. 222 "createdAt": "A String", # Output only. Creation time of this environment as milliseconds since epoch. 223 "deploymentType": "A String", # Optional. Deployment type supported by the environment. The deployment type can be set when creating the environment and cannot be changed. When you enable archive deployment, you will be **prevented from performing** a [subset of actions](/apigee/docs/api-platform/local-development/overview#prevented-actions) within the environment, including: * Managing the deployment of API proxy or shared flow revisions * Creating, updating, or deleting resource files * Creating, updating, or deleting target servers 224 "description": "A String", # Optional. Description of the environment. 225 "displayName": "A String", # Optional. Display name for this environment. 226 "lastModifiedAt": "A String", # Output only. Last modification time of this environment as milliseconds since epoch. 227 "name": "A String", # Required. Name of the environment. Values must match the regular expression `^[.\\p{Alnum}-_]{1,255}$` 228 "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. 229 "property": [ # List of all properties in the object 230 { # A single property entry in the Properties message. 231 "name": "A String", # The property key 232 "value": "A String", # The property value 233 }, 234 ], 235 }, 236 "state": "A String", # Output only. State of the environment. Values other than ACTIVE means the resource is not ready to use. 237} 238 239 name: string, Optional. Name of the environment. Alternatively, the name may be specified in the request body in the name field. 240 x__xgafv: string, V1 error format. 241 Allowed values 242 1 - v1 error format 243 2 - v2 error format 244 245Returns: 246 An object of the form: 247 248 { # This resource represents a long-running operation that is the result of a network API call. 249 "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. 250 "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. 251 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 252 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 253 { 254 "a_key": "", # Properties of the object. Contains field @type with type URL. 255 }, 256 ], 257 "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. 258 }, 259 "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. 260 "a_key": "", # Properties of the object. Contains field @type with type URL. 261 }, 262 "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}`. 263 "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`. 264 "a_key": "", # Properties of the object. Contains field @type with type URL. 265 }, 266}</pre> 267</div> 268 269<div class="method"> 270 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 271 <pre>Deletes an environment from an organization. 272 273Args: 274 name: string, Required. Name of the environment. Use the following structure in your request: `organizations/{org}/environments/{env}` (required) 275 x__xgafv: string, V1 error format. 276 Allowed values 277 1 - v1 error format 278 2 - v2 error format 279 280Returns: 281 An object of the form: 282 283 { # This resource represents a long-running operation that is the result of a network API call. 284 "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. 285 "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. 286 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 287 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 288 { 289 "a_key": "", # Properties of the object. Contains field @type with type URL. 290 }, 291 ], 292 "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. 293 }, 294 "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. 295 "a_key": "", # Properties of the object. Contains field @type with type URL. 296 }, 297 "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}`. 298 "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`. 299 "a_key": "", # Properties of the object. Contains field @type with type URL. 300 }, 301}</pre> 302</div> 303 304<div class="method"> 305 <code class="details" id="get">get(name, x__xgafv=None)</code> 306 <pre>Gets environment details. 307 308Args: 309 name: string, Required. Name of the environment. Use the following structure in your request: `organizations/{org}/environments/{env}` (required) 310 x__xgafv: string, V1 error format. 311 Allowed values 312 1 - v1 error format 313 2 - v2 error format 314 315Returns: 316 An object of the form: 317 318 { 319 "apiProxyType": "A String", # Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed. 320 "createdAt": "A String", # Output only. Creation time of this environment as milliseconds since epoch. 321 "deploymentType": "A String", # Optional. Deployment type supported by the environment. The deployment type can be set when creating the environment and cannot be changed. When you enable archive deployment, you will be **prevented from performing** a [subset of actions](/apigee/docs/api-platform/local-development/overview#prevented-actions) within the environment, including: * Managing the deployment of API proxy or shared flow revisions * Creating, updating, or deleting resource files * Creating, updating, or deleting target servers 322 "description": "A String", # Optional. Description of the environment. 323 "displayName": "A String", # Optional. Display name for this environment. 324 "lastModifiedAt": "A String", # Output only. Last modification time of this environment as milliseconds since epoch. 325 "name": "A String", # Required. Name of the environment. Values must match the regular expression `^[.\\p{Alnum}-_]{1,255}$` 326 "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. 327 "property": [ # List of all properties in the object 328 { # A single property entry in the Properties message. 329 "name": "A String", # The property key 330 "value": "A String", # The property value 331 }, 332 ], 333 }, 334 "state": "A String", # Output only. State of the environment. Values other than ACTIVE means the resource is not ready to use. 335}</pre> 336</div> 337 338<div class="method"> 339 <code class="details" id="getDebugmask">getDebugmask(name, x__xgafv=None)</code> 340 <pre>Gets the debug mask singleton resource for an environment. 341 342Args: 343 name: string, Required. Name of the debug mask. Use the following structure in your request: `organizations/{org}/environments/{env}/debugmask`. (required) 344 x__xgafv: string, V1 error format. 345 Allowed values 346 1 - v1 error format 347 2 - v2 error format 348 349Returns: 350 An object of the form: 351 352 { 353 "faultJSONPaths": [ # List of JSON paths that specify the JSON elements to be filtered from JSON payloads in error flows. 354 "A String", 355 ], 356 "faultXPaths": [ # List of XPaths that specify the XML elements to be filtered from XML payloads in error flows. 357 "A String", 358 ], 359 "name": "A String", # Name of the debug mask. 360 "namespaces": { # Map of namespaces to URIs. 361 "a_key": "A String", 362 }, 363 "requestJSONPaths": [ # List of JSON paths that specify the JSON elements to be filtered from JSON request message payloads. 364 "A String", 365 ], 366 "requestXPaths": [ # List of XPaths that specify the XML elements to be filtered from XML request message payloads. 367 "A String", 368 ], 369 "responseJSONPaths": [ # List of JSON paths that specify the JSON elements to be filtered from JSON response message payloads. 370 "A String", 371 ], 372 "responseXPaths": [ # List of XPaths that specify the XML elements to be filtered from XML response message payloads. 373 "A String", 374 ], 375 "variables": [ # List of variables that should be masked from the debug output. 376 "A String", 377 ], 378}</pre> 379</div> 380 381<div class="method"> 382 <code class="details" id="getDeployedConfig">getDeployedConfig(name, x__xgafv=None)</code> 383 <pre>Gets the deployed configuration for an environment. 384 385Args: 386 name: string, Required. Name of the environment deployed configuration resource. Use the following structure in your request: `organizations/{org}/environments/{env}/deployedConfig` (required) 387 x__xgafv: string, V1 error format. 388 Allowed values 389 1 - v1 error format 390 2 - v2 error format 391 392Returns: 393 An object of the form: 394 395 { 396 "arcConfigLocation": "A String", # The location for the config blob of API Runtime Control, aka Envoy Adapter, for op-based authentication as a URI, e.g. a Cloud Storage URI. This is only used by Envoy-based gateways. 397 "createTime": "A String", # Time that the environment configuration was created. 398 "dataCollectors": [ # List of data collectors used by the deployments in the environment. 399 { # Data collector and its configuration. 400 "name": "A String", # Name of the data collector in the following format: `organizations/{org}/datacollectors/{datacollector}` 401 "type": "A String", # Data type accepted by the data collector. 402 }, 403 ], 404 "debugMask": { # Debug mask that applies to all deployments in the environment. 405 "faultJSONPaths": [ # List of JSON paths that specify the JSON elements to be filtered from JSON payloads in error flows. 406 "A String", 407 ], 408 "faultXPaths": [ # List of XPaths that specify the XML elements to be filtered from XML payloads in error flows. 409 "A String", 410 ], 411 "name": "A String", # Name of the debug mask. 412 "namespaces": { # Map of namespaces to URIs. 413 "a_key": "A String", 414 }, 415 "requestJSONPaths": [ # List of JSON paths that specify the JSON elements to be filtered from JSON request message payloads. 416 "A String", 417 ], 418 "requestXPaths": [ # List of XPaths that specify the XML elements to be filtered from XML request message payloads. 419 "A String", 420 ], 421 "responseJSONPaths": [ # List of JSON paths that specify the JSON elements to be filtered from JSON response message payloads. 422 "A String", 423 ], 424 "responseXPaths": [ # List of XPaths that specify the XML elements to be filtered from XML response message payloads. 425 "A String", 426 ], 427 "variables": [ # List of variables that should be masked from the debug output. 428 "A String", 429 ], 430 }, 431 "deployments": [ # List of deployments in the environment. 432 { # NEXT ID: 9 433 "attributes": { # Additional key-value metadata for the deployment. 434 "a_key": "A String", 435 }, 436 "basePath": "A String", # Base path where the application will be hosted. Defaults to "/". 437 "location": "A String", # Location of the API proxy bundle as a URI. 438 "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}` 439 "proxyUid": "A String", # Unique ID of the API proxy revision. 440 "serviceAccount": "A String", # The service account identity associated with this deployment. If non-empty, will be in the following format: `projects/-/serviceAccounts/{account_email}` 441 "uid": "A String", # Unique ID. The ID will only change if the deployment is deleted and recreated. 442 }, 443 ], 444 "featureFlags": { # Feature flags inherited from the organization and environment. 445 "a_key": "A String", 446 }, 447 "flowhooks": [ # List of flow hooks in the environment. 448 { 449 "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). 450 "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` 451 "sharedFlowName": "A String", # Name of the shared flow to invoke in the following format: `organizations/{org}/sharedflows/{sharedflow}` 452 }, 453 ], 454 "gatewayConfigLocation": "A String", # The location for the gateway config blob as a URI, e.g. a Cloud Storage URI. This is only used by Envoy-based gateways. 455 "keystores": [ # List of keystores in the environment. 456 { 457 "aliases": [ # Aliases in the keystore. 458 { 459 "location": "A String", # Location of the alias file. For example, a Google Cloud Storage URI. 460 "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}` 461 "type": "A String", 462 }, 463 ], 464 "name": "A String", # Resource name in the following format: `organizations/{org}/environments/{env}/keystores/{keystore}` 465 }, 466 ], 467 "name": "A String", # Name of the environment configuration in the following format: `organizations/{org}/environments/{env}/configs/{config}` 468 "provider": "A String", # Used by the Control plane to add context information to help detect the source of the document during diagnostics and debugging. 469 "pubsubTopic": "A String", # Name of the PubSub topic for the environment. 470 "resourceReferences": [ # List of resource references in the environment. 471 { 472 "name": "A String", # Name of the reference in the following format: `organizations/{org}/environments/{env}/references/{reference}` 473 "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. 474 }, 475 ], 476 "resources": [ # List of resource versions in the environment. 477 { 478 "location": "A String", # Location of the resource as a URI. 479 "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. 480 }, 481 ], 482 "revisionId": "A String", # Revision ID of the environment configuration. The higher the value, the more recently the configuration was deployed. 483 "sequenceNumber": "A String", # DEPRECATED: Use revision_id. 484 "targets": [ # List of target servers in the environment. Disabled target servers are not displayed. 485 { 486 "enabled": True or False, # Whether the target server is enabled. An empty/omitted value for this field should be interpreted as true. 487 "host": "A String", # Host name of the target server. 488 "name": "A String", # Target server revision name in the following format: `organizations/{org}/environments/{env}/targetservers/{targetserver}/revisions/{rev}` 489 "port": 42, # Port number for the target server. 490 "protocol": "A String", # The protocol used by this target server. 491 "tlsInfo": { # TLS settings for the target server. 492 "ciphers": [ # List of ciphers that are granted access. 493 "A String", 494 ], 495 "clientAuthEnabled": True or False, # Flag that specifies whether client-side authentication is enabled for the target server. Enables two-way TLS. 496 "commonName": { # Common name to validate the target server against. 497 "matchWildCards": True or False, 498 "name": "A String", 499 }, 500 "enabled": True or False, # Flag that specifies whether one-way TLS is enabled. Set to `true` to enable one-way TLS. 501 "ignoreValidationErrors": True or False, # Flag that specifies whether to ignore TLS certificate validation errors. Set to `true` to ignore errors. 502 "keyAlias": "A String", # Name of the alias used for client-side authentication in the following format: `organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}` 503 "keyAliasReference": { # Reference name and alias pair to use for client-side authentication. 504 "aliasId": "A String", # Alias ID. Must exist in the keystore referred to by the reference. 505 "reference": "A String", # Reference name in the following format: `organizations/{org}/environments/{env}/references/{reference}` 506 }, 507 "protocols": [ # List of TLS protocols that are granted access. 508 "A String", 509 ], 510 "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}` 511 }, 512 }, 513 ], 514 "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. 515 "endpoint": "A String", # Endpoint of the exporter. 516 "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. 517 "name": "A String", # Name of the trace config in the following format: `organizations/{org}/environment/{env}/traceConfig` 518 "overrides": [ # List of trace configuration overrides for spicific API proxies. 519 { # NEXT ID: 7 Trace configuration override for a specific API proxy in an environment. 520 "apiProxy": "A String", # Name of the API proxy that will have its trace configuration overridden following format: `organizations/{org}/apis/{api}` 521 "name": "A String", # Name of the trace config override in the following format: `organizations/{org}/environment/{env}/traceConfig/overrides/{override}` 522 "revisionCreateTime": "A String", # The timestamp that the revision was created or updated. 523 "revisionId": "A String", # Revision number which can be used by the runtime to detect if the trace config override has changed between two versions. 524 "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. 525 "sampler": "A String", # Sampler of distributed tracing. OFF is the default value. 526 "samplingRate": 3.14, # Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5. 527 }, 528 "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. 529 }, 530 ], 531 "revisionCreateTime": "A String", # The timestamp that the revision was created or updated. 532 "revisionId": "A String", # Revision number which can be used by the runtime to detect if the trace config has changed between two versions. 533 "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. 534 "sampler": "A String", # Sampler of distributed tracing. OFF is the default value. 535 "samplingRate": 3.14, # Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5. 536 }, 537 }, 538 "uid": "A String", # Unique ID for the environment configuration. The ID will only change if the environment is deleted and recreated. 539}</pre> 540</div> 541 542<div class="method"> 543 <code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code> 544 <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. 545 546Args: 547 resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required) 548 options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 549 x__xgafv: string, V1 error format. 550 Allowed values 551 1 - v1 error format 552 2 - v2 error format 553 554Returns: 555 An object of the form: 556 557 { # 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`, or principals, to a single `role`. Principals 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:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "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:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] 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/). 558 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 559 { # 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:[email protected]" ] }, { "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:[email protected]" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts [email protected] from DATA_READ logging, and [email protected] from DATA_WRITE logging. 560 "auditLogConfigs": [ # The configuration for logging of each type of permission. 561 { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [email protected] from DATA_READ logging. 562 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. 563 "A String", 564 ], 565 "logType": "A String", # The log type that this config enables. 566 }, 567 ], 568 "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. 569 }, 570 ], 571 "bindings": [ # Associates a list of `members`, or principals, with 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 principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. 572 { # Associates `members`, or principals, with a `role`. 573 "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 principals 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). 574 "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. 575 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 576 "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. 577 "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. 578 }, 579 "members": [ # Specifies the principals 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, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?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, `[email protected]?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, `[email protected]?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`. 580 "A String", 581 ], 582 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 583 }, 584 ], 585 "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. 586 "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). 587}</pre> 588</div> 589 590<div class="method"> 591 <code class="details" id="getTraceConfig">getTraceConfig(name, x__xgafv=None)</code> 592 <pre>Get distributed trace configuration in an environment. 593 594Args: 595 name: string, Required. Name of the trace configuration. Use the following structure in your request: "organizations/*/environments/*/traceConfig". (required) 596 x__xgafv: string, V1 error format. 597 Allowed values 598 1 - v1 error format 599 2 - v2 error format 600 601Returns: 602 An object of the form: 603 604 { # TraceConfig defines the configurations in an environment of distributed trace. 605 "endpoint": "A String", # Required. Endpoint of the exporter. 606 "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. 607 "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. 608 "sampler": "A String", # Sampler of distributed tracing. OFF is the default value. 609 "samplingRate": 3.14, # Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5. 610 }, 611}</pre> 612</div> 613 614<div class="method"> 615 <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code> 616 <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. 617 618Args: 619 resource: string, REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. (required) 620 body: object, The request body. 621 The object takes the form of: 622 623{ # Request message for `SetIamPolicy` method. 624 "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`, or principals, to a single `role`. Principals 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:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "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:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] 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. 625 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 626 { # 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:[email protected]" ] }, { "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:[email protected]" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts [email protected] from DATA_READ logging, and [email protected] from DATA_WRITE logging. 627 "auditLogConfigs": [ # The configuration for logging of each type of permission. 628 { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [email protected] from DATA_READ logging. 629 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. 630 "A String", 631 ], 632 "logType": "A String", # The log type that this config enables. 633 }, 634 ], 635 "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. 636 }, 637 ], 638 "bindings": [ # Associates a list of `members`, or principals, with 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 principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. 639 { # Associates `members`, or principals, with a `role`. 640 "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 principals 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). 641 "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. 642 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 643 "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. 644 "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. 645 }, 646 "members": [ # Specifies the principals 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, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?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, `[email protected]?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, `[email protected]?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`. 647 "A String", 648 ], 649 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 650 }, 651 ], 652 "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. 653 "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). 654 }, 655 "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"` 656} 657 658 x__xgafv: string, V1 error format. 659 Allowed values 660 1 - v1 error format 661 2 - v2 error format 662 663Returns: 664 An object of the form: 665 666 { # 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`, or principals, to a single `role`. Principals 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:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "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:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] 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/). 667 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 668 { # 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:[email protected]" ] }, { "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:[email protected]" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts [email protected] from DATA_READ logging, and [email protected] from DATA_WRITE logging. 669 "auditLogConfigs": [ # The configuration for logging of each type of permission. 670 { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [email protected] from DATA_READ logging. 671 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. 672 "A String", 673 ], 674 "logType": "A String", # The log type that this config enables. 675 }, 676 ], 677 "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. 678 }, 679 ], 680 "bindings": [ # Associates a list of `members`, or principals, with 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 principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. 681 { # Associates `members`, or principals, with a `role`. 682 "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 principals 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). 683 "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. 684 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 685 "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. 686 "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. 687 }, 688 "members": [ # Specifies the principals 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, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?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, `[email protected]?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, `[email protected]?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`. 689 "A String", 690 ], 691 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 692 }, 693 ], 694 "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. 695 "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). 696}</pre> 697</div> 698 699<div class="method"> 700 <code class="details" id="subscribe">subscribe(parent, x__xgafv=None)</code> 701 <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. 702 703Args: 704 parent: string, Required. Name of the environment. Use the following structure in your request: `organizations/{org}/environments/{env}` (required) 705 x__xgafv: string, V1 error format. 706 Allowed values 707 1 - v1 error format 708 2 - v2 error format 709 710Returns: 711 An object of the form: 712 713 { # Pub/Sub subscription of an environment. 714 "name": "A String", # Full name of the Pub/Sub subcription. Use the following structure in your request: `subscription "projects/foo/subscription/bar"` 715}</pre> 716</div> 717 718<div class="method"> 719 <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code> 720 <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). 721 722Args: 723 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) 724 body: object, The request body. 725 The object takes the form of: 726 727{ # Request message for `TestIamPermissions` method. 728 "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). 729 "A String", 730 ], 731} 732 733 x__xgafv: string, V1 error format. 734 Allowed values 735 1 - v1 error format 736 2 - v2 error format 737 738Returns: 739 An object of the form: 740 741 { # Response message for `TestIamPermissions` method. 742 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 743 "A String", 744 ], 745}</pre> 746</div> 747 748<div class="method"> 749 <code class="details" id="unsubscribe">unsubscribe(parent, body=None, x__xgafv=None)</code> 750 <pre>Deletes a subscription for the environment's Pub/Sub topic. 751 752Args: 753 parent: string, Required. Name of the environment. Use the following structure in your request: `organizations/{org}/environments/{env}` (required) 754 body: object, The request body. 755 The object takes the form of: 756 757{ # Pub/Sub subscription of an environment. 758 "name": "A String", # Full name of the Pub/Sub subcription. Use the following structure in your request: `subscription "projects/foo/subscription/bar"` 759} 760 761 x__xgafv: string, V1 error format. 762 Allowed values 763 1 - v1 error format 764 2 - v2 error format 765 766Returns: 767 An object of the form: 768 769 { # 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 `{}`. 770}</pre> 771</div> 772 773<div class="method"> 774 <code class="details" id="update">update(name, body=None, x__xgafv=None)</code> 775 <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). 776 777Args: 778 name: string, Required. Name of the environment. Use the following structure in your request: `organizations/{org}/environments/{env}` (required) 779 body: object, The request body. 780 The object takes the form of: 781 782{ 783 "apiProxyType": "A String", # Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed. 784 "createdAt": "A String", # Output only. Creation time of this environment as milliseconds since epoch. 785 "deploymentType": "A String", # Optional. Deployment type supported by the environment. The deployment type can be set when creating the environment and cannot be changed. When you enable archive deployment, you will be **prevented from performing** a [subset of actions](/apigee/docs/api-platform/local-development/overview#prevented-actions) within the environment, including: * Managing the deployment of API proxy or shared flow revisions * Creating, updating, or deleting resource files * Creating, updating, or deleting target servers 786 "description": "A String", # Optional. Description of the environment. 787 "displayName": "A String", # Optional. Display name for this environment. 788 "lastModifiedAt": "A String", # Output only. Last modification time of this environment as milliseconds since epoch. 789 "name": "A String", # Required. Name of the environment. Values must match the regular expression `^[.\\p{Alnum}-_]{1,255}$` 790 "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. 791 "property": [ # List of all properties in the object 792 { # A single property entry in the Properties message. 793 "name": "A String", # The property key 794 "value": "A String", # The property value 795 }, 796 ], 797 }, 798 "state": "A String", # Output only. State of the environment. Values other than ACTIVE means the resource is not ready to use. 799} 800 801 x__xgafv: string, V1 error format. 802 Allowed values 803 1 - v1 error format 804 2 - v2 error format 805 806Returns: 807 An object of the form: 808 809 { 810 "apiProxyType": "A String", # Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed. 811 "createdAt": "A String", # Output only. Creation time of this environment as milliseconds since epoch. 812 "deploymentType": "A String", # Optional. Deployment type supported by the environment. The deployment type can be set when creating the environment and cannot be changed. When you enable archive deployment, you will be **prevented from performing** a [subset of actions](/apigee/docs/api-platform/local-development/overview#prevented-actions) within the environment, including: * Managing the deployment of API proxy or shared flow revisions * Creating, updating, or deleting resource files * Creating, updating, or deleting target servers 813 "description": "A String", # Optional. Description of the environment. 814 "displayName": "A String", # Optional. Display name for this environment. 815 "lastModifiedAt": "A String", # Output only. Last modification time of this environment as milliseconds since epoch. 816 "name": "A String", # Required. Name of the environment. Values must match the regular expression `^[.\\p{Alnum}-_]{1,255}$` 817 "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. 818 "property": [ # List of all properties in the object 819 { # A single property entry in the Properties message. 820 "name": "A String", # The property key 821 "value": "A String", # The property value 822 }, 823 ], 824 }, 825 "state": "A String", # Output only. State of the environment. Values other than ACTIVE means the resource is not ready to use. 826}</pre> 827</div> 828 829<div class="method"> 830 <code class="details" id="updateDebugmask">updateDebugmask(name, body=None, replaceRepeatedFields=None, updateMask=None, x__xgafv=None)</code> 831 <pre>Updates the debug mask singleton resource for an environment. 832 833Args: 834 name: string, Name of the debug mask. (required) 835 body: object, The request body. 836 The object takes the form of: 837 838{ 839 "faultJSONPaths": [ # List of JSON paths that specify the JSON elements to be filtered from JSON payloads in error flows. 840 "A String", 841 ], 842 "faultXPaths": [ # List of XPaths that specify the XML elements to be filtered from XML payloads in error flows. 843 "A String", 844 ], 845 "name": "A String", # Name of the debug mask. 846 "namespaces": { # Map of namespaces to URIs. 847 "a_key": "A String", 848 }, 849 "requestJSONPaths": [ # List of JSON paths that specify the JSON elements to be filtered from JSON request message payloads. 850 "A String", 851 ], 852 "requestXPaths": [ # List of XPaths that specify the XML elements to be filtered from XML request message payloads. 853 "A String", 854 ], 855 "responseJSONPaths": [ # List of JSON paths that specify the JSON elements to be filtered from JSON response message payloads. 856 "A String", 857 ], 858 "responseXPaths": [ # List of XPaths that specify the XML elements to be filtered from XML response message payloads. 859 "A String", 860 ], 861 "variables": [ # List of variables that should be masked from the debug output. 862 "A String", 863 ], 864} 865 866 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). 867 updateMask: string, Field debug mask to support partial updates. 868 x__xgafv: string, V1 error format. 869 Allowed values 870 1 - v1 error format 871 2 - v2 error format 872 873Returns: 874 An object of the form: 875 876 { 877 "faultJSONPaths": [ # List of JSON paths that specify the JSON elements to be filtered from JSON payloads in error flows. 878 "A String", 879 ], 880 "faultXPaths": [ # List of XPaths that specify the XML elements to be filtered from XML payloads in error flows. 881 "A String", 882 ], 883 "name": "A String", # Name of the debug mask. 884 "namespaces": { # Map of namespaces to URIs. 885 "a_key": "A String", 886 }, 887 "requestJSONPaths": [ # List of JSON paths that specify the JSON elements to be filtered from JSON request message payloads. 888 "A String", 889 ], 890 "requestXPaths": [ # List of XPaths that specify the XML elements to be filtered from XML request message payloads. 891 "A String", 892 ], 893 "responseJSONPaths": [ # List of JSON paths that specify the JSON elements to be filtered from JSON response message payloads. 894 "A String", 895 ], 896 "responseXPaths": [ # List of XPaths that specify the XML elements to be filtered from XML response message payloads. 897 "A String", 898 ], 899 "variables": [ # List of variables that should be masked from the debug output. 900 "A String", 901 ], 902}</pre> 903</div> 904 905<div class="method"> 906 <code class="details" id="updateEnvironment">updateEnvironment(name, body=None, x__xgafv=None)</code> 907 <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). 908 909Args: 910 name: string, Required. Name of the environment. Use the following structure in your request: `organizations/{org}/environments/{env}` (required) 911 body: object, The request body. 912 The object takes the form of: 913 914{ 915 "apiProxyType": "A String", # Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed. 916 "createdAt": "A String", # Output only. Creation time of this environment as milliseconds since epoch. 917 "deploymentType": "A String", # Optional. Deployment type supported by the environment. The deployment type can be set when creating the environment and cannot be changed. When you enable archive deployment, you will be **prevented from performing** a [subset of actions](/apigee/docs/api-platform/local-development/overview#prevented-actions) within the environment, including: * Managing the deployment of API proxy or shared flow revisions * Creating, updating, or deleting resource files * Creating, updating, or deleting target servers 918 "description": "A String", # Optional. Description of the environment. 919 "displayName": "A String", # Optional. Display name for this environment. 920 "lastModifiedAt": "A String", # Output only. Last modification time of this environment as milliseconds since epoch. 921 "name": "A String", # Required. Name of the environment. Values must match the regular expression `^[.\\p{Alnum}-_]{1,255}$` 922 "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. 923 "property": [ # List of all properties in the object 924 { # A single property entry in the Properties message. 925 "name": "A String", # The property key 926 "value": "A String", # The property value 927 }, 928 ], 929 }, 930 "state": "A String", # Output only. State of the environment. Values other than ACTIVE means the resource is not ready to use. 931} 932 933 x__xgafv: string, V1 error format. 934 Allowed values 935 1 - v1 error format 936 2 - v2 error format 937 938Returns: 939 An object of the form: 940 941 { 942 "apiProxyType": "A String", # Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed. 943 "createdAt": "A String", # Output only. Creation time of this environment as milliseconds since epoch. 944 "deploymentType": "A String", # Optional. Deployment type supported by the environment. The deployment type can be set when creating the environment and cannot be changed. When you enable archive deployment, you will be **prevented from performing** a [subset of actions](/apigee/docs/api-platform/local-development/overview#prevented-actions) within the environment, including: * Managing the deployment of API proxy or shared flow revisions * Creating, updating, or deleting resource files * Creating, updating, or deleting target servers 945 "description": "A String", # Optional. Description of the environment. 946 "displayName": "A String", # Optional. Display name for this environment. 947 "lastModifiedAt": "A String", # Output only. Last modification time of this environment as milliseconds since epoch. 948 "name": "A String", # Required. Name of the environment. Values must match the regular expression `^[.\\p{Alnum}-_]{1,255}$` 949 "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. 950 "property": [ # List of all properties in the object 951 { # A single property entry in the Properties message. 952 "name": "A String", # The property key 953 "value": "A String", # The property value 954 }, 955 ], 956 }, 957 "state": "A String", # Output only. State of the environment. Values other than ACTIVE means the resource is not ready to use. 958}</pre> 959</div> 960 961<div class="method"> 962 <code class="details" id="updateTraceConfig">updateTraceConfig(name, body=None, updateMask=None, x__xgafv=None)</code> 963 <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. 964 965Args: 966 name: string, Required. Name of the trace configuration. Use the following structure in your request: "organizations/*/environments/*/traceConfig". (required) 967 body: object, The request body. 968 The object takes the form of: 969 970{ # TraceConfig defines the configurations in an environment of distributed trace. 971 "endpoint": "A String", # Required. Endpoint of the exporter. 972 "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. 973 "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. 974 "sampler": "A String", # Sampler of distributed tracing. OFF is the default value. 975 "samplingRate": 3.14, # Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5. 976 }, 977} 978 979 updateMask: string, List of fields to be updated. 980 x__xgafv: string, V1 error format. 981 Allowed values 982 1 - v1 error format 983 2 - v2 error format 984 985Returns: 986 An object of the form: 987 988 { # TraceConfig defines the configurations in an environment of distributed trace. 989 "endpoint": "A String", # Required. Endpoint of the exporter. 990 "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. 991 "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. 992 "sampler": "A String", # Sampler of distributed tracing. OFF is the default value. 993 "samplingRate": 3.14, # Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5. 994 }, 995}</pre> 996</div> 997 998</body></html>