diff --git a/.github/.OwlBot.lock.yaml b/.github/.OwlBot.lock.yaml index 98994f47410..ae4a522b9e5 100644 --- a/.github/.OwlBot.lock.yaml +++ b/.github/.OwlBot.lock.yaml @@ -13,5 +13,5 @@ # limitations under the License. docker: image: gcr.io/cloud-devrel-public-resources/owlbot-python:latest - digest: sha256:2d816f26f728ac8b24248741e7d4c461c09764ef9f7be3684d557c9632e46dbd -# created: 2023-06-28T17:03:33.371210701Z + digest: sha256:39f0f3f2be02ef036e297e376fe3b6256775576da8a6ccb1d5eeb80f4c8bf8fb +# created: 2023-07-17T15:20:13.819193964Z diff --git a/.github/auto-label.yaml b/.github/auto-label.yaml index 41bff0b5375..b2016d119b4 100644 --- a/.github/auto-label.yaml +++ b/.github/auto-label.yaml @@ -1,4 +1,4 @@ -# Copyright 2022 Google LLC +# Copyright 2023 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. diff --git a/.kokoro/build.sh b/.kokoro/build.sh index 72abfa4086b..6bf9d9be8dd 100755 --- a/.kokoro/build.sh +++ b/.kokoro/build.sh @@ -1,5 +1,5 @@ #!/bin/bash -# Copyright 2018 Google LLC +# Copyright 2023 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. diff --git a/.kokoro/populate-secrets.sh b/.kokoro/populate-secrets.sh index f52514257ef..6f3972140e8 100755 --- a/.kokoro/populate-secrets.sh +++ b/.kokoro/populate-secrets.sh @@ -1,5 +1,5 @@ #!/bin/bash -# Copyright 2020 Google LLC. +# Copyright 2023 Google LLC. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. diff --git a/.kokoro/release.sh b/.kokoro/release.sh index e41b1641923..d3276a980a4 100755 --- a/.kokoro/release.sh +++ b/.kokoro/release.sh @@ -1,5 +1,5 @@ #!/bin/bash -# Copyright 2020 Google LLC +# Copyright 2023 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. diff --git a/.kokoro/requirements.txt b/.kokoro/requirements.txt index c7929db6d15..67d70a11089 100644 --- a/.kokoro/requirements.txt +++ b/.kokoro/requirements.txt @@ -113,26 +113,30 @@ commonmark==0.9.1 \ --hash=sha256:452f9dc859be7f06631ddcb328b6919c67984aca654e5fefb3914d54691aed60 \ --hash=sha256:da2f38c92590f83de410ba1a3cbceafbc74fee9def35f9251ba9a971d6d66fd9 # via rich -cryptography==41.0.0 \ - --hash=sha256:0ddaee209d1cf1f180f1efa338a68c4621154de0afaef92b89486f5f96047c55 \ - --hash=sha256:14754bcdae909d66ff24b7b5f166d69340ccc6cb15731670435efd5719294895 \ - --hash=sha256:344c6de9f8bda3c425b3a41b319522ba3208551b70c2ae00099c205f0d9fd3be \ - --hash=sha256:34d405ea69a8b34566ba3dfb0521379b210ea5d560fafedf9f800a9a94a41928 \ - --hash=sha256:3680248309d340fda9611498a5319b0193a8dbdb73586a1acf8109d06f25b92d \ - --hash=sha256:3c5ef25d060c80d6d9f7f9892e1d41bb1c79b78ce74805b8cb4aa373cb7d5ec8 \ - --hash=sha256:4ab14d567f7bbe7f1cdff1c53d5324ed4d3fc8bd17c481b395db224fb405c237 \ - --hash=sha256:5c1f7293c31ebc72163a9a0df246f890d65f66b4a40d9ec80081969ba8c78cc9 \ - --hash=sha256:6b71f64beeea341c9b4f963b48ee3b62d62d57ba93eb120e1196b31dc1025e78 \ - --hash=sha256:7d92f0248d38faa411d17f4107fc0bce0c42cae0b0ba5415505df72d751bf62d \ - --hash=sha256:8362565b3835ceacf4dc8f3b56471a2289cf51ac80946f9087e66dc283a810e0 \ - --hash=sha256:84a165379cb9d411d58ed739e4af3396e544eac190805a54ba2e0322feb55c46 \ - --hash=sha256:88ff107f211ea696455ea8d911389f6d2b276aabf3231bf72c8853d22db755c5 \ - --hash=sha256:9f65e842cb02550fac96536edb1d17f24c0a338fd84eaf582be25926e993dde4 \ - --hash=sha256:a4fc68d1c5b951cfb72dfd54702afdbbf0fb7acdc9b7dc4301bbf2225a27714d \ - --hash=sha256:b7f2f5c525a642cecad24ee8670443ba27ac1fab81bba4cc24c7b6b41f2d0c75 \ - --hash=sha256:b846d59a8d5a9ba87e2c3d757ca019fa576793e8758174d3868aecb88d6fc8eb \ - --hash=sha256:bf8fc66012ca857d62f6a347007e166ed59c0bc150cefa49f28376ebe7d992a2 \ - --hash=sha256:f5d0bf9b252f30a31664b6f64432b4730bb7038339bd18b1fafe129cfc2be9be +cryptography==41.0.2 \ + --hash=sha256:01f1d9e537f9a15b037d5d9ee442b8c22e3ae11ce65ea1f3316a41c78756b711 \ + --hash=sha256:079347de771f9282fbfe0e0236c716686950c19dee1b76240ab09ce1624d76d7 \ + --hash=sha256:182be4171f9332b6741ee818ec27daff9fb00349f706629f5cbf417bd50e66fd \ + --hash=sha256:192255f539d7a89f2102d07d7375b1e0a81f7478925b3bc2e0549ebf739dae0e \ + --hash=sha256:2a034bf7d9ca894720f2ec1d8b7b5832d7e363571828037f9e0c4f18c1b58a58 \ + --hash=sha256:342f3767e25876751e14f8459ad85e77e660537ca0a066e10e75df9c9e9099f0 \ + --hash=sha256:439c3cc4c0d42fa999b83ded80a9a1fb54d53c58d6e59234cfe97f241e6c781d \ + --hash=sha256:49c3222bb8f8e800aead2e376cbef687bc9e3cb9b58b29a261210456a7783d83 \ + --hash=sha256:674b669d5daa64206c38e507808aae49904c988fa0a71c935e7006a3e1e83831 \ + --hash=sha256:7a9a3bced53b7f09da251685224d6a260c3cb291768f54954e28f03ef14e3766 \ + --hash=sha256:7af244b012711a26196450d34f483357e42aeddb04128885d95a69bd8b14b69b \ + --hash=sha256:7d230bf856164de164ecb615ccc14c7fc6de6906ddd5b491f3af90d3514c925c \ + --hash=sha256:84609ade00a6ec59a89729e87a503c6e36af98ddcd566d5f3be52e29ba993182 \ + --hash=sha256:9a6673c1828db6270b76b22cc696f40cde9043eb90373da5c2f8f2158957f42f \ + --hash=sha256:9b6d717393dbae53d4e52684ef4f022444fc1cce3c48c38cb74fca29e1f08eaa \ + --hash=sha256:9c3fe6534d59d071ee82081ca3d71eed3210f76ebd0361798c74abc2bcf347d4 \ + --hash=sha256:a719399b99377b218dac6cf547b6ec54e6ef20207b6165126a280b0ce97e0d2a \ + --hash=sha256:b332cba64d99a70c1e0836902720887fb4529ea49ea7f5462cf6640e095e11d2 \ + --hash=sha256:d124682c7a23c9764e54ca9ab5b308b14b18eba02722b8659fb238546de83a76 \ + --hash=sha256:d73f419a56d74fef257955f51b18d046f3506270a5fd2ac5febbfa259d6c0fa5 \ + --hash=sha256:f0dc40e6f7aa37af01aba07277d3d64d5a03dc66d682097541ec4da03cc140ee \ + --hash=sha256:f14ad275364c8b4e525d018f6716537ae7b6d369c094805cae45300847e0894f \ + --hash=sha256:f772610fe364372de33d76edcd313636a25684edb94cee53fd790195f5989d14 # via # gcp-releasetool # secretstorage diff --git a/.kokoro/test-samples-against-head.sh b/.kokoro/test-samples-against-head.sh index ba3a707b040..63ac41dfae1 100755 --- a/.kokoro/test-samples-against-head.sh +++ b/.kokoro/test-samples-against-head.sh @@ -1,5 +1,5 @@ #!/bin/bash -# Copyright 2020 Google LLC +# Copyright 2023 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. diff --git a/.kokoro/test-samples-impl.sh b/.kokoro/test-samples-impl.sh index 2c6500cae0b..5a0f5fab6a8 100755 --- a/.kokoro/test-samples-impl.sh +++ b/.kokoro/test-samples-impl.sh @@ -1,5 +1,5 @@ #!/bin/bash -# Copyright 2021 Google LLC +# Copyright 2023 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. diff --git a/.kokoro/test-samples.sh b/.kokoro/test-samples.sh index 11c042d342d..50b35a48c19 100755 --- a/.kokoro/test-samples.sh +++ b/.kokoro/test-samples.sh @@ -1,5 +1,5 @@ #!/bin/bash -# Copyright 2020 Google LLC +# Copyright 2023 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. diff --git a/.kokoro/trampoline.sh b/.kokoro/trampoline.sh index f39236e943a..d85b1f26769 100755 --- a/.kokoro/trampoline.sh +++ b/.kokoro/trampoline.sh @@ -1,5 +1,5 @@ #!/bin/bash -# Copyright 2017 Google Inc. +# Copyright 2023 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. diff --git a/.kokoro/trampoline_v2.sh b/.kokoro/trampoline_v2.sh index 4af6cdc26db..59a7cf3a937 100755 --- a/.kokoro/trampoline_v2.sh +++ b/.kokoro/trampoline_v2.sh @@ -1,5 +1,5 @@ #!/usr/bin/env bash -# Copyright 2020 Google LLC +# Copyright 2023 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. diff --git a/.trampolinerc b/.trampolinerc index 0eee72ab62a..a7dfeb42c6d 100644 --- a/.trampolinerc +++ b/.trampolinerc @@ -1,4 +1,4 @@ -# Copyright 2020 Google LLC +# Copyright 2023 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. @@ -12,8 +12,6 @@ # See the License for the specific language governing permissions and # limitations under the License. -# Template for .trampolinerc - # Add required env vars here. required_envvars+=( ) diff --git a/CHANGELOG.md b/CHANGELOG.md index 91ea328f039..d0ed11b58ed 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,59 @@ # Changelog +## [2.93.0](https://github.com/googleapis/google-api-python-client/compare/v2.92.0...v2.93.0) (2023-07-11) + + +### Features + +* **adexchangebuyer2:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/17e91de14eff5891b83b846a8d754f3cde34b729 ([7c1d933](https://github.com/googleapis/google-api-python-client/commit/7c1d9337e5e0ce8e85f0aa6eb6faaeccf2d98f78)) +* **analyticshub:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/e2cc174109186c5f17757b5d9efd457e9316b74a ([7c1d933](https://github.com/googleapis/google-api-python-client/commit/7c1d9337e5e0ce8e85f0aa6eb6faaeccf2d98f78)) +* **androidmanagement:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/e8487eb00256af7556a4b6d90beab5db914e10ad ([7c1d933](https://github.com/googleapis/google-api-python-client/commit/7c1d9337e5e0ce8e85f0aa6eb6faaeccf2d98f78)) +* **apigee:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/5dbf40ff940b170357582a4acce563b59c6a7a17 ([7c1d933](https://github.com/googleapis/google-api-python-client/commit/7c1d9337e5e0ce8e85f0aa6eb6faaeccf2d98f78)) +* **bigquerydatatransfer:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/d0709e754b2732e6346a4627a91be8b672c03b09 ([7c1d933](https://github.com/googleapis/google-api-python-client/commit/7c1d9337e5e0ce8e85f0aa6eb6faaeccf2d98f78)) +* **chat:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/bb922afb7ac0957ce1581dcef923c5630744cc56 ([7c1d933](https://github.com/googleapis/google-api-python-client/commit/7c1d9337e5e0ce8e85f0aa6eb6faaeccf2d98f78)) +* **cloudchannel:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/10b9a9dd947f4093e62793ac7b4a7fc0b9209a7b ([7c1d933](https://github.com/googleapis/google-api-python-client/commit/7c1d9337e5e0ce8e85f0aa6eb6faaeccf2d98f78)) +* **cloudidentity:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/65f98f288a5c6d0a615c4fc8579daec192413596 ([7c1d933](https://github.com/googleapis/google-api-python-client/commit/7c1d9337e5e0ce8e85f0aa6eb6faaeccf2d98f78)) +* **cloudscheduler:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/5fbe35e0c27baa036ef651b583dc1bf9508b65c9 ([7c1d933](https://github.com/googleapis/google-api-python-client/commit/7c1d9337e5e0ce8e85f0aa6eb6faaeccf2d98f78)) +* **cloudsearch:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/12c65fc656c67cdcfd27dd8f3e28216df81d22cc ([7c1d933](https://github.com/googleapis/google-api-python-client/commit/7c1d9337e5e0ce8e85f0aa6eb6faaeccf2d98f78)) +* **cloudsupport:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/05cf67ca991aacef165c3cd9e762156df987b0a6 ([7c1d933](https://github.com/googleapis/google-api-python-client/commit/7c1d9337e5e0ce8e85f0aa6eb6faaeccf2d98f78)) +* **compute:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/4ac1f14098672078def80cc16261a7c22c367376 ([7c1d933](https://github.com/googleapis/google-api-python-client/commit/7c1d9337e5e0ce8e85f0aa6eb6faaeccf2d98f78)) +* **connectors:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/665f2788e0d0724df302e3f0d46cfbd8c6ac4fc0 ([7c1d933](https://github.com/googleapis/google-api-python-client/commit/7c1d9337e5e0ce8e85f0aa6eb6faaeccf2d98f78)) +* **contactcenterinsights:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/e827d13a807d11a9d75956388549a436b31a0b19 ([7c1d933](https://github.com/googleapis/google-api-python-client/commit/7c1d9337e5e0ce8e85f0aa6eb6faaeccf2d98f78)) +* **container:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/24a5d47603714ca234c4f36dad6c90ac7ebb5e91 ([7c1d933](https://github.com/googleapis/google-api-python-client/commit/7c1d9337e5e0ce8e85f0aa6eb6faaeccf2d98f78)) +* **content:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/baa99b49d61591dc99dd968c170cbd8f211c45c7 ([7c1d933](https://github.com/googleapis/google-api-python-client/commit/7c1d9337e5e0ce8e85f0aa6eb6faaeccf2d98f78)) +* **dataflow:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/a00b9d57f212bccc5e1510009b98a80f4b42ba18 ([7c1d933](https://github.com/googleapis/google-api-python-client/commit/7c1d9337e5e0ce8e85f0aa6eb6faaeccf2d98f78)) +* **datamigration:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/c275ececb7cf18cd582517cb0e82d92eb84c9b3e ([7c1d933](https://github.com/googleapis/google-api-python-client/commit/7c1d9337e5e0ce8e85f0aa6eb6faaeccf2d98f78)) +* **dataplex:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/a4f67fef06c67515b8a079d07f55f44210293169 ([7c1d933](https://github.com/googleapis/google-api-python-client/commit/7c1d9337e5e0ce8e85f0aa6eb6faaeccf2d98f78)) +* **datastream:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/4652acf3f38abc4e100e76e27fa57d10f6ce5395 ([7c1d933](https://github.com/googleapis/google-api-python-client/commit/7c1d9337e5e0ce8e85f0aa6eb6faaeccf2d98f78)) +* **dialogflow:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/a172f8677145072d60842d6df2b732f5c9867b1e ([7c1d933](https://github.com/googleapis/google-api-python-client/commit/7c1d9337e5e0ce8e85f0aa6eb6faaeccf2d98f78)) +* **dlp:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/851899a071925a54ec9e35c08eed58be6dd6612c ([7c1d933](https://github.com/googleapis/google-api-python-client/commit/7c1d9337e5e0ce8e85f0aa6eb6faaeccf2d98f78)) +* **dns:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/30ba2df411d710d8d67ab9a6911f6858e61814a9 ([7c1d933](https://github.com/googleapis/google-api-python-client/commit/7c1d9337e5e0ce8e85f0aa6eb6faaeccf2d98f78)) +* **driveactivity:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/1af6d44b803f41e4e86661b494a4d8ab79ebe918 ([7c1d933](https://github.com/googleapis/google-api-python-client/commit/7c1d9337e5e0ce8e85f0aa6eb6faaeccf2d98f78)) +* **gkeonprem:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/ec68f6114bcade96287add8947ecfd93eef56399 ([7c1d933](https://github.com/googleapis/google-api-python-client/commit/7c1d9337e5e0ce8e85f0aa6eb6faaeccf2d98f78)) +* **gmail:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/cb453782b68e22687c97ff8253df7088a1a11e9e ([7c1d933](https://github.com/googleapis/google-api-python-client/commit/7c1d9337e5e0ce8e85f0aa6eb6faaeccf2d98f78)) +* **healthcare:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/ba19f545665fbfa21f9d0372566596e37150ed55 ([7c1d933](https://github.com/googleapis/google-api-python-client/commit/7c1d9337e5e0ce8e85f0aa6eb6faaeccf2d98f78)) +* **identitytoolkit:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/0e16f04b759c2e4c4ae9b38f0b4419f7f1dc812d ([7c1d933](https://github.com/googleapis/google-api-python-client/commit/7c1d9337e5e0ce8e85f0aa6eb6faaeccf2d98f78)) +* **jobs:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/8b25b6231f91022e2dc4105d09951971c1049521 ([7c1d933](https://github.com/googleapis/google-api-python-client/commit/7c1d9337e5e0ce8e85f0aa6eb6faaeccf2d98f78)) +* **kmsinventory:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/b5ec33098d6ea2fa21acca6ae2d391ae083f4355 ([7c1d933](https://github.com/googleapis/google-api-python-client/commit/7c1d9337e5e0ce8e85f0aa6eb6faaeccf2d98f78)) +* **managedidentities:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/5713afdd11c4d076b09e3e8afaafa532c540533b ([7c1d933](https://github.com/googleapis/google-api-python-client/commit/7c1d9337e5e0ce8e85f0aa6eb6faaeccf2d98f78)) +* **migrationcenter:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/a36c48405556dc3dbaa177a5e539ea9835fc5559 ([7c1d933](https://github.com/googleapis/google-api-python-client/commit/7c1d9337e5e0ce8e85f0aa6eb6faaeccf2d98f78)) +* **monitoring:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/cfb967882294ecc950440367b75183a93cc83fdf ([7c1d933](https://github.com/googleapis/google-api-python-client/commit/7c1d9337e5e0ce8e85f0aa6eb6faaeccf2d98f78)) +* **networkmanagement:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/904d51e06f957a6a36f2f2098dcf53500b692bfc ([7c1d933](https://github.com/googleapis/google-api-python-client/commit/7c1d9337e5e0ce8e85f0aa6eb6faaeccf2d98f78)) +* **notebooks:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/319e43d3613c7c9a96cfce4a700419b0499276fb ([7c1d933](https://github.com/googleapis/google-api-python-client/commit/7c1d9337e5e0ce8e85f0aa6eb6faaeccf2d98f78)) +* **orgpolicy:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/e57084770c9664a833c21ca870ca4a43be925965 ([7c1d933](https://github.com/googleapis/google-api-python-client/commit/7c1d9337e5e0ce8e85f0aa6eb6faaeccf2d98f78)) +* **pagespeedonline:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/71893b6fc704d063f78e95dd520f6b445f2843b7 ([7c1d933](https://github.com/googleapis/google-api-python-client/commit/7c1d9337e5e0ce8e85f0aa6eb6faaeccf2d98f78)) +* **prod_tt_sasportal:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/2bf3b2b7d7e70759b2eec4a5cdacf38bc664883f ([7c1d933](https://github.com/googleapis/google-api-python-client/commit/7c1d9337e5e0ce8e85f0aa6eb6faaeccf2d98f78)) +* **realtimebidding:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/452112161b4bbed49ef4784a3e215ce688494806 ([7c1d933](https://github.com/googleapis/google-api-python-client/commit/7c1d9337e5e0ce8e85f0aa6eb6faaeccf2d98f78)) +* **retail:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/bf6e2f19f28baa85faf335d3d5e54edb83c7cebd ([7c1d933](https://github.com/googleapis/google-api-python-client/commit/7c1d9337e5e0ce8e85f0aa6eb6faaeccf2d98f78)) +* **securitycenter:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/c77cccba21e0c6254f6ac80b12afe57c777fba4a ([7c1d933](https://github.com/googleapis/google-api-python-client/commit/7c1d9337e5e0ce8e85f0aa6eb6faaeccf2d98f78)) +* **serviceconsumermanagement:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/2eaf43686566e714add87489ac817f87a9045b3d ([7c1d933](https://github.com/googleapis/google-api-python-client/commit/7c1d9337e5e0ce8e85f0aa6eb6faaeccf2d98f78)) +* **serviceusage:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/28e75eaf1f758114a3785293faa818e813d79d5e ([7c1d933](https://github.com/googleapis/google-api-python-client/commit/7c1d9337e5e0ce8e85f0aa6eb6faaeccf2d98f78)) +* **tagmanager:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/4b2b1e96e8cb1f666036dc4e0aea37aa75c7950d ([7c1d933](https://github.com/googleapis/google-api-python-client/commit/7c1d9337e5e0ce8e85f0aa6eb6faaeccf2d98f78)) +* **testing:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/5062c43ff55aa05993cb090a83d9b00d58d57f1d ([7c1d933](https://github.com/googleapis/google-api-python-client/commit/7c1d9337e5e0ce8e85f0aa6eb6faaeccf2d98f78)) +* **websecurityscanner:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/f1630719a7b69d8f63e410ed29c2d94362b80d63 ([7c1d933](https://github.com/googleapis/google-api-python-client/commit/7c1d9337e5e0ce8e85f0aa6eb6faaeccf2d98f78)) +* **workloadmanager:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/f2aaf834f6a9b094ca7b96ec0fe44c1231a7e9f2 ([7c1d933](https://github.com/googleapis/google-api-python-client/commit/7c1d9337e5e0ce8e85f0aa6eb6faaeccf2d98f78)) +* **youtube:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/f8449ddd298b8e3c0db65f0669914fcec5f8aa1c ([7c1d933](https://github.com/googleapis/google-api-python-client/commit/7c1d9337e5e0ce8e85f0aa6eb6faaeccf2d98f78)) + ## [2.92.0](https://github.com/googleapis/google-api-python-client/compare/v2.91.0...v2.92.0) (2023-07-05) diff --git a/docs/dyn/analyticshub_v1beta1.projects.locations.dataExchanges.listings.html b/docs/dyn/analyticshub_v1beta1.projects.locations.dataExchanges.listings.html index b9f98325fbf..4f207aa6fde 100644 --- a/docs/dyn/analyticshub_v1beta1.projects.locations.dataExchanges.listings.html +++ b/docs/dyn/analyticshub_v1beta1.projects.locations.dataExchanges.listings.html @@ -144,6 +144,11 @@

Method Details

"primaryContact": "A String", # Optional. Email or URL of the listing publisher. Max Length: 1000 bytes. }, "requestAccess": "A String", # Optional. Email or URL of the request access of the listing. Subscribers can use this reference to request access. Max Length: 1000 bytes. + "restrictedExportConfig": { # Restricted export config, used to configure restricted export on linked dataset. # Optional. If set, restricted export configuration will be propagated and enforced on the linked dataset. + "enabled": True or False, # Optional. If true, enable restricted export. + "restrictDirectTableAccess": True or False, # Output only. If true, restrict direct table access(read api/tabledata.list) on linked table. + "restrictQueryResult": True or False, # Optional. If true, restrict export of query result derived from restricted linked dataset table. + }, "state": "A String", # Output only. Current state of the listing. } @@ -178,6 +183,11 @@

Method Details

"primaryContact": "A String", # Optional. Email or URL of the listing publisher. Max Length: 1000 bytes. }, "requestAccess": "A String", # Optional. Email or URL of the request access of the listing. Subscribers can use this reference to request access. Max Length: 1000 bytes. + "restrictedExportConfig": { # Restricted export config, used to configure restricted export on linked dataset. # Optional. If set, restricted export configuration will be propagated and enforced on the linked dataset. + "enabled": True or False, # Optional. If true, enable restricted export. + "restrictDirectTableAccess": True or False, # Output only. If true, restrict direct table access(read api/tabledata.list) on linked table. + "restrictQueryResult": True or False, # Optional. If true, restrict export of query result derived from restricted linked dataset table. + }, "state": "A String", # Output only. Current state of the listing. } @@ -236,6 +246,11 @@

Method Details

"primaryContact": "A String", # Optional. Email or URL of the listing publisher. Max Length: 1000 bytes. }, "requestAccess": "A String", # Optional. Email or URL of the request access of the listing. Subscribers can use this reference to request access. Max Length: 1000 bytes. + "restrictedExportConfig": { # Restricted export config, used to configure restricted export on linked dataset. # Optional. If set, restricted export configuration will be propagated and enforced on the linked dataset. + "enabled": True or False, # Optional. If true, enable restricted export. + "restrictDirectTableAccess": True or False, # Output only. If true, restrict direct table access(read api/tabledata.list) on linked table. + "restrictQueryResult": True or False, # Optional. If true, restrict export of query result derived from restricted linked dataset table. + }, "state": "A String", # Output only. Current state of the listing. } @@ -336,6 +351,11 @@

Method Details

"primaryContact": "A String", # Optional. Email or URL of the listing publisher. Max Length: 1000 bytes. }, "requestAccess": "A String", # Optional. Email or URL of the request access of the listing. Subscribers can use this reference to request access. Max Length: 1000 bytes. + "restrictedExportConfig": { # Restricted export config, used to configure restricted export on linked dataset. # Optional. If set, restricted export configuration will be propagated and enforced on the linked dataset. + "enabled": True or False, # Optional. If true, enable restricted export. + "restrictDirectTableAccess": True or False, # Output only. If true, restrict direct table access(read api/tabledata.list) on linked table. + "restrictQueryResult": True or False, # Optional. If true, restrict export of query result derived from restricted linked dataset table. + }, "state": "A String", # Output only. Current state of the listing. }, ], @@ -388,6 +408,11 @@

Method Details

"primaryContact": "A String", # Optional. Email or URL of the listing publisher. Max Length: 1000 bytes. }, "requestAccess": "A String", # Optional. Email or URL of the request access of the listing. Subscribers can use this reference to request access. Max Length: 1000 bytes. + "restrictedExportConfig": { # Restricted export config, used to configure restricted export on linked dataset. # Optional. If set, restricted export configuration will be propagated and enforced on the linked dataset. + "enabled": True or False, # Optional. If true, enable restricted export. + "restrictDirectTableAccess": True or False, # Output only. If true, restrict direct table access(read api/tabledata.list) on linked table. + "restrictQueryResult": True or False, # Optional. If true, restrict export of query result derived from restricted linked dataset table. + }, "state": "A String", # Output only. Current state of the listing. } @@ -422,6 +447,11 @@

Method Details

"primaryContact": "A String", # Optional. Email or URL of the listing publisher. Max Length: 1000 bytes. }, "requestAccess": "A String", # Optional. Email or URL of the request access of the listing. Subscribers can use this reference to request access. Max Length: 1000 bytes. + "restrictedExportConfig": { # Restricted export config, used to configure restricted export on linked dataset. # Optional. If set, restricted export configuration will be propagated and enforced on the linked dataset. + "enabled": True or False, # Optional. If true, enable restricted export. + "restrictDirectTableAccess": True or False, # Output only. If true, restrict direct table access(read api/tabledata.list) on linked table. + "restrictQueryResult": True or False, # Optional. If true, restrict export of query result derived from restricted linked dataset table. + }, "state": "A String", # Output only. Current state of the listing. } diff --git a/docs/dyn/androidmanagement_v1.html b/docs/dyn/androidmanagement_v1.html index 12beb8bf447..a53d5961784 100644 --- a/docs/dyn/androidmanagement_v1.html +++ b/docs/dyn/androidmanagement_v1.html @@ -79,6 +79,11 @@

Instance Methods

Returns the enterprises Resource.

+

+ provisioningInfo() +

+

Returns the provisioningInfo Resource.

+

signupUrls()

diff --git a/docs/dyn/androidmanagement_v1.provisioningInfo.html b/docs/dyn/androidmanagement_v1.provisioningInfo.html new file mode 100644 index 00000000000..ad779ac6249 --- /dev/null +++ b/docs/dyn/androidmanagement_v1.provisioningInfo.html @@ -0,0 +1,115 @@ + + + +

Android Management API . provisioningInfo

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Get the device provisioning info by the identifier provided via the sign-in url.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Get the device provisioning info by the identifier provided via the sign-in url.
+
+Args:
+  name: string, Required. The identifier that Android Device Policy passes to the 3P sign-in page in the form of provisioningInfo/{provisioning_info}. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Information about a device that is available during setup.
+  "apiLevel": 42, # The API level of the Android platform version running on the device.
+  "authenticatedUserEmail": "A String", # The email address of the authenticated user (only present for Google Account provisioning method).
+  "brand": "A String", # Brand of the device. For example, Google.
+  "enterprise": "A String", # The name of the enterprise in the form enterprises/{enterprise}.
+  "managementMode": "A String", # The management mode of the device or profile.
+  "model": "A String", # The model of the device. For example, Asus Nexus 7.
+  "name": "A String", # The name of this resource in the form provisioningInfo/{provisioning_info}.
+  "ownership": "A String", # Ownership of the managed device.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/apigee_v1.organizations.html b/docs/dyn/apigee_v1.organizations.html index 8a4944110f3..25b850cfa6c 100644 --- a/docs/dyn/apigee_v1.organizations.html +++ b/docs/dyn/apigee_v1.organizations.html @@ -268,6 +268,7 @@

Method Details

"createdAt": "A String", # Output only. Time that the Apigee organization was created in milliseconds since epoch. "customerName": "A String", # Not used by Apigee. "description": "A String", # Description of the Apigee organization. + "disableVpcPeering": True or False, # Optional. Flag that specifies whether the VPC Peering through Private Google Access should be disabled between the consumer network and Apigee. Valid only when RuntimeType is set to CLOUD. Required if an authorizedNetwork on the consumer project is not provided, in which case the flag should be set to true. The value must be set before the creation of any Apigee runtime instance and can be updated only when there are no runtime instances. **Note:** Apigee will be deprecating the vpc peering model that requires you to provide 'authorizedNetwork', by making the non-peering model as the default way of provisioning Apigee organization in future. So, this will be a temporary flag to enable the transition. Not supported for Apigee hybrid. "displayName": "A String", # Display name for the Apigee organization. Unused, but reserved for future use. "environments": [ # Output only. List of environments in the Apigee organization. "A String", @@ -409,6 +410,7 @@

Method Details

"createdAt": "A String", # Output only. Time that the Apigee organization was created in milliseconds since epoch. "customerName": "A String", # Not used by Apigee. "description": "A String", # Description of the Apigee organization. + "disableVpcPeering": True or False, # Optional. Flag that specifies whether the VPC Peering through Private Google Access should be disabled between the consumer network and Apigee. Valid only when RuntimeType is set to CLOUD. Required if an authorizedNetwork on the consumer project is not provided, in which case the flag should be set to true. The value must be set before the creation of any Apigee runtime instance and can be updated only when there are no runtime instances. **Note:** Apigee will be deprecating the vpc peering model that requires you to provide 'authorizedNetwork', by making the non-peering model as the default way of provisioning Apigee organization in future. So, this will be a temporary flag to enable the transition. Not supported for Apigee hybrid. "displayName": "A String", # Display name for the Apigee organization. Unused, but reserved for future use. "environments": [ # Output only. List of environments in the Apigee organization. "A String", @@ -730,6 +732,7 @@

Method Details

"createdAt": "A String", # Output only. Time that the Apigee organization was created in milliseconds since epoch. "customerName": "A String", # Not used by Apigee. "description": "A String", # Description of the Apigee organization. + "disableVpcPeering": True or False, # Optional. Flag that specifies whether the VPC Peering through Private Google Access should be disabled between the consumer network and Apigee. Valid only when RuntimeType is set to CLOUD. Required if an authorizedNetwork on the consumer project is not provided, in which case the flag should be set to true. The value must be set before the creation of any Apigee runtime instance and can be updated only when there are no runtime instances. **Note:** Apigee will be deprecating the vpc peering model that requires you to provide 'authorizedNetwork', by making the non-peering model as the default way of provisioning Apigee organization in future. So, this will be a temporary flag to enable the transition. Not supported for Apigee hybrid. "displayName": "A String", # Display name for the Apigee organization. Unused, but reserved for future use. "environments": [ # Output only. List of environments in the Apigee organization. "A String", @@ -796,6 +799,7 @@

Method Details

"createdAt": "A String", # Output only. Time that the Apigee organization was created in milliseconds since epoch. "customerName": "A String", # Not used by Apigee. "description": "A String", # Description of the Apigee organization. + "disableVpcPeering": True or False, # Optional. Flag that specifies whether the VPC Peering through Private Google Access should be disabled between the consumer network and Apigee. Valid only when RuntimeType is set to CLOUD. Required if an authorizedNetwork on the consumer project is not provided, in which case the flag should be set to true. The value must be set before the creation of any Apigee runtime instance and can be updated only when there are no runtime instances. **Note:** Apigee will be deprecating the vpc peering model that requires you to provide 'authorizedNetwork', by making the non-peering model as the default way of provisioning Apigee organization in future. So, this will be a temporary flag to enable the transition. Not supported for Apigee hybrid. "displayName": "A String", # Display name for the Apigee organization. Unused, but reserved for future use. "environments": [ # Output only. List of environments in the Apigee organization. "A String", diff --git a/docs/dyn/apigee_v1.projects.html b/docs/dyn/apigee_v1.projects.html index 0361d88a4aa..919dab13688 100644 --- a/docs/dyn/apigee_v1.projects.html +++ b/docs/dyn/apigee_v1.projects.html @@ -98,6 +98,7 @@

Method Details

{ # Request for ProvisionOrganization. "analyticsRegion": "A String", # Primary Cloud Platform region for analytics data storage. For valid values, see [Create an organization](https://cloud.google.com/apigee/docs/hybrid/latest/precog-provision). Defaults to `us-west1`. "authorizedNetwork": "A String", # Compute Engine network used for Service Networking to be peered with Apigee runtime instances. See [Getting started with the Service Networking API](https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started). Apigee also supports shared VPC (that is, the host network project is not the same as the one that is peering with Apigee). See [Shared VPC overview](https://cloud.google.com/vpc/docs/shared-vpc). To use a shared VPC network, use the following format: `projects/{host-project-id}/{region}/networks/{network-name}`. For example: `projects/my-sharedvpc-host/global/networks/mynetwork` + "disableVpcPeering": True or False, # Optional. Flag that specifies whether the VPC Peering through Private Google Access should be disabled between the consumer network and Apigee. Required if an authorizedNetwork on the consumer project is not provided, in which case the flag should be set to true. The value must be set before the creation of any Apigee runtime instance and can be updated only when there are no runtime instances. **Note:** Apigee will be deprecating the vpc peering model that requires you to provide 'authorizedNetwork', by making the non-peering model as the default way of provisioning Apigee organization in future. So, this will be a temporary flag to enable the transition. Not supported for Apigee hybrid. "runtimeLocation": "A String", # Cloud Platform location for the runtime instance. Defaults to zone `us-west1-a`. If a region is provided, `EVAL` organizations will use the region for automatically selecting a zone for the runtime instance. } diff --git a/docs/dyn/chat_v1.spaces.messages.html b/docs/dyn/chat_v1.spaces.messages.html index ee82d9e4133..a95fb806c54 100644 --- a/docs/dyn/chat_v1.spaces.messages.html +++ b/docs/dyn/chat_v1.spaces.messages.html @@ -2069,6 +2069,10 @@

Method Details

"url": "A String", # Output only. The URL that was matched. }, "name": "A String", # Resource name in the form `spaces/*/messages/*`. Example: `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB` + "quotedMessageMetadata": { # Information about a quoted message. # Output only. Information about a message that's quoted by a Google Chat user in a space. Google Chat users can quote a message to reply to it. + "lastUpdateTime": "A String", # Output only. The timestamp when the quoted message was created or when the quoted message was last updated. + "name": "A String", # Output only. Resource name of the quoted message. Format: `spaces/{space}/messages/{message}` + }, "sender": { # A user in Google Chat. # Output only. The user who created the message. If your Chat app [authenticates as a user](https://developers.google.com/chat/api/guides/auth/users), the output populates the [user](https://developers.google.com/chat/api/reference/rest/v1/User) `name` and `type`. "displayName": "A String", # Output only. The user's display name. "domainId": "A String", # Unique identifier of the user's Google Workspace domain. @@ -4064,6 +4068,10 @@

Method Details

"url": "A String", # Output only. The URL that was matched. }, "name": "A String", # Resource name in the form `spaces/*/messages/*`. Example: `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB` + "quotedMessageMetadata": { # Information about a quoted message. # Output only. Information about a message that's quoted by a Google Chat user in a space. Google Chat users can quote a message to reply to it. + "lastUpdateTime": "A String", # Output only. The timestamp when the quoted message was created or when the quoted message was last updated. + "name": "A String", # Output only. Resource name of the quoted message. Format: `spaces/{space}/messages/{message}` + }, "sender": { # A user in Google Chat. # Output only. The user who created the message. If your Chat app [authenticates as a user](https://developers.google.com/chat/api/guides/auth/users), the output populates the [user](https://developers.google.com/chat/api/reference/rest/v1/User) `name` and `type`. "displayName": "A String", # Output only. The user's display name. "domainId": "A String", # Unique identifier of the user's Google Workspace domain. @@ -6077,6 +6085,10 @@

Method Details

"url": "A String", # Output only. The URL that was matched. }, "name": "A String", # Resource name in the form `spaces/*/messages/*`. Example: `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB` + "quotedMessageMetadata": { # Information about a quoted message. # Output only. Information about a message that's quoted by a Google Chat user in a space. Google Chat users can quote a message to reply to it. + "lastUpdateTime": "A String", # Output only. The timestamp when the quoted message was created or when the quoted message was last updated. + "name": "A String", # Output only. Resource name of the quoted message. Format: `spaces/{space}/messages/{message}` + }, "sender": { # A user in Google Chat. # Output only. The user who created the message. If your Chat app [authenticates as a user](https://developers.google.com/chat/api/guides/auth/users), the output populates the [user](https://developers.google.com/chat/api/reference/rest/v1/User) `name` and `type`. "displayName": "A String", # Output only. The user's display name. "domainId": "A String", # Unique identifier of the user's Google Workspace domain. @@ -8078,6 +8090,10 @@

Method Details

"url": "A String", # Output only. The URL that was matched. }, "name": "A String", # Resource name in the form `spaces/*/messages/*`. Example: `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB` + "quotedMessageMetadata": { # Information about a quoted message. # Output only. Information about a message that's quoted by a Google Chat user in a space. Google Chat users can quote a message to reply to it. + "lastUpdateTime": "A String", # Output only. The timestamp when the quoted message was created or when the quoted message was last updated. + "name": "A String", # Output only. Resource name of the quoted message. Format: `spaces/{space}/messages/{message}` + }, "sender": { # A user in Google Chat. # Output only. The user who created the message. If your Chat app [authenticates as a user](https://developers.google.com/chat/api/guides/auth/users), the output populates the [user](https://developers.google.com/chat/api/reference/rest/v1/User) `name` and `type`. "displayName": "A String", # Output only. The user's display name. "domainId": "A String", # Unique identifier of the user's Google Workspace domain. @@ -10084,6 +10100,10 @@

Method Details

"url": "A String", # Output only. The URL that was matched. }, "name": "A String", # Resource name in the form `spaces/*/messages/*`. Example: `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB` + "quotedMessageMetadata": { # Information about a quoted message. # Output only. Information about a message that's quoted by a Google Chat user in a space. Google Chat users can quote a message to reply to it. + "lastUpdateTime": "A String", # Output only. The timestamp when the quoted message was created or when the quoted message was last updated. + "name": "A String", # Output only. Resource name of the quoted message. Format: `spaces/{space}/messages/{message}` + }, "sender": { # A user in Google Chat. # Output only. The user who created the message. If your Chat app [authenticates as a user](https://developers.google.com/chat/api/guides/auth/users), the output populates the [user](https://developers.google.com/chat/api/reference/rest/v1/User) `name` and `type`. "displayName": "A String", # Output only. The user's display name. "domainId": "A String", # Unique identifier of the user's Google Workspace domain. @@ -12073,6 +12093,10 @@

Method Details

"url": "A String", # Output only. The URL that was matched. }, "name": "A String", # Resource name in the form `spaces/*/messages/*`. Example: `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB` + "quotedMessageMetadata": { # Information about a quoted message. # Output only. Information about a message that's quoted by a Google Chat user in a space. Google Chat users can quote a message to reply to it. + "lastUpdateTime": "A String", # Output only. The timestamp when the quoted message was created or when the quoted message was last updated. + "name": "A String", # Output only. Resource name of the quoted message. Format: `spaces/{space}/messages/{message}` + }, "sender": { # A user in Google Chat. # Output only. The user who created the message. If your Chat app [authenticates as a user](https://developers.google.com/chat/api/guides/auth/users), the output populates the [user](https://developers.google.com/chat/api/reference/rest/v1/User) `name` and `type`. "displayName": "A String", # Output only. The user's display name. "domainId": "A String", # Unique identifier of the user's Google Workspace domain. @@ -14062,6 +14086,10 @@

Method Details

"url": "A String", # Output only. The URL that was matched. }, "name": "A String", # Resource name in the form `spaces/*/messages/*`. Example: `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB` + "quotedMessageMetadata": { # Information about a quoted message. # Output only. Information about a message that's quoted by a Google Chat user in a space. Google Chat users can quote a message to reply to it. + "lastUpdateTime": "A String", # Output only. The timestamp when the quoted message was created or when the quoted message was last updated. + "name": "A String", # Output only. Resource name of the quoted message. Format: `spaces/{space}/messages/{message}` + }, "sender": { # A user in Google Chat. # Output only. The user who created the message. If your Chat app [authenticates as a user](https://developers.google.com/chat/api/guides/auth/users), the output populates the [user](https://developers.google.com/chat/api/reference/rest/v1/User) `name` and `type`. "displayName": "A String", # Output only. The user's display name. "domainId": "A String", # Unique identifier of the user's Google Workspace domain. @@ -16051,6 +16079,10 @@

Method Details

"url": "A String", # Output only. The URL that was matched. }, "name": "A String", # Resource name in the form `spaces/*/messages/*`. Example: `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB` + "quotedMessageMetadata": { # Information about a quoted message. # Output only. Information about a message that's quoted by a Google Chat user in a space. Google Chat users can quote a message to reply to it. + "lastUpdateTime": "A String", # Output only. The timestamp when the quoted message was created or when the quoted message was last updated. + "name": "A String", # Output only. Resource name of the quoted message. Format: `spaces/{space}/messages/{message}` + }, "sender": { # A user in Google Chat. # Output only. The user who created the message. If your Chat app [authenticates as a user](https://developers.google.com/chat/api/guides/auth/users), the output populates the [user](https://developers.google.com/chat/api/reference/rest/v1/User) `name` and `type`. "displayName": "A String", # Output only. The user's display name. "domainId": "A String", # Unique identifier of the user's Google Workspace domain. diff --git a/docs/dyn/civicinfo_v2.elections.html b/docs/dyn/civicinfo_v2.elections.html index 97977e93c12..e92be2aa061 100644 --- a/docs/dyn/civicinfo_v2.elections.html +++ b/docs/dyn/civicinfo_v2.elections.html @@ -78,10 +78,10 @@

Instance Methods

close()

Close httplib2 connections.

- electionQuery(productionDataOnly=None, x__xgafv=None)

+ electionQuery(x__xgafv=None)

List of available elections to query.

- voterInfoQuery(address, electionId=None, officialOnly=None, productionDataOnly=None, returnAllAvailableData=None, x__xgafv=None)

+ voterInfoQuery(address, electionId=None, officialOnly=None, returnAllAvailableData=None, x__xgafv=None)

Looks up information relevant to a voter based on the voter's registered address.

Method Details

@@ -90,11 +90,10 @@

Method Details

- electionQuery(productionDataOnly=None, x__xgafv=None) + electionQuery(x__xgafv=None)
List of available elections to query.
 
 Args:
-  productionDataOnly: boolean, Whether to include data that has not been allowlisted yet
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -118,14 +117,13 @@ 

Method Details

- voterInfoQuery(address, electionId=None, officialOnly=None, productionDataOnly=None, returnAllAvailableData=None, x__xgafv=None) + voterInfoQuery(address, electionId=None, officialOnly=None, returnAllAvailableData=None, x__xgafv=None)
Looks up information relevant to a voter based on the voter's registered address.
 
 Args:
   address: string, The registered address of the voter to look up. (required)
   electionId: string, The unique ID of the election to look up. A list of election IDs can be obtained at https://www.googleapis.com/civicinfo/{version}/elections. If no election ID is specified in the query and there is more than one election with data for the given voter, the additional elections are provided in the otherElections response field.
   officialOnly: boolean, If set to true, only data from official state sources will be returned.
-  productionDataOnly: boolean, Whether to include data that has not been vetted yet. Should only be made available to internal IPs or trusted partners. This is a non-discoverable parameter in the One Platform API config.
   returnAllAvailableData: boolean, If set to true, the query will return the success code and include any partial information when it is unable to determine a matching address or unable to determine the election for electionId=0 queries.
   x__xgafv: string, V1 error format.
     Allowed values
@@ -306,7 +304,7 @@ 

Method Details

}, ], "precinctId": "A String", - "precincts": [ # The precincts that match this voter's address. Will only be returned for project IDs which have been allowlisted as "partner projects". + "precincts": [ # The precincts that match this voter's address. Will only be returned for project IDs which have been whitelisted as "partner projects". { "administrationRegionId": "A String", # ID of the AdministrationRegion message for this precinct. Corresponds to LocalityId xml tag. "contestId": [ # ID(s) of the Contest message(s) for this precinct. diff --git a/docs/dyn/cloudchannel_v1.accounts.customers.entitlements.html b/docs/dyn/cloudchannel_v1.accounts.customers.entitlements.html index a1b92609875..3df7fb1802e 100644 --- a/docs/dyn/cloudchannel_v1.accounts.customers.entitlements.html +++ b/docs/dyn/cloudchannel_v1.accounts.customers.entitlements.html @@ -426,7 +426,7 @@

Method Details

], "provisionedService": { # Service provisioned for an entitlement. # Output only. Service provisioning details for the entitlement. "productId": "A String", # Output only. The product pertaining to the provisioning resource as specified in the Offer. - "provisioningId": "A String", # Output only. Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud, this is the Billing Account ID of the billing subaccount." + "provisioningId": "A String", # Output only. Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud, this is the Billing Account ID of the billing subaccount. "skuId": "A String", # Output only. The SKU pertaining to the provisioning resource as specified in the Offer. }, "provisioningState": "A String", # Output only. Current provisioning state of the entitlement. @@ -524,7 +524,7 @@

Method Details

], "provisionedService": { # Service provisioned for an entitlement. # Output only. Service provisioning details for the entitlement. "productId": "A String", # Output only. The product pertaining to the provisioning resource as specified in the Offer. - "provisioningId": "A String", # Output only. Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud, this is the Billing Account ID of the billing subaccount." + "provisioningId": "A String", # Output only. Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud, this is the Billing Account ID of the billing subaccount. "skuId": "A String", # Output only. The SKU pertaining to the provisioning resource as specified in the Offer. }, "provisioningState": "A String", # Output only. Current provisioning state of the entitlement. @@ -596,7 +596,7 @@

Method Details

], "provisionedService": { # Service provisioned for an entitlement. # Output only. Service provisioning details for the entitlement. "productId": "A String", # Output only. The product pertaining to the provisioning resource as specified in the Offer. - "provisioningId": "A String", # Output only. Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud, this is the Billing Account ID of the billing subaccount." + "provisioningId": "A String", # Output only. Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud, this is the Billing Account ID of the billing subaccount. "skuId": "A String", # Output only. The SKU pertaining to the provisioning resource as specified in the Offer. }, "provisioningState": "A String", # Output only. Current provisioning state of the entitlement. @@ -661,7 +661,7 @@

Method Details

], "provisionedService": { # Service provisioned for an entitlement. # Service provisioned for an Entitlement. "productId": "A String", # Output only. The product pertaining to the provisioning resource as specified in the Offer. - "provisioningId": "A String", # Output only. Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud, this is the Billing Account ID of the billing subaccount." + "provisioningId": "A String", # Output only. Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud, this is the Billing Account ID of the billing subaccount. "skuId": "A String", # Output only. The SKU pertaining to the provisioning resource as specified in the Offer. }, "suspensionReason": "A String", # Suspension reason for the Entitlement. diff --git a/docs/dyn/cloudchannel_v1.accounts.customers.html b/docs/dyn/cloudchannel_v1.accounts.customers.html index 8504e41db08..96eff37ccdb 100644 --- a/docs/dyn/cloudchannel_v1.accounts.customers.html +++ b/docs/dyn/cloudchannel_v1.accounts.customers.html @@ -1061,7 +1061,7 @@

Method Details

], "provisionedService": { # Service provisioned for an entitlement. # Output only. Service provisioning details for the entitlement. "productId": "A String", # Output only. The product pertaining to the provisioning resource as specified in the Offer. - "provisioningId": "A String", # Output only. Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud, this is the Billing Account ID of the billing subaccount." + "provisioningId": "A String", # Output only. Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud, this is the Billing Account ID of the billing subaccount. "skuId": "A String", # Output only. The SKU pertaining to the provisioning resource as specified in the Offer. }, "provisioningState": "A String", # Output only. Current provisioning state of the entitlement. @@ -1157,7 +1157,7 @@

Method Details

], "provisionedService": { # Service provisioned for an entitlement. # Output only. Service provisioning details for the entitlement. "productId": "A String", # Output only. The product pertaining to the provisioning resource as specified in the Offer. - "provisioningId": "A String", # Output only. Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud, this is the Billing Account ID of the billing subaccount." + "provisioningId": "A String", # Output only. Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud, this is the Billing Account ID of the billing subaccount. "skuId": "A String", # Output only. The SKU pertaining to the provisioning resource as specified in the Offer. }, "provisioningState": "A String", # Output only. Current provisioning state of the entitlement. diff --git a/docs/dyn/cloudidentity_v1.devices.html b/docs/dyn/cloudidentity_v1.devices.html index 6d9ebe2b2b4..a757b2f3073 100644 --- a/docs/dyn/cloudidentity_v1.devices.html +++ b/docs/dyn/cloudidentity_v1.devices.html @@ -182,6 +182,7 @@

Method Details

"enabledDeveloperOptions": True or False, # Output only. Whether developer options is enabled on device. "enabledUsbDebugging": True or False, # Output only. Whether USB debugging is enabled on device. "encryptionState": "A String", # Output only. Device encryption state. + "hostname": "A String", # Host name of the device. "imei": "A String", # Output only. IMEI number of device if GSM device; empty otherwise. "kernelVersion": "A String", # Output only. Kernel version of the device. "lastSyncTime": "A String", # Most recent time when device synced with this service. @@ -308,6 +309,7 @@

Method Details

"enabledDeveloperOptions": True or False, # Output only. Whether developer options is enabled on device. "enabledUsbDebugging": True or False, # Output only. Whether USB debugging is enabled on device. "encryptionState": "A String", # Output only. Device encryption state. + "hostname": "A String", # Host name of the device. "imei": "A String", # Output only. IMEI number of device if GSM device; empty otherwise. "kernelVersion": "A String", # Output only. Kernel version of the device. "lastSyncTime": "A String", # Most recent time when device synced with this service. @@ -379,6 +381,7 @@

Method Details

"enabledDeveloperOptions": True or False, # Output only. Whether developer options is enabled on device. "enabledUsbDebugging": True or False, # Output only. Whether USB debugging is enabled on device. "encryptionState": "A String", # Output only. Device encryption state. + "hostname": "A String", # Host name of the device. "imei": "A String", # Output only. IMEI number of device if GSM device; empty otherwise. "kernelVersion": "A String", # Output only. Kernel version of the device. "lastSyncTime": "A String", # Most recent time when device synced with this service. diff --git a/docs/dyn/cloudresourcemanager_v3.tagValues.html b/docs/dyn/cloudresourcemanager_v3.tagValues.html index 3a0e4ad425f..f19056316a1 100644 --- a/docs/dyn/cloudresourcemanager_v3.tagValues.html +++ b/docs/dyn/cloudresourcemanager_v3.tagValues.html @@ -319,7 +319,7 @@

Method Details

Args: pageSize: integer, Optional. The maximum number of TagValues to return in the response. The server allows a maximum of 300 TagValues to return. If unspecified, the server will use 100 as the default. pageToken: string, Optional. A pagination token returned from a previous call to `ListTagValues` that indicates where this listing should continue from. - parent: string, Required. + parent: string, Required. Resource name for the parent of the TagValues to be listed, in the format `tagKeys/123` or `tagValues/123`. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/cloudsearch_v1.query.html b/docs/dyn/cloudsearch_v1.query.html index 5a2d6ae2673..c9187579122 100644 --- a/docs/dyn/cloudsearch_v1.query.html +++ b/docs/dyn/cloudsearch_v1.query.html @@ -84,7 +84,7 @@

Instance Methods

Close httplib2 connections.

removeActivity(body=None, x__xgafv=None)

-

Provides functionality to remove logged activity for a user. Currently to be used only for dynamite 1p clients **Note:** This API requires a standard end user account to execute. A service account can't perform Remove Activity requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/).

+

Provides functionality to remove logged activity for a user. Currently to be used only for Chat 1p clients **Note:** This API requires a standard end user account to execute. A service account can't perform Remove Activity requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/).

search(body=None, x__xgafv=None)

The Cloud Search Query API provides the search method, which returns the most relevant results from a user query. The results can come from Google Workspace apps, such as Gmail or Google Drive, or they can come from data that you have indexed from a third party. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/).

@@ -99,7 +99,7 @@

Method Details

removeActivity(body=None, x__xgafv=None) -
Provides functionality to remove logged activity for a user. Currently to be used only for dynamite 1p clients **Note:** This API requires a standard end user account to execute. A service account can't perform Remove Activity requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/).
+  
Provides functionality to remove logged activity for a user. Currently to be used only for Chat 1p clients **Note:** This API requires a standard end user account to execute. A service account can't perform Remove Activity requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/).
 
 Args:
   body: object, The request body.
@@ -110,7 +110,7 @@ 

Method Details

"debugOptions": { # Shared request debug options for all cloudsearch RPC methods. # Debug options of the request "enableDebugging": True or False, # If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. }, - "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For translations. Set this field using the language set in browser or for the page. In the event that the user's language preference is known, set this field to the known user language. When specified, the documents in search results are biased towards the specified language. From Suggest API perspective, for 3p suggest this is used as a hint while making predictions to add language boosting. + "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For translations. Set this field using the language set in browser or for the page. In the event that the user's language preference is known, set this field to the known user language. When specified, the documents in search results are biased towards the specified language. The Suggest API uses this field as a hint to make better third-party autocomplete predictions. "searchApplicationId": "A String", # The ID generated when you create a search application using the [admin console](https://support.google.com/a/answer/9043922). "timeZone": "A String", # Current user's time zone id, such as "America/Los_Angeles" or "Australia/Sydney". These IDs are defined by [Unicode Common Locale Data Repository (CLDR)](http://cldr.unicode.org/) project, and currently available in the file [timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml). This field is used to correctly interpret date and time queries. If this field is not specified, the default time zone (UTC) is used. }, @@ -210,7 +210,7 @@

Method Details

"debugOptions": { # Shared request debug options for all cloudsearch RPC methods. # Debug options of the request "enableDebugging": True or False, # If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. }, - "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For translations. Set this field using the language set in browser or for the page. In the event that the user's language preference is known, set this field to the known user language. When specified, the documents in search results are biased towards the specified language. From Suggest API perspective, for 3p suggest this is used as a hint while making predictions to add language boosting. + "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For translations. Set this field using the language set in browser or for the page. In the event that the user's language preference is known, set this field to the known user language. When specified, the documents in search results are biased towards the specified language. The Suggest API uses this field as a hint to make better third-party autocomplete predictions. "searchApplicationId": "A String", # The ID generated when you create a search application using the [admin console](https://support.google.com/a/answer/9043922). "timeZone": "A String", # Current user's time zone id, such as "America/Los_Angeles" or "Australia/Sydney". These IDs are defined by [Unicode Common Locale Data Repository (CLDR)](http://cldr.unicode.org/) project, and currently available in the file [timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml). This field is used to correctly interpret date and time queries. If this field is not specified, the default time zone (UTC) is used. }, @@ -580,7 +580,7 @@

Method Details

"debugOptions": { # Shared request debug options for all cloudsearch RPC methods. # Debug options of the request "enableDebugging": True or False, # If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. }, - "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For translations. Set this field using the language set in browser or for the page. In the event that the user's language preference is known, set this field to the known user language. When specified, the documents in search results are biased towards the specified language. From Suggest API perspective, for 3p suggest this is used as a hint while making predictions to add language boosting. + "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For translations. Set this field using the language set in browser or for the page. In the event that the user's language preference is known, set this field to the known user language. When specified, the documents in search results are biased towards the specified language. The Suggest API uses this field as a hint to make better third-party autocomplete predictions. "searchApplicationId": "A String", # The ID generated when you create a search application using the [admin console](https://support.google.com/a/answer/9043922). "timeZone": "A String", # Current user's time zone id, such as "America/Los_Angeles" or "Australia/Sydney". These IDs are defined by [Unicode Common Locale Data Repository (CLDR)](http://cldr.unicode.org/) project, and currently available in the file [timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml). This field is used to correctly interpret date and time queries. If this field is not specified, the default time zone (UTC) is used. }, diff --git a/docs/dyn/cloudsearch_v1.query.sources.html b/docs/dyn/cloudsearch_v1.query.sources.html index 93184767c04..2923cd48207 100644 --- a/docs/dyn/cloudsearch_v1.query.sources.html +++ b/docs/dyn/cloudsearch_v1.query.sources.html @@ -96,7 +96,7 @@

Method Details

Args: pageToken: string, Number of sources to return in the response. requestOptions_debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. - requestOptions_languageCode: string, The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For translations. Set this field using the language set in browser or for the page. In the event that the user's language preference is known, set this field to the known user language. When specified, the documents in search results are biased towards the specified language. From Suggest API perspective, for 3p suggest this is used as a hint while making predictions to add language boosting. + requestOptions_languageCode: string, The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For translations. Set this field using the language set in browser or for the page. In the event that the user's language preference is known, set this field to the known user language. When specified, the documents in search results are biased towards the specified language. The Suggest API uses this field as a hint to make better third-party autocomplete predictions. requestOptions_searchApplicationId: string, The ID generated when you create a search application using the [admin console](https://support.google.com/a/answer/9043922). requestOptions_timeZone: string, Current user's time zone id, such as "America/Los_Angeles" or "Australia/Sydney". These IDs are defined by [Unicode Common Locale Data Repository (CLDR)](http://cldr.unicode.org/) project, and currently available in the file [timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml). This field is used to correctly interpret date and time queries. If this field is not specified, the default time zone (UTC) is used. x__xgafv: string, V1 error format. diff --git a/docs/dyn/compute_beta.backendServices.html b/docs/dyn/compute_beta.backendServices.html index 2b2820c56be..dab5d90ea20 100644 --- a/docs/dyn/compute_beta.backendServices.html +++ b/docs/dyn/compute_beta.backendServices.html @@ -417,24 +417,24 @@

Method Details

}, "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL. - "outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. If not set, this feature is considered disabled. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, HTTP2, or GRPC, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. - "baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s. + "outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service. If not set, this feature is considered disabled. Results of the outlier detection algorithm (ejection of endpoints from the load balancing pool and returning them back to the pool) are executed independently by each proxy instance of the load balancer. In most cases, more than one proxy instance handles the traffic received by a backend service. Thus, it is possible that an unhealthy endpoint is detected and ejected by only some of the proxies, and while this happens, other proxies may continue to send requests to the same unhealthy endpoint until they detect and eject the unhealthy endpoint. Applicable backend endpoints can be: - VM instances in an Instance Group - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT) - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT) - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud Functions Services - Private Service Connect NEGs, that resolve to Google-managed regional API endpoints or managed services published using Private Service Connect Applicable backend service types can be: - A global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. - A regional backend service with the serviceProtocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not supported for Serverless NEGs. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. + "baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a backend endpoint is ejected for. Defaults to 30000ms or 30s. After a backend endpoint is returned back to the load balancing pool, it can be ejected again in another ejection analysis. Thus, the total ejection time is equal to the base ejection time multiplied by the number of times the backend endpoint has been ejected. Defaults to 30000ms or 30s. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "consecutiveErrors": 42, # Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingConsecutiveErrors": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingSuccessRate": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. - "interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second. + "consecutiveErrors": 42, # Number of consecutive errors before a backend endpoint is ejected from the load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. + "consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. + "enforcingConsecutiveErrors": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. + "enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. + "enforcingSuccessRate": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service uses Serverless NEG. + "interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections and backend endpoints being returned to service. The interval is equal to the number of seconds as defined in outlierDetection.interval.seconds plus the number of nanoseconds as defined in outlierDetection.interval.nanos. Defaults to 1 second. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxEjectionPercent": 42, # Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%. - "successRateMinimumHosts": 42, # The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5. - "successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100. - "successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. + "maxEjectionPercent": 42, # Maximum percentage of backend endpoints in the load balancing pool for the backend service that can be ejected if the ejection conditions are met. Defaults to 50%. + "successRateMinimumHosts": 42, # The number of backend endpoints in the load balancing pool that must have enough request volume to detect success rate outliers. If the number of backend endpoints is fewer than this setting, outlier detection via success rate statistics is not performed for any backend endpoint in the load balancing pool. Defaults to 5. Not supported when the backend service uses Serverless NEG. + "successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this backend endpoint in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that backend endpoint. Defaults to 100. Not supported when the backend service uses Serverless NEG. + "successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * successRateStdevFactor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. Not supported when the backend service uses Serverless NEG. }, "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port. "portName": "A String", # A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be [defined on each backend instance group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports). This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name. @@ -893,24 +893,24 @@

Method Details

}, "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL. - "outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. If not set, this feature is considered disabled. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, HTTP2, or GRPC, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. - "baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s. + "outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service. If not set, this feature is considered disabled. Results of the outlier detection algorithm (ejection of endpoints from the load balancing pool and returning them back to the pool) are executed independently by each proxy instance of the load balancer. In most cases, more than one proxy instance handles the traffic received by a backend service. Thus, it is possible that an unhealthy endpoint is detected and ejected by only some of the proxies, and while this happens, other proxies may continue to send requests to the same unhealthy endpoint until they detect and eject the unhealthy endpoint. Applicable backend endpoints can be: - VM instances in an Instance Group - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT) - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT) - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud Functions Services - Private Service Connect NEGs, that resolve to Google-managed regional API endpoints or managed services published using Private Service Connect Applicable backend service types can be: - A global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. - A regional backend service with the serviceProtocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not supported for Serverless NEGs. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. + "baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a backend endpoint is ejected for. Defaults to 30000ms or 30s. After a backend endpoint is returned back to the load balancing pool, it can be ejected again in another ejection analysis. Thus, the total ejection time is equal to the base ejection time multiplied by the number of times the backend endpoint has been ejected. Defaults to 30000ms or 30s. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "consecutiveErrors": 42, # Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingConsecutiveErrors": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingSuccessRate": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. - "interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second. + "consecutiveErrors": 42, # Number of consecutive errors before a backend endpoint is ejected from the load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. + "consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. + "enforcingConsecutiveErrors": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. + "enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. + "enforcingSuccessRate": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service uses Serverless NEG. + "interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections and backend endpoints being returned to service. The interval is equal to the number of seconds as defined in outlierDetection.interval.seconds plus the number of nanoseconds as defined in outlierDetection.interval.nanos. Defaults to 1 second. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxEjectionPercent": 42, # Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%. - "successRateMinimumHosts": 42, # The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5. - "successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100. - "successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. + "maxEjectionPercent": 42, # Maximum percentage of backend endpoints in the load balancing pool for the backend service that can be ejected if the ejection conditions are met. Defaults to 50%. + "successRateMinimumHosts": 42, # The number of backend endpoints in the load balancing pool that must have enough request volume to detect success rate outliers. If the number of backend endpoints is fewer than this setting, outlier detection via success rate statistics is not performed for any backend endpoint in the load balancing pool. Defaults to 5. Not supported when the backend service uses Serverless NEG. + "successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this backend endpoint in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that backend endpoint. Defaults to 100. Not supported when the backend service uses Serverless NEG. + "successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * successRateStdevFactor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. Not supported when the backend service uses Serverless NEG. }, "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port. "portName": "A String", # A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be [defined on each backend instance group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports). This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name. @@ -1251,24 +1251,24 @@

Method Details

}, "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL. - "outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. If not set, this feature is considered disabled. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, HTTP2, or GRPC, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. - "baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s. + "outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service. If not set, this feature is considered disabled. Results of the outlier detection algorithm (ejection of endpoints from the load balancing pool and returning them back to the pool) are executed independently by each proxy instance of the load balancer. In most cases, more than one proxy instance handles the traffic received by a backend service. Thus, it is possible that an unhealthy endpoint is detected and ejected by only some of the proxies, and while this happens, other proxies may continue to send requests to the same unhealthy endpoint until they detect and eject the unhealthy endpoint. Applicable backend endpoints can be: - VM instances in an Instance Group - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT) - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT) - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud Functions Services - Private Service Connect NEGs, that resolve to Google-managed regional API endpoints or managed services published using Private Service Connect Applicable backend service types can be: - A global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. - A regional backend service with the serviceProtocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not supported for Serverless NEGs. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. + "baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a backend endpoint is ejected for. Defaults to 30000ms or 30s. After a backend endpoint is returned back to the load balancing pool, it can be ejected again in another ejection analysis. Thus, the total ejection time is equal to the base ejection time multiplied by the number of times the backend endpoint has been ejected. Defaults to 30000ms or 30s. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "consecutiveErrors": 42, # Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingConsecutiveErrors": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingSuccessRate": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. - "interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second. + "consecutiveErrors": 42, # Number of consecutive errors before a backend endpoint is ejected from the load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. + "consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. + "enforcingConsecutiveErrors": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. + "enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. + "enforcingSuccessRate": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service uses Serverless NEG. + "interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections and backend endpoints being returned to service. The interval is equal to the number of seconds as defined in outlierDetection.interval.seconds plus the number of nanoseconds as defined in outlierDetection.interval.nanos. Defaults to 1 second. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxEjectionPercent": 42, # Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%. - "successRateMinimumHosts": 42, # The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5. - "successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100. - "successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. + "maxEjectionPercent": 42, # Maximum percentage of backend endpoints in the load balancing pool for the backend service that can be ejected if the ejection conditions are met. Defaults to 50%. + "successRateMinimumHosts": 42, # The number of backend endpoints in the load balancing pool that must have enough request volume to detect success rate outliers. If the number of backend endpoints is fewer than this setting, outlier detection via success rate statistics is not performed for any backend endpoint in the load balancing pool. Defaults to 5. Not supported when the backend service uses Serverless NEG. + "successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this backend endpoint in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that backend endpoint. Defaults to 100. Not supported when the backend service uses Serverless NEG. + "successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * successRateStdevFactor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. Not supported when the backend service uses Serverless NEG. }, "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port. "portName": "A String", # A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be [defined on each backend instance group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports). This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name. @@ -1571,24 +1571,24 @@

Method Details

}, "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL. - "outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. If not set, this feature is considered disabled. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, HTTP2, or GRPC, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. - "baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s. + "outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service. If not set, this feature is considered disabled. Results of the outlier detection algorithm (ejection of endpoints from the load balancing pool and returning them back to the pool) are executed independently by each proxy instance of the load balancer. In most cases, more than one proxy instance handles the traffic received by a backend service. Thus, it is possible that an unhealthy endpoint is detected and ejected by only some of the proxies, and while this happens, other proxies may continue to send requests to the same unhealthy endpoint until they detect and eject the unhealthy endpoint. Applicable backend endpoints can be: - VM instances in an Instance Group - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT) - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT) - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud Functions Services - Private Service Connect NEGs, that resolve to Google-managed regional API endpoints or managed services published using Private Service Connect Applicable backend service types can be: - A global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. - A regional backend service with the serviceProtocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not supported for Serverless NEGs. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. + "baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a backend endpoint is ejected for. Defaults to 30000ms or 30s. After a backend endpoint is returned back to the load balancing pool, it can be ejected again in another ejection analysis. Thus, the total ejection time is equal to the base ejection time multiplied by the number of times the backend endpoint has been ejected. Defaults to 30000ms or 30s. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "consecutiveErrors": 42, # Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingConsecutiveErrors": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingSuccessRate": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. - "interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second. + "consecutiveErrors": 42, # Number of consecutive errors before a backend endpoint is ejected from the load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. + "consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. + "enforcingConsecutiveErrors": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. + "enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. + "enforcingSuccessRate": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service uses Serverless NEG. + "interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections and backend endpoints being returned to service. The interval is equal to the number of seconds as defined in outlierDetection.interval.seconds plus the number of nanoseconds as defined in outlierDetection.interval.nanos. Defaults to 1 second. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxEjectionPercent": 42, # Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%. - "successRateMinimumHosts": 42, # The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5. - "successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100. - "successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. + "maxEjectionPercent": 42, # Maximum percentage of backend endpoints in the load balancing pool for the backend service that can be ejected if the ejection conditions are met. Defaults to 50%. + "successRateMinimumHosts": 42, # The number of backend endpoints in the load balancing pool that must have enough request volume to detect success rate outliers. If the number of backend endpoints is fewer than this setting, outlier detection via success rate statistics is not performed for any backend endpoint in the load balancing pool. Defaults to 5. Not supported when the backend service uses Serverless NEG. + "successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this backend endpoint in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that backend endpoint. Defaults to 100. Not supported when the backend service uses Serverless NEG. + "successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * successRateStdevFactor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. Not supported when the backend service uses Serverless NEG. }, "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port. "portName": "A String", # A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be [defined on each backend instance group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports). This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name. @@ -1811,24 +1811,24 @@

Method Details

}, "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL. - "outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. If not set, this feature is considered disabled. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, HTTP2, or GRPC, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. - "baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s. + "outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service. If not set, this feature is considered disabled. Results of the outlier detection algorithm (ejection of endpoints from the load balancing pool and returning them back to the pool) are executed independently by each proxy instance of the load balancer. In most cases, more than one proxy instance handles the traffic received by a backend service. Thus, it is possible that an unhealthy endpoint is detected and ejected by only some of the proxies, and while this happens, other proxies may continue to send requests to the same unhealthy endpoint until they detect and eject the unhealthy endpoint. Applicable backend endpoints can be: - VM instances in an Instance Group - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT) - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT) - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud Functions Services - Private Service Connect NEGs, that resolve to Google-managed regional API endpoints or managed services published using Private Service Connect Applicable backend service types can be: - A global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. - A regional backend service with the serviceProtocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not supported for Serverless NEGs. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. + "baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a backend endpoint is ejected for. Defaults to 30000ms or 30s. After a backend endpoint is returned back to the load balancing pool, it can be ejected again in another ejection analysis. Thus, the total ejection time is equal to the base ejection time multiplied by the number of times the backend endpoint has been ejected. Defaults to 30000ms or 30s. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "consecutiveErrors": 42, # Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingConsecutiveErrors": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingSuccessRate": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. - "interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second. + "consecutiveErrors": 42, # Number of consecutive errors before a backend endpoint is ejected from the load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. + "consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. + "enforcingConsecutiveErrors": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. + "enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. + "enforcingSuccessRate": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service uses Serverless NEG. + "interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections and backend endpoints being returned to service. The interval is equal to the number of seconds as defined in outlierDetection.interval.seconds plus the number of nanoseconds as defined in outlierDetection.interval.nanos. Defaults to 1 second. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxEjectionPercent": 42, # Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%. - "successRateMinimumHosts": 42, # The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5. - "successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100. - "successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. + "maxEjectionPercent": 42, # Maximum percentage of backend endpoints in the load balancing pool for the backend service that can be ejected if the ejection conditions are met. Defaults to 50%. + "successRateMinimumHosts": 42, # The number of backend endpoints in the load balancing pool that must have enough request volume to detect success rate outliers. If the number of backend endpoints is fewer than this setting, outlier detection via success rate statistics is not performed for any backend endpoint in the load balancing pool. Defaults to 5. Not supported when the backend service uses Serverless NEG. + "successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this backend endpoint in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that backend endpoint. Defaults to 100. Not supported when the backend service uses Serverless NEG. + "successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * successRateStdevFactor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. Not supported when the backend service uses Serverless NEG. }, "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port. "portName": "A String", # A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be [defined on each backend instance group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports). This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name. @@ -2583,24 +2583,24 @@

Method Details

}, "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL. - "outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. If not set, this feature is considered disabled. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, HTTP2, or GRPC, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. - "baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s. + "outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service. If not set, this feature is considered disabled. Results of the outlier detection algorithm (ejection of endpoints from the load balancing pool and returning them back to the pool) are executed independently by each proxy instance of the load balancer. In most cases, more than one proxy instance handles the traffic received by a backend service. Thus, it is possible that an unhealthy endpoint is detected and ejected by only some of the proxies, and while this happens, other proxies may continue to send requests to the same unhealthy endpoint until they detect and eject the unhealthy endpoint. Applicable backend endpoints can be: - VM instances in an Instance Group - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT) - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT) - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud Functions Services - Private Service Connect NEGs, that resolve to Google-managed regional API endpoints or managed services published using Private Service Connect Applicable backend service types can be: - A global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. - A regional backend service with the serviceProtocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not supported for Serverless NEGs. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. + "baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a backend endpoint is ejected for. Defaults to 30000ms or 30s. After a backend endpoint is returned back to the load balancing pool, it can be ejected again in another ejection analysis. Thus, the total ejection time is equal to the base ejection time multiplied by the number of times the backend endpoint has been ejected. Defaults to 30000ms or 30s. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "consecutiveErrors": 42, # Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingConsecutiveErrors": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingSuccessRate": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. - "interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second. + "consecutiveErrors": 42, # Number of consecutive errors before a backend endpoint is ejected from the load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. + "consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. + "enforcingConsecutiveErrors": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. + "enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. + "enforcingSuccessRate": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service uses Serverless NEG. + "interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections and backend endpoints being returned to service. The interval is equal to the number of seconds as defined in outlierDetection.interval.seconds plus the number of nanoseconds as defined in outlierDetection.interval.nanos. Defaults to 1 second. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxEjectionPercent": 42, # Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%. - "successRateMinimumHosts": 42, # The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5. - "successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100. - "successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. + "maxEjectionPercent": 42, # Maximum percentage of backend endpoints in the load balancing pool for the backend service that can be ejected if the ejection conditions are met. Defaults to 50%. + "successRateMinimumHosts": 42, # The number of backend endpoints in the load balancing pool that must have enough request volume to detect success rate outliers. If the number of backend endpoints is fewer than this setting, outlier detection via success rate statistics is not performed for any backend endpoint in the load balancing pool. Defaults to 5. Not supported when the backend service uses Serverless NEG. + "successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this backend endpoint in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that backend endpoint. Defaults to 100. Not supported when the backend service uses Serverless NEG. + "successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * successRateStdevFactor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. Not supported when the backend service uses Serverless NEG. }, "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port. "portName": "A String", # A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be [defined on each backend instance group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports). This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name. diff --git a/docs/dyn/compute_beta.disks.html b/docs/dyn/compute_beta.disks.html index ee7c5e8cb8f..977686a3e72 100644 --- a/docs/dyn/compute_beta.disks.html +++ b/docs/dyn/compute_beta.disks.html @@ -305,6 +305,7 @@

Method Details

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. }, + "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "eraseWindowsVssSignature": True or False, # Specifies whether the disk restored from a source snapshot should erase Windows specific VSS signature. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. { # Guest OS features. @@ -578,6 +579,7 @@

Method Details

"description": "A String", # An optional description of this resource. Provide this property when you create the resource. "diskSizeGb": "A String", # [Output Only] Size of the source disk, specified in GB. "downloadBytes": "A String", # [Output Only] Number of bytes downloaded to restore a snapshot to a disk. + "enableConfidentialCompute": True or False, # Whether this snapshot is created from a confidential compute mode disk. [Output Only]: This field is not set by user, but from source disk. "guestFlush": True or False, # [Input Only] Whether to attempt an application consistent snapshot by informing the OS to prepare for the snapshot process. "guestOsFeatures": [ # [Output Only] A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. { # Guest OS features. @@ -887,6 +889,7 @@

Method Details

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. }, + "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "eraseWindowsVssSignature": True or False, # Specifies whether the disk restored from a source snapshot should erase Windows specific VSS signature. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. { # Guest OS features. @@ -1120,6 +1123,7 @@

Method Details

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. }, + "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "eraseWindowsVssSignature": True or False, # Specifies whether the disk restored from a source snapshot should erase Windows specific VSS signature. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. { # Guest OS features. @@ -1360,6 +1364,7 @@

Method Details

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. }, + "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "eraseWindowsVssSignature": True or False, # Specifies whether the disk restored from a source snapshot should erase Windows specific VSS signature. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. { # Guest OS features. @@ -2436,6 +2441,7 @@

Method Details

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. }, + "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "eraseWindowsVssSignature": True or False, # Specifies whether the disk restored from a source snapshot should erase Windows specific VSS signature. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. { # Guest OS features. diff --git a/docs/dyn/compute_beta.html b/docs/dyn/compute_beta.html index 486dd482fe8..b2c682bd13a 100644 --- a/docs/dyn/compute_beta.html +++ b/docs/dyn/compute_beta.html @@ -184,6 +184,11 @@

Instance Methods

Returns the images Resource.

+

+ instanceGroupManagerResizeRequests() +

+

Returns the instanceGroupManagerResizeRequests Resource.

+

instanceGroupManagers()

diff --git a/docs/dyn/compute_beta.imageFamilyViews.html b/docs/dyn/compute_beta.imageFamilyViews.html index e2f7cad6edd..899ba9cbb40 100644 --- a/docs/dyn/compute_beta.imageFamilyViews.html +++ b/docs/dyn/compute_beta.imageFamilyViews.html @@ -122,6 +122,7 @@

Method Details

}, "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB). + "enableConfidentialCompute": True or False, # Whether this image is created from a confidential compute mode disk. [Output Only]: This field is not set by user, but from source disk. "family": "A String", # The name of the image family to which this image belongs. The image family name can be from a publicly managed image family provided by Compute Engine, or from a custom image family you create. For example, centos-stream-9 is a publicly available image family. For more information, see Image family best practices. When creating disks, you can specify an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. To see a list of available options, see the guestOSfeatures[].type parameter. { # Guest OS features. diff --git a/docs/dyn/compute_beta.images.html b/docs/dyn/compute_beta.images.html index d25fb42e052..640d66d1f6a 100644 --- a/docs/dyn/compute_beta.images.html +++ b/docs/dyn/compute_beta.images.html @@ -380,6 +380,7 @@

Method Details

}, "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB). + "enableConfidentialCompute": True or False, # Whether this image is created from a confidential compute mode disk. [Output Only]: This field is not set by user, but from source disk. "family": "A String", # The name of the image family to which this image belongs. The image family name can be from a publicly managed image family provided by Compute Engine, or from a custom image family you create. For example, centos-stream-9 is a publicly available image family. For more information, see Image family best practices. When creating disks, you can specify an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. To see a list of available options, see the guestOSfeatures[].type parameter. { # Guest OS features. @@ -516,6 +517,7 @@

Method Details

}, "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB). + "enableConfidentialCompute": True or False, # Whether this image is created from a confidential compute mode disk. [Output Only]: This field is not set by user, but from source disk. "family": "A String", # The name of the image family to which this image belongs. The image family name can be from a publicly managed image family provided by Compute Engine, or from a custom image family you create. For example, centos-stream-9 is a publicly available image family. For more information, see Image family best practices. When creating disks, you can specify an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. To see a list of available options, see the guestOSfeatures[].type parameter. { # Guest OS features. @@ -749,6 +751,7 @@

Method Details

}, "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB). + "enableConfidentialCompute": True or False, # Whether this image is created from a confidential compute mode disk. [Output Only]: This field is not set by user, but from source disk. "family": "A String", # The name of the image family to which this image belongs. The image family name can be from a publicly managed image family provided by Compute Engine, or from a custom image family you create. For example, centos-stream-9 is a publicly available image family. For more information, see Image family best practices. When creating disks, you can specify an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. To see a list of available options, see the guestOSfeatures[].type parameter. { # Guest OS features. @@ -990,6 +993,7 @@

Method Details

}, "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB). + "enableConfidentialCompute": True or False, # Whether this image is created from a confidential compute mode disk. [Output Only]: This field is not set by user, but from source disk. "family": "A String", # The name of the image family to which this image belongs. The image family name can be from a publicly managed image family provided by Compute Engine, or from a custom image family you create. For example, centos-stream-9 is a publicly available image family. For more information, see Image family best practices. When creating disks, you can specify an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. To see a list of available options, see the guestOSfeatures[].type parameter. { # Guest OS features. @@ -1150,6 +1154,7 @@

Method Details

}, "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB). + "enableConfidentialCompute": True or False, # Whether this image is created from a confidential compute mode disk. [Output Only]: This field is not set by user, but from source disk. "family": "A String", # The name of the image family to which this image belongs. The image family name can be from a publicly managed image family provided by Compute Engine, or from a custom image family you create. For example, centos-stream-9 is a publicly available image family. For more information, see Image family best practices. When creating disks, you can specify an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. To see a list of available options, see the guestOSfeatures[].type parameter. { # Guest OS features. diff --git a/docs/dyn/compute_beta.instanceGroupManagerResizeRequests.html b/docs/dyn/compute_beta.instanceGroupManagerResizeRequests.html new file mode 100644 index 00000000000..cad6b7de82b --- /dev/null +++ b/docs/dyn/compute_beta.instanceGroupManagerResizeRequests.html @@ -0,0 +1,554 @@ + + + +

Compute Engine API . instanceGroupManagerResizeRequests

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ delete(project, zone, instanceGroupManager, resizeRequest, requestId=None, x__xgafv=None)

+

Deletes the specified, inactive resize request. Requests that are still active cannot be deleted. Deleting request does not delete instances that were provisioned previously.

+

+ get(project, zone, instanceGroupManager, resizeRequest, x__xgafv=None)

+

Returns all of the details about the specified resize request.

+

+ insert(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)

+

Creates a new resize request that starts provisioning VMs immediately or queues VM creation.

+

+ list(project, zone, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Retrieves a list of resize requests that are contained in the managed instance group.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ delete(project, zone, instanceGroupManager, resizeRequest, requestId=None, x__xgafv=None) +
Deletes the specified, inactive resize request. Requests that are still active cannot be deleted. Deleting request does not delete instances that were provisioned previously.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone where the managed instance group is located. The name should conform to RFC1035. (required)
+  instanceGroupManager: string, The name of the managed instance group. The name should conform to RFC1035 or be a resource ID. (required)
+  resizeRequest: string, The name of the resize request to delete. The name should conform to RFC1035 or be a resource ID. (required)
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error. Keys should match /[a-zA-Z0-9-_]/ and be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
+}
+
+ +
+ get(project, zone, instanceGroupManager, resizeRequest, x__xgafv=None) +
Returns all of the details about the specified resize request.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, Name of the href="/compute/docs/regions-zones/#available">zone scoping this request. Name should conform to RFC1035. (required)
+  instanceGroupManager: string, The name of the managed instance group. Name should conform to RFC1035 or be a resource ID. (required)
+  resizeRequest: string, The name of the resize request. Name should conform to RFC1035 or be a resource ID. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # InstanceGroupManagerResizeRequest represents a request to create a number of VMs: either immediately or by queuing the request for the specified time. This resize request is nested under InstanceGroupManager and the VMs created by this request are added to the owning InstanceGroupManager.
+  "count": 42, # The count of instances to create as part of this resize request.
+  "creationTimestamp": "A String", # [Output Only] The creation timestamp for this resize request in RFC3339 text format.
+  "description": "A String", # An optional description of this resource.
+  "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+  "kind": "compute#instanceGroupManagerResizeRequest", # [Output Only] The resource type, which is always compute#instanceGroupManagerResizeRequest for resize requests.
+  "name": "A String", # The name of this resize request. The name must be 1-63 characters long, and comply with RFC1035.
+  "selfLink": "A String", # [Output Only] The URL for this resize request. The server defines this URL.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+  "state": "A String", # [Output only] Current state of the request.
+  "status": { # [Output only] Status of the request. The Status message is aligned with QueuedResource.status. ResizeRequest.queuing_policy contains the queuing policy as provided by the user; it could have either valid_until_time or valid_until_duration. ResizeRequest.status.queuing_policy always contains absolute time as calculated by the server when the request is queued.
+    "error": { # Errors encountered during the queueing or provisioning phases of the ResizeRequest.
+      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+        {
+          "code": "A String", # [Output Only] The error type identifier for this error.
+          "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
+            {
+              "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
+                "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
+                "metadatas": { # Additional structured details about this error. Keys should match /[a-zA-Z0-9-_]/ and be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
+                  "a_key": "A String",
+                },
+                "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
+              },
+              "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
+                "links": [ # URL(s) pointing to additional information on handling the current error.
+                  { # Describes a URL link.
+                    "description": "A String", # Describes what the link offers.
+                    "url": "A String", # The URL of the link.
+                  },
+                ],
+              },
+              "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
+                "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
+                "message": "A String", # The localized error message in the above locale.
+              },
+              "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+                "dimensions": { # The map holding related quota dimensions.
+                  "a_key": "A String",
+                },
+                "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
+                "limitName": "A String", # The name of the quota limit.
+                "metricName": "A String", # The Compute Engine quota metric name.
+              },
+            },
+          ],
+          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+          "message": "A String", # [Output Only] An optional, human-readable error message.
+        },
+      ],
+    },
+  },
+  "zone": "A String", # [Output Only] The URL of a zone where the resize request is located. Populated only for zonal resize requests.
+}
+
+ +
+ insert(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None) +
Creates a new resize request that starts provisioning VMs immediately or queues VM creation.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone where the managed instance group is located and where the resize request will be created. Name should conform to RFC1035. (required)
+  instanceGroupManager: string, The name of the managed instance group to which the resize request will be added. Name should conform to RFC1035 or be a resource ID. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # InstanceGroupManagerResizeRequest represents a request to create a number of VMs: either immediately or by queuing the request for the specified time. This resize request is nested under InstanceGroupManager and the VMs created by this request are added to the owning InstanceGroupManager.
+  "count": 42, # The count of instances to create as part of this resize request.
+  "creationTimestamp": "A String", # [Output Only] The creation timestamp for this resize request in RFC3339 text format.
+  "description": "A String", # An optional description of this resource.
+  "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+  "kind": "compute#instanceGroupManagerResizeRequest", # [Output Only] The resource type, which is always compute#instanceGroupManagerResizeRequest for resize requests.
+  "name": "A String", # The name of this resize request. The name must be 1-63 characters long, and comply with RFC1035.
+  "selfLink": "A String", # [Output Only] The URL for this resize request. The server defines this URL.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+  "state": "A String", # [Output only] Current state of the request.
+  "status": { # [Output only] Status of the request. The Status message is aligned with QueuedResource.status. ResizeRequest.queuing_policy contains the queuing policy as provided by the user; it could have either valid_until_time or valid_until_duration. ResizeRequest.status.queuing_policy always contains absolute time as calculated by the server when the request is queued.
+    "error": { # Errors encountered during the queueing or provisioning phases of the ResizeRequest.
+      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+        {
+          "code": "A String", # [Output Only] The error type identifier for this error.
+          "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
+            {
+              "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
+                "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
+                "metadatas": { # Additional structured details about this error. Keys should match /[a-zA-Z0-9-_]/ and be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
+                  "a_key": "A String",
+                },
+                "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
+              },
+              "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
+                "links": [ # URL(s) pointing to additional information on handling the current error.
+                  { # Describes a URL link.
+                    "description": "A String", # Describes what the link offers.
+                    "url": "A String", # The URL of the link.
+                  },
+                ],
+              },
+              "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
+                "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
+                "message": "A String", # The localized error message in the above locale.
+              },
+              "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+                "dimensions": { # The map holding related quota dimensions.
+                  "a_key": "A String",
+                },
+                "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
+                "limitName": "A String", # The name of the quota limit.
+                "metricName": "A String", # The Compute Engine quota metric name.
+              },
+            },
+          ],
+          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+          "message": "A String", # [Output Only] An optional, human-readable error message.
+        },
+      ],
+    },
+  },
+  "zone": "A String", # [Output Only] The URL of a zone where the resize request is located. Populated only for zonal resize requests.
+}
+
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error. Keys should match /[a-zA-Z0-9-_]/ and be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
+}
+
+ +
+ list(project, zone, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Retrieves a list of resize requests that are contained in the managed instance group.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone where the managed instance group is located. The name should conform to RFC1035. (required)
+  instanceGroupManager: string, The name of the managed instance group. The name should conform to RFC1035. (required)
+  filter: string, A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`.
+  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # [Output Only] A list of resize requests.
+  "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+  "items": [ # A list of resize request resources.
+    { # InstanceGroupManagerResizeRequest represents a request to create a number of VMs: either immediately or by queuing the request for the specified time. This resize request is nested under InstanceGroupManager and the VMs created by this request are added to the owning InstanceGroupManager.
+      "count": 42, # The count of instances to create as part of this resize request.
+      "creationTimestamp": "A String", # [Output Only] The creation timestamp for this resize request in RFC3339 text format.
+      "description": "A String", # An optional description of this resource.
+      "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+      "kind": "compute#instanceGroupManagerResizeRequest", # [Output Only] The resource type, which is always compute#instanceGroupManagerResizeRequest for resize requests.
+      "name": "A String", # The name of this resize request. The name must be 1-63 characters long, and comply with RFC1035.
+      "selfLink": "A String", # [Output Only] The URL for this resize request. The server defines this URL.
+      "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+      "state": "A String", # [Output only] Current state of the request.
+      "status": { # [Output only] Status of the request. The Status message is aligned with QueuedResource.status. ResizeRequest.queuing_policy contains the queuing policy as provided by the user; it could have either valid_until_time or valid_until_duration. ResizeRequest.status.queuing_policy always contains absolute time as calculated by the server when the request is queued.
+        "error": { # Errors encountered during the queueing or provisioning phases of the ResizeRequest.
+          "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+            {
+              "code": "A String", # [Output Only] The error type identifier for this error.
+              "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
+                {
+                  "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
+                    "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
+                    "metadatas": { # Additional structured details about this error. Keys should match /[a-zA-Z0-9-_]/ and be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
+                      "a_key": "A String",
+                    },
+                    "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
+                  },
+                  "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
+                    "links": [ # URL(s) pointing to additional information on handling the current error.
+                      { # Describes a URL link.
+                        "description": "A String", # Describes what the link offers.
+                        "url": "A String", # The URL of the link.
+                      },
+                    ],
+                  },
+                  "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
+                    "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
+                    "message": "A String", # The localized error message in the above locale.
+                  },
+                  "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+                    "dimensions": { # The map holding related quota dimensions.
+                      "a_key": "A String",
+                    },
+                    "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
+                    "limitName": "A String", # The name of the quota limit.
+                    "metricName": "A String", # The Compute Engine quota metric name.
+                  },
+                },
+              ],
+              "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+              "message": "A String", # [Output Only] An optional, human-readable error message.
+            },
+          ],
+        },
+      },
+      "zone": "A String", # [Output Only] The URL of a zone where the resize request is located. Populated only for zonal resize requests.
+    },
+  ],
+  "kind": "compute#instanceGroupManagerResizeRequestList", # [Output Only] Type of the resource. Always compute#instanceGroupManagerResizeRequestList for a list of resize requests.
+  "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+  "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+  "warning": { # [Output Only] Informational warning message.
+    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+    "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+      {
+        "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+        "value": "A String", # [Output Only] A warning data value corresponding to the key.
+      },
+    ],
+    "message": "A String", # [Output Only] A human-readable description of the warning code.
+  },
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/compute_beta.instanceGroupManagers.html b/docs/dyn/compute_beta.instanceGroupManagers.html index fb5bb9683b7..183b2ae4652 100644 --- a/docs/dyn/compute_beta.instanceGroupManagers.html +++ b/docs/dyn/compute_beta.instanceGroupManagers.html @@ -1805,6 +1805,7 @@

Method Details

], }, }, + "name": "A String", # [Output Only] The name of the instance. The name will always exist even if the instance has not yet been created. "preservedStateFromConfig": { # Preserved state for a given instance. # [Output Only] Preserved state applied from per-instance config for this instance. "disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks. "a_key": { diff --git a/docs/dyn/compute_beta.instanceTemplates.html b/docs/dyn/compute_beta.instanceTemplates.html index 1e54e412dbe..d1d88c80279 100644 --- a/docs/dyn/compute_beta.instanceTemplates.html +++ b/docs/dyn/compute_beta.instanceTemplates.html @@ -178,6 +178,7 @@

Method Details

"diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created. "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB. "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you specify this field when creating a VM, you can provide either the full or partial URL. For example, the following values are valid: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType If you specify this field when creating or updating an instance template or all-instances configuration, specify the type of the disk, not the URL. For example: pd-standard. + "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures { # Guest OS features. "type": "A String", # The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE - SEV_SNP_CAPABLE For more information, see Enabling guest operating system features. @@ -631,6 +632,7 @@

Method Details

"diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created. "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB. "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you specify this field when creating a VM, you can provide either the full or partial URL. For example, the following values are valid: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType If you specify this field when creating or updating an instance template or all-instances configuration, specify the type of the disk, not the URL. For example: pd-standard. + "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures { # Guest OS features. "type": "A String", # The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE - SEV_SNP_CAPABLE For more information, see Enabling guest operating system features. @@ -1030,6 +1032,7 @@

Method Details

"diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created. "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB. "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you specify this field when creating a VM, you can provide either the full or partial URL. For example, the following values are valid: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType If you specify this field when creating or updating an instance template or all-instances configuration, specify the type of the disk, not the URL. For example: pd-standard. + "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures { # Guest OS features. "type": "A String", # The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE - SEV_SNP_CAPABLE For more information, see Enabling guest operating system features. @@ -1436,6 +1439,7 @@

Method Details

"diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created. "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB. "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you specify this field when creating a VM, you can provide either the full or partial URL. For example, the following values are valid: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType If you specify this field when creating or updating an instance template or all-instances configuration, specify the type of the disk, not the URL. For example: pd-standard. + "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures { # Guest OS features. "type": "A String", # The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE - SEV_SNP_CAPABLE For more information, see Enabling guest operating system features. diff --git a/docs/dyn/compute_beta.instances.html b/docs/dyn/compute_beta.instances.html index 18aa45a7d52..0a7fd35c98c 100644 --- a/docs/dyn/compute_beta.instances.html +++ b/docs/dyn/compute_beta.instances.html @@ -542,6 +542,7 @@

Method Details

"diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created. "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB. "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you specify this field when creating a VM, you can provide either the full or partial URL. For example, the following values are valid: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType If you specify this field when creating or updating an instance template or all-instances configuration, specify the type of the disk, not the URL. For example: pd-standard. + "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures { # Guest OS features. "type": "A String", # The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE - SEV_SNP_CAPABLE For more information, see Enabling guest operating system features. @@ -896,6 +897,7 @@

Method Details

"diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created. "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB. "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you specify this field when creating a VM, you can provide either the full or partial URL. For example, the following values are valid: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType If you specify this field when creating or updating an instance template or all-instances configuration, specify the type of the disk, not the URL. For example: pd-standard. + "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures { # Guest OS features. "type": "A String", # The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE - SEV_SNP_CAPABLE For more information, see Enabling guest operating system features. @@ -1127,6 +1129,7 @@

Method Details

"diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created. "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB. "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you specify this field when creating a VM, you can provide either the full or partial URL. For example, the following values are valid: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType If you specify this field when creating or updating an instance template or all-instances configuration, specify the type of the disk, not the URL. For example: pd-standard. + "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures { # Guest OS features. "type": "A String", # The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE - SEV_SNP_CAPABLE For more information, see Enabling guest operating system features. @@ -1857,6 +1860,7 @@

Method Details

"diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created. "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB. "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you specify this field when creating a VM, you can provide either the full or partial URL. For example, the following values are valid: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType If you specify this field when creating or updating an instance template or all-instances configuration, specify the type of the disk, not the URL. For example: pd-standard. + "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures { # Guest OS features. "type": "A String", # The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE - SEV_SNP_CAPABLE For more information, see Enabling guest operating system features. @@ -2745,6 +2749,7 @@

Method Details

"diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created. "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB. "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you specify this field when creating a VM, you can provide either the full or partial URL. For example, the following values are valid: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType If you specify this field when creating or updating an instance template or all-instances configuration, specify the type of the disk, not the URL. For example: pd-standard. + "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures { # Guest OS features. "type": "A String", # The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE - SEV_SNP_CAPABLE For more information, see Enabling guest operating system features. @@ -3182,6 +3187,7 @@

Method Details

"diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created. "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB. "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you specify this field when creating a VM, you can provide either the full or partial URL. For example, the following values are valid: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType If you specify this field when creating or updating an instance template or all-instances configuration, specify the type of the disk, not the URL. For example: pd-standard. + "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures { # Guest OS features. "type": "A String", # The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE - SEV_SNP_CAPABLE For more information, see Enabling guest operating system features. @@ -6376,6 +6382,7 @@

Method Details

"diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created. "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB. "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you specify this field when creating a VM, you can provide either the full or partial URL. For example, the following values are valid: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType If you specify this field when creating or updating an instance template or all-instances configuration, specify the type of the disk, not the URL. For example: pd-standard. + "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures { # Guest OS features. "type": "A String", # The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE - SEV_SNP_CAPABLE For more information, see Enabling guest operating system features. diff --git a/docs/dyn/compute_beta.interconnectLocations.html b/docs/dyn/compute_beta.interconnectLocations.html index 607e0a571f0..3b65bdced37 100644 --- a/docs/dyn/compute_beta.interconnectLocations.html +++ b/docs/dyn/compute_beta.interconnectLocations.html @@ -110,6 +110,12 @@

Method Details

{ # Represents an Interconnect Attachment (VLAN) Location resource. You can use this resource to find location details about an Interconnect attachment (VLAN). For more information about interconnect attachments, read Creating VLAN Attachments. "address": "A String", # [Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character. "availabilityZone": "A String", # [Output Only] Availability zone for this InterconnectLocation. Within a metropolitan area (metro), maintenance will not be simultaneously scheduled in more than one availability zone. Example: "zone1" or "zone2". + "availableFeatures": [ # [Output only] List of features available at this InterconnectLocation, which can take one of the following values: - MACSEC + "A String", + ], + "availableLinkTypes": [ # [Output only] List of link types available at this InterconnectLocation, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR - LINK_TYPE_ETHERNET_100G_LR + "A String", + ], "city": "A String", # [Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: "Chicago, IL", "Amsterdam, Netherlands". "continent": "A String", # [Output Only] Continent for this location, which can take one of the following values: - AFRICA - ASIA_PAC - EUROPE - NORTH_AMERICA - SOUTH_AMERICA "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. @@ -158,6 +164,12 @@

Method Details

{ # Represents an Interconnect Attachment (VLAN) Location resource. You can use this resource to find location details about an Interconnect attachment (VLAN). For more information about interconnect attachments, read Creating VLAN Attachments. "address": "A String", # [Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character. "availabilityZone": "A String", # [Output Only] Availability zone for this InterconnectLocation. Within a metropolitan area (metro), maintenance will not be simultaneously scheduled in more than one availability zone. Example: "zone1" or "zone2". + "availableFeatures": [ # [Output only] List of features available at this InterconnectLocation, which can take one of the following values: - MACSEC + "A String", + ], + "availableLinkTypes": [ # [Output only] List of link types available at this InterconnectLocation, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR - LINK_TYPE_ETHERNET_100G_LR + "A String", + ], "city": "A String", # [Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: "Chicago, IL", "Amsterdam, Netherlands". "continent": "A String", # [Output Only] Continent for this location, which can take one of the following values: - AFRICA - ASIA_PAC - EUROPE - NORTH_AMERICA - SOUTH_AMERICA "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. diff --git a/docs/dyn/compute_beta.interconnects.html b/docs/dyn/compute_beta.interconnects.html index ede994d78a5..42be2fbfe24 100644 --- a/docs/dyn/compute_beta.interconnects.html +++ b/docs/dyn/compute_beta.interconnects.html @@ -86,6 +86,9 @@

Instance Methods

getDiagnostics(project, interconnect, x__xgafv=None)

Returns the interconnectDiagnostics for the specified Interconnect.

+

+ getMacsecConfig(project, interconnect, x__xgafv=None)

+

Returns the interconnectMacsecConfig for the specified Interconnect.

insert(project, body=None, requestId=None, x__xgafv=None)

Creates an Interconnect in the specified project using the data included in the request.

@@ -232,6 +235,9 @@

Method Details

{ # Represents an Interconnect resource. An Interconnect resource is a dedicated connection between the Google Cloud network and your on-premises network. For more information, read the Dedicated Interconnect Overview. "adminEnabled": True or False, # Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true. + "availableFeatures": [ # [Output only] List of features available for this Interconnect connection, which can take one of the following values: - MACSEC If present then the interconnect was created on MACsec capable hardware ports. If not present then the interconnect is provisioned on non-MACsec capable ports and MACsec enablement will fail. + "A String", + ], "circuitInfos": [ # [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG. { # Describes a single physical circuit between the Customer and Google. CircuitInfo objects are created by Google, so all fields are output only. "customerDemarcId": "A String", # Customer-side demarc ID for this circuit. @@ -270,12 +276,25 @@

Method Details

}, "linkType": "A String", # Type of link requested, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle. "location": "A String", # URL of the InterconnectLocation object that represents where this connection is to be provisioned. + "macsec": { # Configuration information for enabling Media Access Control security (MACsec) on this Interconnect connection between Google and your on-premises router. # Configuration to enable Media Access Control security (MACsec) on the Interconnect connection between Google and your on-premises router. + "failOpen": True or False, # If set to true, the Interconnect connection is configured with a should-secure MACsec security policy, that allows the Google router to fallback to cleartext traffic if the MKA session cannot be established. By default, the Interconnect connection is configured with a must-secure security policy that drops all traffic if the MKA session cannot be established with your router. + "preSharedKeys": [ # Required. A keychain placeholder describing a set of named key objects along with their start times. A MACsec CKN/CAK will be generated for each key in the key chain. Google router will automatically pick the key with the most recent startTime when establishing or re-establishing a MACsec secure link. + { # Describes a pre-shared key used to setup MACsec in static connectivity association key (CAK) mode. + "name": "A String", # Required. A name for this pre-shared key. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + "startTime": "A String", # A RFC3339 timestamp on or after which the key is valid. startTime can be in the future. If the keychain has a single key, startTime can be omitted. If the keychain has multiple keys, startTime is mandatory for each key. The start times of keys must be in increasing order. The start times of two consecutive keys must be at least 6 hours apart. + }, + ], + }, + "macsecEnabled": True or False, # Enable or disable MACsec on this Interconnect connection. MACsec enablement fails if the MACsec object is not specified. "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "nocContactEmail": "A String", # Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Cloud Monitoring logs alerting and Cloud Notifications. This field is required for users who sign up for Cloud Interconnect using workforce identity federation. "operationalStatus": "A String", # [Output Only] The current status of this Interconnect's functionality, which can take one of the following values: - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect. - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect. - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. "peerIpAddress": "A String", # [Output Only] IP address configured on the customer side of the Interconnect link. The customer should configure this IP address during turnup when prompted by Google NOC. This can be used only for ping tests. "provisionedLinkCount": 42, # [Output Only] Number of links actually provisioned in this interconnect. "remoteLocation": "A String", # Indicates that this is a Cross-Cloud Interconnect. This field specifies the location outside of Google's network that the interconnect is connected to. + "requestedFeatures": [ # Optional. List of features requested for this Interconnect connection, which can take one of the following values: - MACSEC If specified then the interconnect will be created on MACsec capable hardware ports. If not specified, the default value is false, which will allocate non-MACsec capable ports first if available. This parameter can only be provided during interconnect INSERT and cannot be changed using interconnect PATCH. + "A String", + ], "requestedLinkCount": 42, # Target number of physical links in the link bundle, as requested by the customer. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. @@ -299,7 +318,7 @@

Method Details

An object of the form: { # Response for the InterconnectsGetDiagnosticsRequest. - "result": { # Diagnostics information about interconnect, contains detailed and current technical information about Google's side of the connection. + "result": { # Diagnostics information about the Interconnect connection, which contains detailed and current technical information about Google's side of the connection. "arpCaches": [ # A list of InterconnectDiagnostics.ARPEntry objects, describing individual neighbors currently seen by the Google router in the ARP cache for the Interconnect. This will be empty when the Interconnect is not bundled. { # Describing the ARP neighbor entries seen on this link "ipAddress": "A String", # The IP address of this ARP neighbor. @@ -323,6 +342,10 @@

Method Details

"neighborSystemId": "A String", # System ID of the port on the neighbor's side of the LACP exchange. "state": "A String", # The state of a LACP link, which can take one of the following values: - ACTIVE: The link is configured and active within the bundle. - DETACHED: The link is not configured within the bundle. This means that the rest of the object should be empty. }, + "macsec": { # Describes the status of MACsec encryption on the link. # Describes the status of MACsec encryption on this link. + "ckn": "A String", # Indicates the Connectivity Association Key Name (CKN) currently being used if MACsec is operational. + "operational": True or False, # Indicates whether or not MACsec is operational on this link. + }, "operationalStatus": "A String", # The operational status of the link. "receivingOpticalPower": { # An InterconnectDiagnostics.LinkOpticalPower object, describing the current value and status of the received light level. "state": "A String", # The status of the current value when compared to the warning and alarm levels for the receiving or transmitting transceiver. Possible states include: - OK: The value has not crossed a warning threshold. - LOW_WARNING: The value has crossed below the low warning threshold. - HIGH_WARNING: The value has crossed above the high warning threshold. - LOW_ALARM: The value has crossed below the low alarm threshold. - HIGH_ALARM: The value has crossed above the high alarm threshold. @@ -339,6 +362,36 @@

Method Details

}
+
+ getMacsecConfig(project, interconnect, x__xgafv=None) +
Returns the interconnectMacsecConfig for the specified Interconnect.
+
+Args:
+  project: string, Project ID for this request. (required)
+  interconnect: string, Name of the interconnect resource to query. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for the InterconnectsGetMacsecConfigRequest.
+  "etag": "A String", # end_interface: MixerGetResponseWithEtagBuilder
+  "result": { # MACsec configuration information for the Interconnect connection. Contains the generated Connectivity Association Key Name (CKN) and the key (CAK) for this Interconnect connection.
+    "preSharedKeys": [ # A keychain placeholder describing a set of named key objects along with their start times. A MACsec CKN/CAK is generated for each key in the key chain. Google router automatically picks the key with the most recent startTime when establishing or re-establishing a MACsec secure link.
+      { # Describes a pre-shared key used to setup MACsec in static connectivity association key (CAK) mode.
+        "cak": "A String", # An auto-generated Connectivity Association Key (CAK) for this key.
+        "ckn": "A String", # An auto-generated Connectivity Association Key Name (CKN) for this key.
+        "name": "A String", # User provided name for this pre-shared key.
+        "startTime": "A String", # User provided timestamp on or after which this key is valid.
+      },
+    ],
+  },
+}
+
+
insert(project, body=None, requestId=None, x__xgafv=None)
Creates an Interconnect in the specified project using the data included in the request.
@@ -350,6 +403,9 @@ 

Method Details

{ # Represents an Interconnect resource. An Interconnect resource is a dedicated connection between the Google Cloud network and your on-premises network. For more information, read the Dedicated Interconnect Overview. "adminEnabled": True or False, # Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true. + "availableFeatures": [ # [Output only] List of features available for this Interconnect connection, which can take one of the following values: - MACSEC If present then the interconnect was created on MACsec capable hardware ports. If not present then the interconnect is provisioned on non-MACsec capable ports and MACsec enablement will fail. + "A String", + ], "circuitInfos": [ # [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG. { # Describes a single physical circuit between the Customer and Google. CircuitInfo objects are created by Google, so all fields are output only. "customerDemarcId": "A String", # Customer-side demarc ID for this circuit. @@ -388,12 +444,25 @@

Method Details

}, "linkType": "A String", # Type of link requested, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle. "location": "A String", # URL of the InterconnectLocation object that represents where this connection is to be provisioned. + "macsec": { # Configuration information for enabling Media Access Control security (MACsec) on this Interconnect connection between Google and your on-premises router. # Configuration to enable Media Access Control security (MACsec) on the Interconnect connection between Google and your on-premises router. + "failOpen": True or False, # If set to true, the Interconnect connection is configured with a should-secure MACsec security policy, that allows the Google router to fallback to cleartext traffic if the MKA session cannot be established. By default, the Interconnect connection is configured with a must-secure security policy that drops all traffic if the MKA session cannot be established with your router. + "preSharedKeys": [ # Required. A keychain placeholder describing a set of named key objects along with their start times. A MACsec CKN/CAK will be generated for each key in the key chain. Google router will automatically pick the key with the most recent startTime when establishing or re-establishing a MACsec secure link. + { # Describes a pre-shared key used to setup MACsec in static connectivity association key (CAK) mode. + "name": "A String", # Required. A name for this pre-shared key. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + "startTime": "A String", # A RFC3339 timestamp on or after which the key is valid. startTime can be in the future. If the keychain has a single key, startTime can be omitted. If the keychain has multiple keys, startTime is mandatory for each key. The start times of keys must be in increasing order. The start times of two consecutive keys must be at least 6 hours apart. + }, + ], + }, + "macsecEnabled": True or False, # Enable or disable MACsec on this Interconnect connection. MACsec enablement fails if the MACsec object is not specified. "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "nocContactEmail": "A String", # Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Cloud Monitoring logs alerting and Cloud Notifications. This field is required for users who sign up for Cloud Interconnect using workforce identity federation. "operationalStatus": "A String", # [Output Only] The current status of this Interconnect's functionality, which can take one of the following values: - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect. - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect. - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. "peerIpAddress": "A String", # [Output Only] IP address configured on the customer side of the Interconnect link. The customer should configure this IP address during turnup when prompted by Google NOC. This can be used only for ping tests. "provisionedLinkCount": 42, # [Output Only] Number of links actually provisioned in this interconnect. "remoteLocation": "A String", # Indicates that this is a Cross-Cloud Interconnect. This field specifies the location outside of Google's network that the interconnect is connected to. + "requestedFeatures": [ # Optional. List of features requested for this Interconnect connection, which can take one of the following values: - MACSEC If specified then the interconnect will be created on MACsec capable hardware ports. If not specified, the default value is false, which will allocate non-MACsec capable ports first if available. This parameter can only be provided during interconnect INSERT and cannot be changed using interconnect PATCH. + "A String", + ], "requestedLinkCount": 42, # Target number of physical links in the link bundle, as requested by the customer. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. @@ -522,6 +591,9 @@

Method Details

"items": [ # A list of Interconnect resources. { # Represents an Interconnect resource. An Interconnect resource is a dedicated connection between the Google Cloud network and your on-premises network. For more information, read the Dedicated Interconnect Overview. "adminEnabled": True or False, # Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true. + "availableFeatures": [ # [Output only] List of features available for this Interconnect connection, which can take one of the following values: - MACSEC If present then the interconnect was created on MACsec capable hardware ports. If not present then the interconnect is provisioned on non-MACsec capable ports and MACsec enablement will fail. + "A String", + ], "circuitInfos": [ # [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG. { # Describes a single physical circuit between the Customer and Google. CircuitInfo objects are created by Google, so all fields are output only. "customerDemarcId": "A String", # Customer-side demarc ID for this circuit. @@ -560,12 +632,25 @@

Method Details

}, "linkType": "A String", # Type of link requested, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle. "location": "A String", # URL of the InterconnectLocation object that represents where this connection is to be provisioned. + "macsec": { # Configuration information for enabling Media Access Control security (MACsec) on this Interconnect connection between Google and your on-premises router. # Configuration to enable Media Access Control security (MACsec) on the Interconnect connection between Google and your on-premises router. + "failOpen": True or False, # If set to true, the Interconnect connection is configured with a should-secure MACsec security policy, that allows the Google router to fallback to cleartext traffic if the MKA session cannot be established. By default, the Interconnect connection is configured with a must-secure security policy that drops all traffic if the MKA session cannot be established with your router. + "preSharedKeys": [ # Required. A keychain placeholder describing a set of named key objects along with their start times. A MACsec CKN/CAK will be generated for each key in the key chain. Google router will automatically pick the key with the most recent startTime when establishing or re-establishing a MACsec secure link. + { # Describes a pre-shared key used to setup MACsec in static connectivity association key (CAK) mode. + "name": "A String", # Required. A name for this pre-shared key. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + "startTime": "A String", # A RFC3339 timestamp on or after which the key is valid. startTime can be in the future. If the keychain has a single key, startTime can be omitted. If the keychain has multiple keys, startTime is mandatory for each key. The start times of keys must be in increasing order. The start times of two consecutive keys must be at least 6 hours apart. + }, + ], + }, + "macsecEnabled": True or False, # Enable or disable MACsec on this Interconnect connection. MACsec enablement fails if the MACsec object is not specified. "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "nocContactEmail": "A String", # Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Cloud Monitoring logs alerting and Cloud Notifications. This field is required for users who sign up for Cloud Interconnect using workforce identity federation. "operationalStatus": "A String", # [Output Only] The current status of this Interconnect's functionality, which can take one of the following values: - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect. - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect. - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. "peerIpAddress": "A String", # [Output Only] IP address configured on the customer side of the Interconnect link. The customer should configure this IP address during turnup when prompted by Google NOC. This can be used only for ping tests. "provisionedLinkCount": 42, # [Output Only] Number of links actually provisioned in this interconnect. "remoteLocation": "A String", # Indicates that this is a Cross-Cloud Interconnect. This field specifies the location outside of Google's network that the interconnect is connected to. + "requestedFeatures": [ # Optional. List of features requested for this Interconnect connection, which can take one of the following values: - MACSEC If specified then the interconnect will be created on MACsec capable hardware ports. If not specified, the default value is false, which will allocate non-MACsec capable ports first if available. This parameter can only be provided during interconnect INSERT and cannot be changed using interconnect PATCH. + "A String", + ], "requestedLinkCount": 42, # Target number of physical links in the link bundle, as requested by the customer. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. @@ -614,6 +699,9 @@

Method Details

{ # Represents an Interconnect resource. An Interconnect resource is a dedicated connection between the Google Cloud network and your on-premises network. For more information, read the Dedicated Interconnect Overview. "adminEnabled": True or False, # Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true. + "availableFeatures": [ # [Output only] List of features available for this Interconnect connection, which can take one of the following values: - MACSEC If present then the interconnect was created on MACsec capable hardware ports. If not present then the interconnect is provisioned on non-MACsec capable ports and MACsec enablement will fail. + "A String", + ], "circuitInfos": [ # [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG. { # Describes a single physical circuit between the Customer and Google. CircuitInfo objects are created by Google, so all fields are output only. "customerDemarcId": "A String", # Customer-side demarc ID for this circuit. @@ -652,12 +740,25 @@

Method Details

}, "linkType": "A String", # Type of link requested, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle. "location": "A String", # URL of the InterconnectLocation object that represents where this connection is to be provisioned. + "macsec": { # Configuration information for enabling Media Access Control security (MACsec) on this Interconnect connection between Google and your on-premises router. # Configuration to enable Media Access Control security (MACsec) on the Interconnect connection between Google and your on-premises router. + "failOpen": True or False, # If set to true, the Interconnect connection is configured with a should-secure MACsec security policy, that allows the Google router to fallback to cleartext traffic if the MKA session cannot be established. By default, the Interconnect connection is configured with a must-secure security policy that drops all traffic if the MKA session cannot be established with your router. + "preSharedKeys": [ # Required. A keychain placeholder describing a set of named key objects along with their start times. A MACsec CKN/CAK will be generated for each key in the key chain. Google router will automatically pick the key with the most recent startTime when establishing or re-establishing a MACsec secure link. + { # Describes a pre-shared key used to setup MACsec in static connectivity association key (CAK) mode. + "name": "A String", # Required. A name for this pre-shared key. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + "startTime": "A String", # A RFC3339 timestamp on or after which the key is valid. startTime can be in the future. If the keychain has a single key, startTime can be omitted. If the keychain has multiple keys, startTime is mandatory for each key. The start times of keys must be in increasing order. The start times of two consecutive keys must be at least 6 hours apart. + }, + ], + }, + "macsecEnabled": True or False, # Enable or disable MACsec on this Interconnect connection. MACsec enablement fails if the MACsec object is not specified. "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "nocContactEmail": "A String", # Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Cloud Monitoring logs alerting and Cloud Notifications. This field is required for users who sign up for Cloud Interconnect using workforce identity federation. "operationalStatus": "A String", # [Output Only] The current status of this Interconnect's functionality, which can take one of the following values: - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect. - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect. - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. "peerIpAddress": "A String", # [Output Only] IP address configured on the customer side of the Interconnect link. The customer should configure this IP address during turnup when prompted by Google NOC. This can be used only for ping tests. "provisionedLinkCount": 42, # [Output Only] Number of links actually provisioned in this interconnect. "remoteLocation": "A String", # Indicates that this is a Cross-Cloud Interconnect. This field specifies the location outside of Google's network that the interconnect is connected to. + "requestedFeatures": [ # Optional. List of features requested for this Interconnect connection, which can take one of the following values: - MACSEC If specified then the interconnect will be created on MACsec capable hardware ports. If not specified, the default value is false, which will allocate non-MACsec capable ports first if available. This parameter can only be provided during interconnect INSERT and cannot be changed using interconnect PATCH. + "A String", + ], "requestedLinkCount": 42, # Target number of physical links in the link bundle, as requested by the customer. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. diff --git a/docs/dyn/compute_beta.machineImages.html b/docs/dyn/compute_beta.machineImages.html index c2b358d6eb6..c34cec1af9d 100644 --- a/docs/dyn/compute_beta.machineImages.html +++ b/docs/dyn/compute_beta.machineImages.html @@ -271,6 +271,7 @@

Method Details

"diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created. "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB. "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you specify this field when creating a VM, you can provide either the full or partial URL. For example, the following values are valid: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType If you specify this field when creating or updating an instance template or all-instances configuration, specify the type of the disk, not the URL. For example: pd-standard. + "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures { # Guest OS features. "type": "A String", # The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE - SEV_SNP_CAPABLE For more information, see Enabling guest operating system features. @@ -845,6 +846,7 @@

Method Details

"diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created. "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB. "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you specify this field when creating a VM, you can provide either the full or partial URL. For example, the following values are valid: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType If you specify this field when creating or updating an instance template or all-instances configuration, specify the type of the disk, not the URL. For example: pd-standard. + "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures { # Guest OS features. "type": "A String", # The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE - SEV_SNP_CAPABLE For more information, see Enabling guest operating system features. @@ -1427,6 +1429,7 @@

Method Details

"diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created. "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB. "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you specify this field when creating a VM, you can provide either the full or partial URL. For example, the following values are valid: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType If you specify this field when creating or updating an instance template or all-instances configuration, specify the type of the disk, not the URL. For example: pd-standard. + "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures { # Guest OS features. "type": "A String", # The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE - SEV_SNP_CAPABLE For more information, see Enabling guest operating system features. diff --git a/docs/dyn/compute_beta.organizationSecurityPolicies.html b/docs/dyn/compute_beta.organizationSecurityPolicies.html index 126780b3525..b6a2e68af63 100644 --- a/docs/dyn/compute_beta.organizationSecurityPolicies.html +++ b/docs/dyn/compute_beta.organizationSecurityPolicies.html @@ -742,6 +742,15 @@

Method Details

"layer7DdosDefenseConfig": { # Configuration options for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR. # If set to true, enables Cloud Armor Machine Learning. "enable": True or False, # If set to true, enables CAAP for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR. "ruleVisibility": "A String", # Rule visibility can be one of the following: STANDARD - opaque rules. (default) PREMIUM - transparent rules. This field is only supported in Global Security Policies of type CLOUD_ARMOR. + "thresholdConfigs": [ # Configuration options for layer7 adaptive protection for various customizable thresholds. + { + "autoDeployConfidenceThreshold": 3.14, + "autoDeployExpirationSec": 42, + "autoDeployImpactedBaselineThreshold": 3.14, + "autoDeployLoadThreshold": 3.14, + "name": "A String", # The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the security policy. + }, + ], }, }, "advancedOptionsConfig": { @@ -1168,6 +1177,15 @@

Method Details

"layer7DdosDefenseConfig": { # Configuration options for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR. # If set to true, enables Cloud Armor Machine Learning. "enable": True or False, # If set to true, enables CAAP for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR. "ruleVisibility": "A String", # Rule visibility can be one of the following: STANDARD - opaque rules. (default) PREMIUM - transparent rules. This field is only supported in Global Security Policies of type CLOUD_ARMOR. + "thresholdConfigs": [ # Configuration options for layer7 adaptive protection for various customizable thresholds. + { + "autoDeployConfidenceThreshold": 3.14, + "autoDeployExpirationSec": 42, + "autoDeployImpactedBaselineThreshold": 3.14, + "autoDeployLoadThreshold": 3.14, + "name": "A String", # The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the security policy. + }, + ], }, }, "advancedOptionsConfig": { @@ -1512,6 +1530,15 @@

Method Details

"layer7DdosDefenseConfig": { # Configuration options for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR. # If set to true, enables Cloud Armor Machine Learning. "enable": True or False, # If set to true, enables CAAP for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR. "ruleVisibility": "A String", # Rule visibility can be one of the following: STANDARD - opaque rules. (default) PREMIUM - transparent rules. This field is only supported in Global Security Policies of type CLOUD_ARMOR. + "thresholdConfigs": [ # Configuration options for layer7 adaptive protection for various customizable thresholds. + { + "autoDeployConfidenceThreshold": 3.14, + "autoDeployExpirationSec": 42, + "autoDeployImpactedBaselineThreshold": 3.14, + "autoDeployLoadThreshold": 3.14, + "name": "A String", # The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the security policy. + }, + ], }, }, "advancedOptionsConfig": { @@ -1905,6 +1932,15 @@

Method Details

"layer7DdosDefenseConfig": { # Configuration options for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR. # If set to true, enables Cloud Armor Machine Learning. "enable": True or False, # If set to true, enables CAAP for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR. "ruleVisibility": "A String", # Rule visibility can be one of the following: STANDARD - opaque rules. (default) PREMIUM - transparent rules. This field is only supported in Global Security Policies of type CLOUD_ARMOR. + "thresholdConfigs": [ # Configuration options for layer7 adaptive protection for various customizable thresholds. + { + "autoDeployConfidenceThreshold": 3.14, + "autoDeployExpirationSec": 42, + "autoDeployImpactedBaselineThreshold": 3.14, + "autoDeployLoadThreshold": 3.14, + "name": "A String", # The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the security policy. + }, + ], }, }, "advancedOptionsConfig": { diff --git a/docs/dyn/compute_beta.projects.html b/docs/dyn/compute_beta.projects.html index b3d2a227ea7..1fb19b1000c 100644 --- a/docs/dyn/compute_beta.projects.html +++ b/docs/dyn/compute_beta.projects.html @@ -112,7 +112,7 @@

Instance Methods

Moves a persistent disk from one zone to another.

moveInstance(project, body=None, requestId=None, x__xgafv=None)

-

Moves an instance and its attached persistent disks from one zone to another. *Note*: Moving VMs or disks by using this method might cause unexpected behavior. For more information, see the [known issue](/compute/docs/troubleshooting/known-issues#moving_vms_or_disks_using_the_moveinstance_api_or_the_causes_unexpected_behavior).

+

Moves an instance and its attached persistent disks from one zone to another. *Note*: Moving VMs or disks by using this method might cause unexpected behavior. For more information, see the [known issue](/compute/docs/troubleshooting/known-issues#moving_vms_or_disks_using_the_moveinstance_api_or_the_causes_unexpected_behavior). [Deprecated] This method is deprecated. See [moving instance across zones](/compute/docs/instances/moving-instance-across-zones) instead.

setCommonInstanceMetadata(project, body=None, requestId=None, x__xgafv=None)

Sets metadata common to all instances within the specified project using the data included in the request.

@@ -926,7 +926,7 @@

Method Details

moveInstance(project, body=None, requestId=None, x__xgafv=None) -
Moves an instance and its attached persistent disks from one zone to another. *Note*: Moving VMs or disks by using this method might cause unexpected behavior. For more information, see the [known issue](/compute/docs/troubleshooting/known-issues#moving_vms_or_disks_using_the_moveinstance_api_or_the_causes_unexpected_behavior).
+  
Moves an instance and its attached persistent disks from one zone to another. *Note*: Moving VMs or disks by using this method might cause unexpected behavior. For more information, see the [known issue](/compute/docs/troubleshooting/known-issues#moving_vms_or_disks_using_the_moveinstance_api_or_the_causes_unexpected_behavior). [Deprecated] This method is deprecated. See [moving instance across zones](/compute/docs/instances/moving-instance-across-zones) instead.
 
 Args:
   project: string, Project ID for this request. (required)
diff --git a/docs/dyn/compute_beta.regionBackendServices.html b/docs/dyn/compute_beta.regionBackendServices.html
index 3d8b103fe45..cadd991b818 100644
--- a/docs/dyn/compute_beta.regionBackendServices.html
+++ b/docs/dyn/compute_beta.regionBackendServices.html
@@ -391,24 +391,24 @@ 

Method Details

}, "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL. - "outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. If not set, this feature is considered disabled. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, HTTP2, or GRPC, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. - "baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s. + "outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service. If not set, this feature is considered disabled. Results of the outlier detection algorithm (ejection of endpoints from the load balancing pool and returning them back to the pool) are executed independently by each proxy instance of the load balancer. In most cases, more than one proxy instance handles the traffic received by a backend service. Thus, it is possible that an unhealthy endpoint is detected and ejected by only some of the proxies, and while this happens, other proxies may continue to send requests to the same unhealthy endpoint until they detect and eject the unhealthy endpoint. Applicable backend endpoints can be: - VM instances in an Instance Group - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT) - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT) - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud Functions Services - Private Service Connect NEGs, that resolve to Google-managed regional API endpoints or managed services published using Private Service Connect Applicable backend service types can be: - A global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. - A regional backend service with the serviceProtocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not supported for Serverless NEGs. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. + "baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a backend endpoint is ejected for. Defaults to 30000ms or 30s. After a backend endpoint is returned back to the load balancing pool, it can be ejected again in another ejection analysis. Thus, the total ejection time is equal to the base ejection time multiplied by the number of times the backend endpoint has been ejected. Defaults to 30000ms or 30s. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "consecutiveErrors": 42, # Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingConsecutiveErrors": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingSuccessRate": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. - "interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second. + "consecutiveErrors": 42, # Number of consecutive errors before a backend endpoint is ejected from the load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. + "consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. + "enforcingConsecutiveErrors": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. + "enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. + "enforcingSuccessRate": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service uses Serverless NEG. + "interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections and backend endpoints being returned to service. The interval is equal to the number of seconds as defined in outlierDetection.interval.seconds plus the number of nanoseconds as defined in outlierDetection.interval.nanos. Defaults to 1 second. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxEjectionPercent": 42, # Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%. - "successRateMinimumHosts": 42, # The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5. - "successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100. - "successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. + "maxEjectionPercent": 42, # Maximum percentage of backend endpoints in the load balancing pool for the backend service that can be ejected if the ejection conditions are met. Defaults to 50%. + "successRateMinimumHosts": 42, # The number of backend endpoints in the load balancing pool that must have enough request volume to detect success rate outliers. If the number of backend endpoints is fewer than this setting, outlier detection via success rate statistics is not performed for any backend endpoint in the load balancing pool. Defaults to 5. Not supported when the backend service uses Serverless NEG. + "successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this backend endpoint in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that backend endpoint. Defaults to 100. Not supported when the backend service uses Serverless NEG. + "successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * successRateStdevFactor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. Not supported when the backend service uses Serverless NEG. }, "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port. "portName": "A String", # A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be [defined on each backend instance group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports). This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name. @@ -752,24 +752,24 @@

Method Details

}, "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL. - "outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. If not set, this feature is considered disabled. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, HTTP2, or GRPC, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. - "baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s. + "outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service. If not set, this feature is considered disabled. Results of the outlier detection algorithm (ejection of endpoints from the load balancing pool and returning them back to the pool) are executed independently by each proxy instance of the load balancer. In most cases, more than one proxy instance handles the traffic received by a backend service. Thus, it is possible that an unhealthy endpoint is detected and ejected by only some of the proxies, and while this happens, other proxies may continue to send requests to the same unhealthy endpoint until they detect and eject the unhealthy endpoint. Applicable backend endpoints can be: - VM instances in an Instance Group - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT) - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT) - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud Functions Services - Private Service Connect NEGs, that resolve to Google-managed regional API endpoints or managed services published using Private Service Connect Applicable backend service types can be: - A global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. - A regional backend service with the serviceProtocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not supported for Serverless NEGs. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. + "baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a backend endpoint is ejected for. Defaults to 30000ms or 30s. After a backend endpoint is returned back to the load balancing pool, it can be ejected again in another ejection analysis. Thus, the total ejection time is equal to the base ejection time multiplied by the number of times the backend endpoint has been ejected. Defaults to 30000ms or 30s. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "consecutiveErrors": 42, # Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingConsecutiveErrors": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingSuccessRate": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. - "interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second. + "consecutiveErrors": 42, # Number of consecutive errors before a backend endpoint is ejected from the load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. + "consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. + "enforcingConsecutiveErrors": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. + "enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. + "enforcingSuccessRate": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service uses Serverless NEG. + "interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections and backend endpoints being returned to service. The interval is equal to the number of seconds as defined in outlierDetection.interval.seconds plus the number of nanoseconds as defined in outlierDetection.interval.nanos. Defaults to 1 second. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxEjectionPercent": 42, # Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%. - "successRateMinimumHosts": 42, # The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5. - "successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100. - "successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. + "maxEjectionPercent": 42, # Maximum percentage of backend endpoints in the load balancing pool for the backend service that can be ejected if the ejection conditions are met. Defaults to 50%. + "successRateMinimumHosts": 42, # The number of backend endpoints in the load balancing pool that must have enough request volume to detect success rate outliers. If the number of backend endpoints is fewer than this setting, outlier detection via success rate statistics is not performed for any backend endpoint in the load balancing pool. Defaults to 5. Not supported when the backend service uses Serverless NEG. + "successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this backend endpoint in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that backend endpoint. Defaults to 100. Not supported when the backend service uses Serverless NEG. + "successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * successRateStdevFactor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. Not supported when the backend service uses Serverless NEG. }, "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port. "portName": "A String", # A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be [defined on each backend instance group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports). This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name. @@ -1073,24 +1073,24 @@

Method Details

}, "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL. - "outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. If not set, this feature is considered disabled. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, HTTP2, or GRPC, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. - "baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s. + "outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service. If not set, this feature is considered disabled. Results of the outlier detection algorithm (ejection of endpoints from the load balancing pool and returning them back to the pool) are executed independently by each proxy instance of the load balancer. In most cases, more than one proxy instance handles the traffic received by a backend service. Thus, it is possible that an unhealthy endpoint is detected and ejected by only some of the proxies, and while this happens, other proxies may continue to send requests to the same unhealthy endpoint until they detect and eject the unhealthy endpoint. Applicable backend endpoints can be: - VM instances in an Instance Group - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT) - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT) - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud Functions Services - Private Service Connect NEGs, that resolve to Google-managed regional API endpoints or managed services published using Private Service Connect Applicable backend service types can be: - A global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. - A regional backend service with the serviceProtocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not supported for Serverless NEGs. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. + "baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a backend endpoint is ejected for. Defaults to 30000ms or 30s. After a backend endpoint is returned back to the load balancing pool, it can be ejected again in another ejection analysis. Thus, the total ejection time is equal to the base ejection time multiplied by the number of times the backend endpoint has been ejected. Defaults to 30000ms or 30s. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "consecutiveErrors": 42, # Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingConsecutiveErrors": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingSuccessRate": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. - "interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second. + "consecutiveErrors": 42, # Number of consecutive errors before a backend endpoint is ejected from the load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. + "consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. + "enforcingConsecutiveErrors": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. + "enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. + "enforcingSuccessRate": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service uses Serverless NEG. + "interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections and backend endpoints being returned to service. The interval is equal to the number of seconds as defined in outlierDetection.interval.seconds plus the number of nanoseconds as defined in outlierDetection.interval.nanos. Defaults to 1 second. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxEjectionPercent": 42, # Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%. - "successRateMinimumHosts": 42, # The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5. - "successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100. - "successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. + "maxEjectionPercent": 42, # Maximum percentage of backend endpoints in the load balancing pool for the backend service that can be ejected if the ejection conditions are met. Defaults to 50%. + "successRateMinimumHosts": 42, # The number of backend endpoints in the load balancing pool that must have enough request volume to detect success rate outliers. If the number of backend endpoints is fewer than this setting, outlier detection via success rate statistics is not performed for any backend endpoint in the load balancing pool. Defaults to 5. Not supported when the backend service uses Serverless NEG. + "successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this backend endpoint in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that backend endpoint. Defaults to 100. Not supported when the backend service uses Serverless NEG. + "successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * successRateStdevFactor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. Not supported when the backend service uses Serverless NEG. }, "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port. "portName": "A String", # A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be [defined on each backend instance group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports). This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name. @@ -1314,24 +1314,24 @@

Method Details

}, "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL. - "outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. If not set, this feature is considered disabled. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, HTTP2, or GRPC, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. - "baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s. + "outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service. If not set, this feature is considered disabled. Results of the outlier detection algorithm (ejection of endpoints from the load balancing pool and returning them back to the pool) are executed independently by each proxy instance of the load balancer. In most cases, more than one proxy instance handles the traffic received by a backend service. Thus, it is possible that an unhealthy endpoint is detected and ejected by only some of the proxies, and while this happens, other proxies may continue to send requests to the same unhealthy endpoint until they detect and eject the unhealthy endpoint. Applicable backend endpoints can be: - VM instances in an Instance Group - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT) - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT) - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud Functions Services - Private Service Connect NEGs, that resolve to Google-managed regional API endpoints or managed services published using Private Service Connect Applicable backend service types can be: - A global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. - A regional backend service with the serviceProtocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not supported for Serverless NEGs. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. + "baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a backend endpoint is ejected for. Defaults to 30000ms or 30s. After a backend endpoint is returned back to the load balancing pool, it can be ejected again in another ejection analysis. Thus, the total ejection time is equal to the base ejection time multiplied by the number of times the backend endpoint has been ejected. Defaults to 30000ms or 30s. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "consecutiveErrors": 42, # Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingConsecutiveErrors": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingSuccessRate": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. - "interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second. + "consecutiveErrors": 42, # Number of consecutive errors before a backend endpoint is ejected from the load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. + "consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. + "enforcingConsecutiveErrors": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. + "enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. + "enforcingSuccessRate": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service uses Serverless NEG. + "interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections and backend endpoints being returned to service. The interval is equal to the number of seconds as defined in outlierDetection.interval.seconds plus the number of nanoseconds as defined in outlierDetection.interval.nanos. Defaults to 1 second. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxEjectionPercent": 42, # Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%. - "successRateMinimumHosts": 42, # The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5. - "successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100. - "successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. + "maxEjectionPercent": 42, # Maximum percentage of backend endpoints in the load balancing pool for the backend service that can be ejected if the ejection conditions are met. Defaults to 50%. + "successRateMinimumHosts": 42, # The number of backend endpoints in the load balancing pool that must have enough request volume to detect success rate outliers. If the number of backend endpoints is fewer than this setting, outlier detection via success rate statistics is not performed for any backend endpoint in the load balancing pool. Defaults to 5. Not supported when the backend service uses Serverless NEG. + "successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this backend endpoint in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that backend endpoint. Defaults to 100. Not supported when the backend service uses Serverless NEG. + "successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * successRateStdevFactor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. Not supported when the backend service uses Serverless NEG. }, "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port. "portName": "A String", # A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be [defined on each backend instance group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports). This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name. @@ -1978,24 +1978,24 @@

Method Details

}, "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL. - "outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. If not set, this feature is considered disabled. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, HTTP2, or GRPC, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. - "baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s. + "outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service. If not set, this feature is considered disabled. Results of the outlier detection algorithm (ejection of endpoints from the load balancing pool and returning them back to the pool) are executed independently by each proxy instance of the load balancer. In most cases, more than one proxy instance handles the traffic received by a backend service. Thus, it is possible that an unhealthy endpoint is detected and ejected by only some of the proxies, and while this happens, other proxies may continue to send requests to the same unhealthy endpoint until they detect and eject the unhealthy endpoint. Applicable backend endpoints can be: - VM instances in an Instance Group - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT) - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT) - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud Functions Services - Private Service Connect NEGs, that resolve to Google-managed regional API endpoints or managed services published using Private Service Connect Applicable backend service types can be: - A global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. - A regional backend service with the serviceProtocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not supported for Serverless NEGs. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. + "baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a backend endpoint is ejected for. Defaults to 30000ms or 30s. After a backend endpoint is returned back to the load balancing pool, it can be ejected again in another ejection analysis. Thus, the total ejection time is equal to the base ejection time multiplied by the number of times the backend endpoint has been ejected. Defaults to 30000ms or 30s. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "consecutiveErrors": 42, # Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingConsecutiveErrors": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingSuccessRate": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. - "interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second. + "consecutiveErrors": 42, # Number of consecutive errors before a backend endpoint is ejected from the load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. + "consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. + "enforcingConsecutiveErrors": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. + "enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. + "enforcingSuccessRate": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service uses Serverless NEG. + "interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections and backend endpoints being returned to service. The interval is equal to the number of seconds as defined in outlierDetection.interval.seconds plus the number of nanoseconds as defined in outlierDetection.interval.nanos. Defaults to 1 second. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxEjectionPercent": 42, # Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%. - "successRateMinimumHosts": 42, # The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5. - "successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100. - "successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. + "maxEjectionPercent": 42, # Maximum percentage of backend endpoints in the load balancing pool for the backend service that can be ejected if the ejection conditions are met. Defaults to 50%. + "successRateMinimumHosts": 42, # The number of backend endpoints in the load balancing pool that must have enough request volume to detect success rate outliers. If the number of backend endpoints is fewer than this setting, outlier detection via success rate statistics is not performed for any backend endpoint in the load balancing pool. Defaults to 5. Not supported when the backend service uses Serverless NEG. + "successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this backend endpoint in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that backend endpoint. Defaults to 100. Not supported when the backend service uses Serverless NEG. + "successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * successRateStdevFactor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. Not supported when the backend service uses Serverless NEG. }, "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port. "portName": "A String", # A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be [defined on each backend instance group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports). This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name. diff --git a/docs/dyn/compute_beta.regionDisks.html b/docs/dyn/compute_beta.regionDisks.html index 65fa0a1c132..d75df3547e8 100644 --- a/docs/dyn/compute_beta.regionDisks.html +++ b/docs/dyn/compute_beta.regionDisks.html @@ -384,6 +384,7 @@

Method Details

"description": "A String", # An optional description of this resource. Provide this property when you create the resource. "diskSizeGb": "A String", # [Output Only] Size of the source disk, specified in GB. "downloadBytes": "A String", # [Output Only] Number of bytes downloaded to restore a snapshot to a disk. + "enableConfidentialCompute": True or False, # Whether this snapshot is created from a confidential compute mode disk. [Output Only]: This field is not set by user, but from source disk. "guestFlush": True or False, # [Input Only] Whether to attempt an application consistent snapshot by informing the OS to prepare for the snapshot process. "guestOsFeatures": [ # [Output Only] A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. { # Guest OS features. @@ -692,6 +693,7 @@

Method Details

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. }, + "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "eraseWindowsVssSignature": True or False, # Specifies whether the disk restored from a source snapshot should erase Windows specific VSS signature. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. { # Guest OS features. @@ -925,6 +927,7 @@

Method Details

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. }, + "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "eraseWindowsVssSignature": True or False, # Specifies whether the disk restored from a source snapshot should erase Windows specific VSS signature. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. { # Guest OS features. @@ -1165,6 +1168,7 @@

Method Details

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. }, + "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "eraseWindowsVssSignature": True or False, # Specifies whether the disk restored from a source snapshot should erase Windows specific VSS signature. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. { # Guest OS features. @@ -2241,6 +2245,7 @@

Method Details

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. }, + "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "eraseWindowsVssSignature": True or False, # Specifies whether the disk restored from a source snapshot should erase Windows specific VSS signature. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. { # Guest OS features. diff --git a/docs/dyn/compute_beta.regionInstanceGroupManagers.html b/docs/dyn/compute_beta.regionInstanceGroupManagers.html index 3efc5fbf934..7b9d7de87d0 100644 --- a/docs/dyn/compute_beta.regionInstanceGroupManagers.html +++ b/docs/dyn/compute_beta.regionInstanceGroupManagers.html @@ -1592,6 +1592,7 @@

Method Details

], }, }, + "name": "A String", # [Output Only] The name of the instance. The name will always exist even if the instance has not yet been created. "preservedStateFromConfig": { # Preserved state for a given instance. # [Output Only] Preserved state applied from per-instance config for this instance. "disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks. "a_key": { diff --git a/docs/dyn/compute_beta.regionInstanceTemplates.html b/docs/dyn/compute_beta.regionInstanceTemplates.html index dc58a599752..f8e76cd2f74 100644 --- a/docs/dyn/compute_beta.regionInstanceTemplates.html +++ b/docs/dyn/compute_beta.regionInstanceTemplates.html @@ -265,6 +265,7 @@

Method Details

"diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created. "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB. "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you specify this field when creating a VM, you can provide either the full or partial URL. For example, the following values are valid: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType If you specify this field when creating or updating an instance template or all-instances configuration, specify the type of the disk, not the URL. For example: pd-standard. + "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures { # Guest OS features. "type": "A String", # The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE - SEV_SNP_CAPABLE For more information, see Enabling guest operating system features. @@ -562,6 +563,7 @@

Method Details

"diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created. "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB. "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you specify this field when creating a VM, you can provide either the full or partial URL. For example, the following values are valid: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType If you specify this field when creating or updating an instance template or all-instances configuration, specify the type of the disk, not the URL. For example: pd-standard. + "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures { # Guest OS features. "type": "A String", # The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE - SEV_SNP_CAPABLE For more information, see Enabling guest operating system features. @@ -969,6 +971,7 @@

Method Details

"diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created. "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB. "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you specify this field when creating a VM, you can provide either the full or partial URL. For example, the following values are valid: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType If you specify this field when creating or updating an instance template or all-instances configuration, specify the type of the disk, not the URL. For example: pd-standard. + "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures { # Guest OS features. "type": "A String", # The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE - SEV_SNP_CAPABLE For more information, see Enabling guest operating system features. diff --git a/docs/dyn/compute_beta.regionInstances.html b/docs/dyn/compute_beta.regionInstances.html index 2c3f90886bb..a225cde8ac4 100644 --- a/docs/dyn/compute_beta.regionInstances.html +++ b/docs/dyn/compute_beta.regionInstances.html @@ -132,6 +132,7 @@

Method Details

"diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created. "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB. "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you specify this field when creating a VM, you can provide either the full or partial URL. For example, the following values are valid: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType If you specify this field when creating or updating an instance template or all-instances configuration, specify the type of the disk, not the URL. For example: pd-standard. + "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures { # Guest OS features. "type": "A String", # The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE - SEV_SNP_CAPABLE For more information, see Enabling guest operating system features. diff --git a/docs/dyn/compute_beta.regionNetworkEndpointGroups.html b/docs/dyn/compute_beta.regionNetworkEndpointGroups.html index e4304f62e64..71f02e1bbd8 100644 --- a/docs/dyn/compute_beta.regionNetworkEndpointGroups.html +++ b/docs/dyn/compute_beta.regionNetworkEndpointGroups.html @@ -74,12 +74,18 @@

Compute Engine API . regionNetworkEndpointGroups

Instance Methods

+

+ attachNetworkEndpoints(project, region, networkEndpointGroup, body=None, requestId=None, x__xgafv=None)

+

Attach a list of network endpoints to the specified network endpoint group.

close()

Close httplib2 connections.

delete(project, region, networkEndpointGroup, requestId=None, x__xgafv=None)

Deletes the specified network endpoint group. Note that the NEG cannot be deleted if it is configured as a backend of a backend service.

+

+ detachNetworkEndpoints(project, region, networkEndpointGroup, body=None, requestId=None, x__xgafv=None)

+

Detach the network endpoint from the specified network endpoint group.

get(project, region, networkEndpointGroup, x__xgafv=None)

Returns the specified network endpoint group.

@@ -89,10 +95,140 @@

Instance Methods

list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Retrieves the list of regional network endpoint groups available to the specified project in the given region.

+

+ listNetworkEndpoints(project, region, networkEndpointGroup, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists the network endpoints in the specified network endpoint group.

+

+ listNetworkEndpoints_next()

+

Retrieves the next page of results.

list_next()

Retrieves the next page of results.

Method Details

+
+ attachNetworkEndpoints(project, region, networkEndpointGroup, body=None, requestId=None, x__xgafv=None) +
Attach a list of network endpoints to the specified network endpoint group.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, The name of the region where you want to create the network endpoint group. It should comply with RFC1035. (required)
+  networkEndpointGroup: string, The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "networkEndpoints": [ # The list of network endpoints to be attached.
+    { # The network endpoint.
+      "annotations": { # Metadata defined as annotations on the network endpoint.
+        "a_key": "A String",
+      },
+      "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT.
+      "instance": "A String", # The name for a specific VM instance that the IP address belongs to. This is required for network endpoints of type GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group. The name must be 1-63 characters long, and comply with RFC1035.
+      "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used.
+      "ipv6Address": "A String", # Optional IPv6 address of network endpoint.
+      "port": 42, # Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used.
+    },
+  ],
+}
+
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error. Keys should match /[a-zA-Z0-9-_]/ and be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
+}
+
+
close()
Close httplib2 connections.
@@ -204,6 +340,130 @@

Method Details

}
+
+ detachNetworkEndpoints(project, region, networkEndpointGroup, body=None, requestId=None, x__xgafv=None) +
Detach the network endpoint from the specified network endpoint group.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, The name of the region where the network endpoint group is located. It should comply with RFC1035. (required)
+  networkEndpointGroup: string, The name of the network endpoint group you are detaching network endpoints from. It should comply with RFC1035. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "networkEndpoints": [ # The list of network endpoints to be detached.
+    { # The network endpoint.
+      "annotations": { # Metadata defined as annotations on the network endpoint.
+        "a_key": "A String",
+      },
+      "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT.
+      "instance": "A String", # The name for a specific VM instance that the IP address belongs to. This is required for network endpoints of type GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group. The name must be 1-63 characters long, and comply with RFC1035.
+      "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used.
+      "ipv6Address": "A String", # Optional IPv6 address of network endpoint.
+      "port": 42, # Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used.
+    },
+  ],
+}
+
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error. Keys should match /[a-zA-Z0-9-_]/ and be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
+}
+
+
get(project, region, networkEndpointGroup, x__xgafv=None)
Returns the specified network endpoint group.
@@ -521,6 +781,90 @@ 

Method Details

}
+
+ listNetworkEndpoints(project, region, networkEndpointGroup, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Lists the network endpoints in the specified network endpoint group.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, The name of the region where the network endpoint group is located. It should comply with RFC1035. (required)
+  networkEndpointGroup: string, The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035. (required)
+  filter: string, A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`.
+  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+  "items": [ # A list of NetworkEndpointWithHealthStatus resources.
+    {
+      "healths": [ # [Output only] The health status of network endpoint;
+        {
+          "backendService": { # URL of the backend service associated with the health state of the network endpoint.
+            "backendService": "A String",
+          },
+          "forwardingRule": { # URL of the forwarding rule associated with the health state of the network endpoint.
+            "forwardingRule": "A String",
+          },
+          "healthCheck": { # A full or valid partial URL to a health check. For example, the following are valid URLs: - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check - projects/project-id/global/httpHealthChecks/health-check - global/httpHealthChecks/health-check # URL of the health check associated with the health state of the network endpoint.
+            "healthCheck": "A String",
+          },
+          "healthCheckService": { # A full or valid partial URL to a health check service. For example, the following are valid URLs: - https://www.googleapis.com/compute/beta/projects/project-id/regions/us-west1/healthCheckServices/health-check-service - projects/project-id/regions/us-west1/healthCheckServices/health-check-service - regions/us-west1/healthCheckServices/health-check-service # URL of the health check service associated with the health state of the network endpoint.
+            "healthCheckService": "A String",
+          },
+          "healthState": "A String", # Health state of the network endpoint determined based on the health checks configured.
+          "ipv6HealthState": "A String", # Health state of the ipv6 network endpoint determined based on the health checks configured.
+        },
+      ],
+      "networkEndpoint": { # The network endpoint. # [Output only] The network endpoint;
+        "annotations": { # Metadata defined as annotations on the network endpoint.
+          "a_key": "A String",
+        },
+        "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT.
+        "instance": "A String", # The name for a specific VM instance that the IP address belongs to. This is required for network endpoints of type GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group. The name must be 1-63 characters long, and comply with RFC1035.
+        "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used.
+        "ipv6Address": "A String", # Optional IPv6 address of network endpoint.
+        "port": 42, # Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used.
+      },
+    },
+  ],
+  "kind": "compute#networkEndpointGroupsListNetworkEndpoints", # [Output Only] The resource type, which is always compute#networkEndpointGroupsListNetworkEndpoints for the list of network endpoints in the specified network endpoint group.
+  "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+  "warning": { # [Output Only] Informational warning message.
+    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+    "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+      {
+        "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+        "value": "A String", # [Output Only] A warning data value corresponding to the key.
+      },
+    ],
+    "message": "A String", # [Output Only] A human-readable description of the warning code.
+  },
+}
+
+ +
+ listNetworkEndpoints_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+
list_next()
Retrieves the next page of results.
diff --git a/docs/dyn/compute_beta.regionSecurityPolicies.html b/docs/dyn/compute_beta.regionSecurityPolicies.html
index de5242c15c7..99c5a435eb7 100644
--- a/docs/dyn/compute_beta.regionSecurityPolicies.html
+++ b/docs/dyn/compute_beta.regionSecurityPolicies.html
@@ -510,6 +510,15 @@ 

Method Details

"layer7DdosDefenseConfig": { # Configuration options for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR. # If set to true, enables Cloud Armor Machine Learning. "enable": True or False, # If set to true, enables CAAP for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR. "ruleVisibility": "A String", # Rule visibility can be one of the following: STANDARD - opaque rules. (default) PREMIUM - transparent rules. This field is only supported in Global Security Policies of type CLOUD_ARMOR. + "thresholdConfigs": [ # Configuration options for layer7 adaptive protection for various customizable thresholds. + { + "autoDeployConfidenceThreshold": 3.14, + "autoDeployExpirationSec": 42, + "autoDeployImpactedBaselineThreshold": 3.14, + "autoDeployLoadThreshold": 3.14, + "name": "A String", # The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the security policy. + }, + ], }, }, "advancedOptionsConfig": { @@ -917,6 +926,15 @@

Method Details

"layer7DdosDefenseConfig": { # Configuration options for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR. # If set to true, enables Cloud Armor Machine Learning. "enable": True or False, # If set to true, enables CAAP for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR. "ruleVisibility": "A String", # Rule visibility can be one of the following: STANDARD - opaque rules. (default) PREMIUM - transparent rules. This field is only supported in Global Security Policies of type CLOUD_ARMOR. + "thresholdConfigs": [ # Configuration options for layer7 adaptive protection for various customizable thresholds. + { + "autoDeployConfidenceThreshold": 3.14, + "autoDeployExpirationSec": 42, + "autoDeployImpactedBaselineThreshold": 3.14, + "autoDeployLoadThreshold": 3.14, + "name": "A String", # The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the security policy. + }, + ], }, }, "advancedOptionsConfig": { @@ -1262,6 +1280,15 @@

Method Details

"layer7DdosDefenseConfig": { # Configuration options for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR. # If set to true, enables Cloud Armor Machine Learning. "enable": True or False, # If set to true, enables CAAP for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR. "ruleVisibility": "A String", # Rule visibility can be one of the following: STANDARD - opaque rules. (default) PREMIUM - transparent rules. This field is only supported in Global Security Policies of type CLOUD_ARMOR. + "thresholdConfigs": [ # Configuration options for layer7 adaptive protection for various customizable thresholds. + { + "autoDeployConfidenceThreshold": 3.14, + "autoDeployExpirationSec": 42, + "autoDeployImpactedBaselineThreshold": 3.14, + "autoDeployLoadThreshold": 3.14, + "name": "A String", # The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the security policy. + }, + ], }, }, "advancedOptionsConfig": { @@ -1525,6 +1552,15 @@

Method Details

"layer7DdosDefenseConfig": { # Configuration options for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR. # If set to true, enables Cloud Armor Machine Learning. "enable": True or False, # If set to true, enables CAAP for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR. "ruleVisibility": "A String", # Rule visibility can be one of the following: STANDARD - opaque rules. (default) PREMIUM - transparent rules. This field is only supported in Global Security Policies of type CLOUD_ARMOR. + "thresholdConfigs": [ # Configuration options for layer7 adaptive protection for various customizable thresholds. + { + "autoDeployConfidenceThreshold": 3.14, + "autoDeployExpirationSec": 42, + "autoDeployImpactedBaselineThreshold": 3.14, + "autoDeployLoadThreshold": 3.14, + "name": "A String", # The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the security policy. + }, + ], }, }, "advancedOptionsConfig": { diff --git a/docs/dyn/compute_beta.routers.html b/docs/dyn/compute_beta.routers.html index 5d43db68e31..81f9b7e42f5 100644 --- a/docs/dyn/compute_beta.routers.html +++ b/docs/dyn/compute_beta.routers.html @@ -252,9 +252,15 @@

Method Details

"sourceNatActiveIps": [ # A list of URLs of the IP resources used for this NAT rule. These IP addresses must be valid static external IP addresses assigned to the project. This field is used for public NAT. "A String", ], + "sourceNatActiveRanges": [ # A list of URLs of the subnetworks used as source ranges for this NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT. This field is used for private NAT. + "A String", + ], "sourceNatDrainIps": [ # A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT rule only. This field is used for public NAT. "A String", ], + "sourceNatDrainRanges": [ # A list of URLs of subnetworks representing source ranges to be drained. This is only supported on patch/update, and these subnetworks must have previously been used as active ranges in this NAT Rule. This field is used for private NAT. + "A String", + ], }, "description": "A String", # An optional description of this rule. "match": "A String", # CEL expression that specifies the match condition that egress traffic from a VM is evaluated against. If it evaluates to true, the corresponding `action` is enforced. The following examples are valid match expressions for public NAT: "inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/16')" "destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'" The following example is a valid match expression for private NAT: "nexthop.hub == 'https://networkconnectivity.googleapis.com/v1alpha1/projects/my-project/global/hub/hub-1'" @@ -276,6 +282,7 @@

Method Details

"tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set. "tcpTimeWaitTimeoutSec": 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state. Defaults to 120s if not set. "tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set. + "type": "A String", # Indicates whether this NAT is used for public or private IP translation. If unspecified, it defaults to PUBLIC. "udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set. }, ], @@ -563,9 +570,15 @@

Method Details

"sourceNatActiveIps": [ # A list of URLs of the IP resources used for this NAT rule. These IP addresses must be valid static external IP addresses assigned to the project. This field is used for public NAT. "A String", ], + "sourceNatActiveRanges": [ # A list of URLs of the subnetworks used as source ranges for this NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT. This field is used for private NAT. + "A String", + ], "sourceNatDrainIps": [ # A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT rule only. This field is used for public NAT. "A String", ], + "sourceNatDrainRanges": [ # A list of URLs of subnetworks representing source ranges to be drained. This is only supported on patch/update, and these subnetworks must have previously been used as active ranges in this NAT Rule. This field is used for private NAT. + "A String", + ], }, "description": "A String", # An optional description of this rule. "match": "A String", # CEL expression that specifies the match condition that egress traffic from a VM is evaluated against. If it evaluates to true, the corresponding `action` is enforced. The following examples are valid match expressions for public NAT: "inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/16')" "destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'" The following example is a valid match expression for private NAT: "nexthop.hub == 'https://networkconnectivity.googleapis.com/v1alpha1/projects/my-project/global/hub/hub-1'" @@ -587,6 +600,7 @@

Method Details

"tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set. "tcpTimeWaitTimeoutSec": 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state. Defaults to 120s if not set. "tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set. + "type": "A String", # Indicates whether this NAT is used for public or private IP translation. If unspecified, it defaults to PUBLIC. "udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set. }, ], @@ -1078,9 +1092,15 @@

Method Details

"sourceNatActiveIps": [ # A list of URLs of the IP resources used for this NAT rule. These IP addresses must be valid static external IP addresses assigned to the project. This field is used for public NAT. "A String", ], + "sourceNatActiveRanges": [ # A list of URLs of the subnetworks used as source ranges for this NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT. This field is used for private NAT. + "A String", + ], "sourceNatDrainIps": [ # A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT rule only. This field is used for public NAT. "A String", ], + "sourceNatDrainRanges": [ # A list of URLs of subnetworks representing source ranges to be drained. This is only supported on patch/update, and these subnetworks must have previously been used as active ranges in this NAT Rule. This field is used for private NAT. + "A String", + ], }, "description": "A String", # An optional description of this rule. "match": "A String", # CEL expression that specifies the match condition that egress traffic from a VM is evaluated against. If it evaluates to true, the corresponding `action` is enforced. The following examples are valid match expressions for public NAT: "inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/16')" "destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'" The following example is a valid match expression for private NAT: "nexthop.hub == 'https://networkconnectivity.googleapis.com/v1alpha1/projects/my-project/global/hub/hub-1'" @@ -1102,6 +1122,7 @@

Method Details

"tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set. "tcpTimeWaitTimeoutSec": 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state. Defaults to 120s if not set. "tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set. + "type": "A String", # Indicates whether this NAT is used for public or private IP translation. If unspecified, it defaults to PUBLIC. "udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set. }, ], @@ -1338,9 +1359,15 @@

Method Details

"sourceNatActiveIps": [ # A list of URLs of the IP resources used for this NAT rule. These IP addresses must be valid static external IP addresses assigned to the project. This field is used for public NAT. "A String", ], + "sourceNatActiveRanges": [ # A list of URLs of the subnetworks used as source ranges for this NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT. This field is used for private NAT. + "A String", + ], "sourceNatDrainIps": [ # A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT rule only. This field is used for public NAT. "A String", ], + "sourceNatDrainRanges": [ # A list of URLs of subnetworks representing source ranges to be drained. This is only supported on patch/update, and these subnetworks must have previously been used as active ranges in this NAT Rule. This field is used for private NAT. + "A String", + ], }, "description": "A String", # An optional description of this rule. "match": "A String", # CEL expression that specifies the match condition that egress traffic from a VM is evaluated against. If it evaluates to true, the corresponding `action` is enforced. The following examples are valid match expressions for public NAT: "inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/16')" "destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'" The following example is a valid match expression for private NAT: "nexthop.hub == 'https://networkconnectivity.googleapis.com/v1alpha1/projects/my-project/global/hub/hub-1'" @@ -1362,6 +1389,7 @@

Method Details

"tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set. "tcpTimeWaitTimeoutSec": 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state. Defaults to 120s if not set. "tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set. + "type": "A String", # Indicates whether this NAT is used for public or private IP translation. If unspecified, it defaults to PUBLIC. "udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set. }, ], @@ -1518,9 +1546,15 @@

Method Details

"sourceNatActiveIps": [ # A list of URLs of the IP resources used for this NAT rule. These IP addresses must be valid static external IP addresses assigned to the project. This field is used for public NAT. "A String", ], + "sourceNatActiveRanges": [ # A list of URLs of the subnetworks used as source ranges for this NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT. This field is used for private NAT. + "A String", + ], "sourceNatDrainIps": [ # A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT rule only. This field is used for public NAT. "A String", ], + "sourceNatDrainRanges": [ # A list of URLs of subnetworks representing source ranges to be drained. This is only supported on patch/update, and these subnetworks must have previously been used as active ranges in this NAT Rule. This field is used for private NAT. + "A String", + ], }, "description": "A String", # An optional description of this rule. "match": "A String", # CEL expression that specifies the match condition that egress traffic from a VM is evaluated against. If it evaluates to true, the corresponding `action` is enforced. The following examples are valid match expressions for public NAT: "inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/16')" "destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'" The following example is a valid match expression for private NAT: "nexthop.hub == 'https://networkconnectivity.googleapis.com/v1alpha1/projects/my-project/global/hub/hub-1'" @@ -1542,6 +1576,7 @@

Method Details

"tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set. "tcpTimeWaitTimeoutSec": 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state. Defaults to 120s if not set. "tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set. + "type": "A String", # Indicates whether this NAT is used for public or private IP translation. If unspecified, it defaults to PUBLIC. "udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set. }, ], @@ -1766,9 +1801,15 @@

Method Details

"sourceNatActiveIps": [ # A list of URLs of the IP resources used for this NAT rule. These IP addresses must be valid static external IP addresses assigned to the project. This field is used for public NAT. "A String", ], + "sourceNatActiveRanges": [ # A list of URLs of the subnetworks used as source ranges for this NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT. This field is used for private NAT. + "A String", + ], "sourceNatDrainIps": [ # A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT rule only. This field is used for public NAT. "A String", ], + "sourceNatDrainRanges": [ # A list of URLs of subnetworks representing source ranges to be drained. This is only supported on patch/update, and these subnetworks must have previously been used as active ranges in this NAT Rule. This field is used for private NAT. + "A String", + ], }, "description": "A String", # An optional description of this rule. "match": "A String", # CEL expression that specifies the match condition that egress traffic from a VM is evaluated against. If it evaluates to true, the corresponding `action` is enforced. The following examples are valid match expressions for public NAT: "inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/16')" "destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'" The following example is a valid match expression for private NAT: "nexthop.hub == 'https://networkconnectivity.googleapis.com/v1alpha1/projects/my-project/global/hub/hub-1'" @@ -1790,6 +1831,7 @@

Method Details

"tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set. "tcpTimeWaitTimeoutSec": 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state. Defaults to 120s if not set. "tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set. + "type": "A String", # Indicates whether this NAT is used for public or private IP translation. If unspecified, it defaults to PUBLIC. "udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set. }, ], @@ -1914,9 +1956,15 @@

Method Details

"sourceNatActiveIps": [ # A list of URLs of the IP resources used for this NAT rule. These IP addresses must be valid static external IP addresses assigned to the project. This field is used for public NAT. "A String", ], + "sourceNatActiveRanges": [ # A list of URLs of the subnetworks used as source ranges for this NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT. This field is used for private NAT. + "A String", + ], "sourceNatDrainIps": [ # A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT rule only. This field is used for public NAT. "A String", ], + "sourceNatDrainRanges": [ # A list of URLs of subnetworks representing source ranges to be drained. This is only supported on patch/update, and these subnetworks must have previously been used as active ranges in this NAT Rule. This field is used for private NAT. + "A String", + ], }, "description": "A String", # An optional description of this rule. "match": "A String", # CEL expression that specifies the match condition that egress traffic from a VM is evaluated against. If it evaluates to true, the corresponding `action` is enforced. The following examples are valid match expressions for public NAT: "inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/16')" "destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'" The following example is a valid match expression for private NAT: "nexthop.hub == 'https://networkconnectivity.googleapis.com/v1alpha1/projects/my-project/global/hub/hub-1'" @@ -1938,6 +1986,7 @@

Method Details

"tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set. "tcpTimeWaitTimeoutSec": 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state. Defaults to 120s if not set. "tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set. + "type": "A String", # Indicates whether this NAT is used for public or private IP translation. If unspecified, it defaults to PUBLIC. "udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set. }, ], @@ -2098,9 +2147,15 @@

Method Details

"sourceNatActiveIps": [ # A list of URLs of the IP resources used for this NAT rule. These IP addresses must be valid static external IP addresses assigned to the project. This field is used for public NAT. "A String", ], + "sourceNatActiveRanges": [ # A list of URLs of the subnetworks used as source ranges for this NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT. This field is used for private NAT. + "A String", + ], "sourceNatDrainIps": [ # A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT rule only. This field is used for public NAT. "A String", ], + "sourceNatDrainRanges": [ # A list of URLs of subnetworks representing source ranges to be drained. This is only supported on patch/update, and these subnetworks must have previously been used as active ranges in this NAT Rule. This field is used for private NAT. + "A String", + ], }, "description": "A String", # An optional description of this rule. "match": "A String", # CEL expression that specifies the match condition that egress traffic from a VM is evaluated against. If it evaluates to true, the corresponding `action` is enforced. The following examples are valid match expressions for public NAT: "inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/16')" "destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'" The following example is a valid match expression for private NAT: "nexthop.hub == 'https://networkconnectivity.googleapis.com/v1alpha1/projects/my-project/global/hub/hub-1'" @@ -2122,6 +2177,7 @@

Method Details

"tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set. "tcpTimeWaitTimeoutSec": 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state. Defaults to 120s if not set. "tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set. + "type": "A String", # Indicates whether this NAT is used for public or private IP translation. If unspecified, it defaults to PUBLIC. "udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set. }, ], diff --git a/docs/dyn/compute_beta.securityPolicies.html b/docs/dyn/compute_beta.securityPolicies.html index e8938ccfa35..aa0104b0f14 100644 --- a/docs/dyn/compute_beta.securityPolicies.html +++ b/docs/dyn/compute_beta.securityPolicies.html @@ -423,6 +423,15 @@

Method Details

"layer7DdosDefenseConfig": { # Configuration options for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR. # If set to true, enables Cloud Armor Machine Learning. "enable": True or False, # If set to true, enables CAAP for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR. "ruleVisibility": "A String", # Rule visibility can be one of the following: STANDARD - opaque rules. (default) PREMIUM - transparent rules. This field is only supported in Global Security Policies of type CLOUD_ARMOR. + "thresholdConfigs": [ # Configuration options for layer7 adaptive protection for various customizable thresholds. + { + "autoDeployConfidenceThreshold": 3.14, + "autoDeployExpirationSec": 42, + "autoDeployImpactedBaselineThreshold": 3.14, + "autoDeployLoadThreshold": 3.14, + "name": "A String", # The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the security policy. + }, + ], }, }, "advancedOptionsConfig": { @@ -816,6 +825,15 @@

Method Details

"layer7DdosDefenseConfig": { # Configuration options for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR. # If set to true, enables Cloud Armor Machine Learning. "enable": True or False, # If set to true, enables CAAP for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR. "ruleVisibility": "A String", # Rule visibility can be one of the following: STANDARD - opaque rules. (default) PREMIUM - transparent rules. This field is only supported in Global Security Policies of type CLOUD_ARMOR. + "thresholdConfigs": [ # Configuration options for layer7 adaptive protection for various customizable thresholds. + { + "autoDeployConfidenceThreshold": 3.14, + "autoDeployExpirationSec": 42, + "autoDeployImpactedBaselineThreshold": 3.14, + "autoDeployLoadThreshold": 3.14, + "name": "A String", # The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the security policy. + }, + ], }, }, "advancedOptionsConfig": { @@ -1221,6 +1239,15 @@

Method Details

"layer7DdosDefenseConfig": { # Configuration options for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR. # If set to true, enables Cloud Armor Machine Learning. "enable": True or False, # If set to true, enables CAAP for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR. "ruleVisibility": "A String", # Rule visibility can be one of the following: STANDARD - opaque rules. (default) PREMIUM - transparent rules. This field is only supported in Global Security Policies of type CLOUD_ARMOR. + "thresholdConfigs": [ # Configuration options for layer7 adaptive protection for various customizable thresholds. + { + "autoDeployConfidenceThreshold": 3.14, + "autoDeployExpirationSec": 42, + "autoDeployImpactedBaselineThreshold": 3.14, + "autoDeployLoadThreshold": 3.14, + "name": "A String", # The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the security policy. + }, + ], }, }, "advancedOptionsConfig": { @@ -1565,6 +1592,15 @@

Method Details

"layer7DdosDefenseConfig": { # Configuration options for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR. # If set to true, enables Cloud Armor Machine Learning. "enable": True or False, # If set to true, enables CAAP for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR. "ruleVisibility": "A String", # Rule visibility can be one of the following: STANDARD - opaque rules. (default) PREMIUM - transparent rules. This field is only supported in Global Security Policies of type CLOUD_ARMOR. + "thresholdConfigs": [ # Configuration options for layer7 adaptive protection for various customizable thresholds. + { + "autoDeployConfidenceThreshold": 3.14, + "autoDeployExpirationSec": 42, + "autoDeployImpactedBaselineThreshold": 3.14, + "autoDeployLoadThreshold": 3.14, + "name": "A String", # The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the security policy. + }, + ], }, }, "advancedOptionsConfig": { @@ -1868,6 +1904,15 @@

Method Details

"layer7DdosDefenseConfig": { # Configuration options for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR. # If set to true, enables Cloud Armor Machine Learning. "enable": True or False, # If set to true, enables CAAP for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR. "ruleVisibility": "A String", # Rule visibility can be one of the following: STANDARD - opaque rules. (default) PREMIUM - transparent rules. This field is only supported in Global Security Policies of type CLOUD_ARMOR. + "thresholdConfigs": [ # Configuration options for layer7 adaptive protection for various customizable thresholds. + { + "autoDeployConfidenceThreshold": 3.14, + "autoDeployExpirationSec": 42, + "autoDeployImpactedBaselineThreshold": 3.14, + "autoDeployLoadThreshold": 3.14, + "name": "A String", # The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the security policy. + }, + ], }, }, "advancedOptionsConfig": { diff --git a/docs/dyn/compute_beta.snapshots.html b/docs/dyn/compute_beta.snapshots.html index bc1df89b05d..ebc645fb118 100644 --- a/docs/dyn/compute_beta.snapshots.html +++ b/docs/dyn/compute_beta.snapshots.html @@ -239,6 +239,7 @@

Method Details

"description": "A String", # An optional description of this resource. Provide this property when you create the resource. "diskSizeGb": "A String", # [Output Only] Size of the source disk, specified in GB. "downloadBytes": "A String", # [Output Only] Number of bytes downloaded to restore a snapshot to a disk. + "enableConfidentialCompute": True or False, # Whether this snapshot is created from a confidential compute mode disk. [Output Only]: This field is not set by user, but from source disk. "guestFlush": True or False, # [Input Only] Whether to attempt an application consistent snapshot by informing the OS to prepare for the snapshot process. "guestOsFeatures": [ # [Output Only] A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. { # Guest OS features. @@ -422,6 +423,7 @@

Method Details

"description": "A String", # An optional description of this resource. Provide this property when you create the resource. "diskSizeGb": "A String", # [Output Only] Size of the source disk, specified in GB. "downloadBytes": "A String", # [Output Only] Number of bytes downloaded to restore a snapshot to a disk. + "enableConfidentialCompute": True or False, # Whether this snapshot is created from a confidential compute mode disk. [Output Only]: This field is not set by user, but from source disk. "guestFlush": True or False, # [Input Only] Whether to attempt an application consistent snapshot by informing the OS to prepare for the snapshot process. "guestOsFeatures": [ # [Output Only] A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. { # Guest OS features. @@ -612,6 +614,7 @@

Method Details

"description": "A String", # An optional description of this resource. Provide this property when you create the resource. "diskSizeGb": "A String", # [Output Only] Size of the source disk, specified in GB. "downloadBytes": "A String", # [Output Only] Number of bytes downloaded to restore a snapshot to a disk. + "enableConfidentialCompute": True or False, # Whether this snapshot is created from a confidential compute mode disk. [Output Only]: This field is not set by user, but from source disk. "guestFlush": True or False, # [Input Only] Whether to attempt an application consistent snapshot by informing the OS to prepare for the snapshot process. "guestOsFeatures": [ # [Output Only] A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. { # Guest OS features. diff --git a/docs/dyn/compute_v1.backendServices.html b/docs/dyn/compute_v1.backendServices.html index a8fd5dbb8d8..bcbb494947b 100644 --- a/docs/dyn/compute_v1.backendServices.html +++ b/docs/dyn/compute_v1.backendServices.html @@ -398,24 +398,24 @@

Method Details

}, "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL. - "outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. If not set, this feature is considered disabled. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, HTTP2, or GRPC, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. - "baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s. + "outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service. If not set, this feature is considered disabled. Results of the outlier detection algorithm (ejection of endpoints from the load balancing pool and returning them back to the pool) are executed independently by each proxy instance of the load balancer. In most cases, more than one proxy instance handles the traffic received by a backend service. Thus, it is possible that an unhealthy endpoint is detected and ejected by only some of the proxies, and while this happens, other proxies may continue to send requests to the same unhealthy endpoint until they detect and eject the unhealthy endpoint. Applicable backend endpoints can be: - VM instances in an Instance Group - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT) - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT) - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud Functions Services - Private Service Connect NEGs, that resolve to Google-managed regional API endpoints or managed services published using Private Service Connect Applicable backend service types can be: - A global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. - A regional backend service with the serviceProtocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not supported for Serverless NEGs. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. + "baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a backend endpoint is ejected for. Defaults to 30000ms or 30s. After a backend endpoint is returned back to the load balancing pool, it can be ejected again in another ejection analysis. Thus, the total ejection time is equal to the base ejection time multiplied by the number of times the backend endpoint has been ejected. Defaults to 30000ms or 30s. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "consecutiveErrors": 42, # Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingConsecutiveErrors": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingSuccessRate": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. - "interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second. + "consecutiveErrors": 42, # Number of consecutive errors before a backend endpoint is ejected from the load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. + "consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. + "enforcingConsecutiveErrors": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. + "enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. + "enforcingSuccessRate": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service uses Serverless NEG. + "interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections and backend endpoints being returned to service. The interval is equal to the number of seconds as defined in outlierDetection.interval.seconds plus the number of nanoseconds as defined in outlierDetection.interval.nanos. Defaults to 1 second. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxEjectionPercent": 42, # Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%. - "successRateMinimumHosts": 42, # The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5. - "successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100. - "successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. + "maxEjectionPercent": 42, # Maximum percentage of backend endpoints in the load balancing pool for the backend service that can be ejected if the ejection conditions are met. Defaults to 50%. + "successRateMinimumHosts": 42, # The number of backend endpoints in the load balancing pool that must have enough request volume to detect success rate outliers. If the number of backend endpoints is fewer than this setting, outlier detection via success rate statistics is not performed for any backend endpoint in the load balancing pool. Defaults to 5. Not supported when the backend service uses Serverless NEG. + "successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this backend endpoint in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that backend endpoint. Defaults to 100. Not supported when the backend service uses Serverless NEG. + "successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * successRateStdevFactor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. Not supported when the backend service uses Serverless NEG. }, "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port. "portName": "A String", # A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be [defined on each backend instance group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports). This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name. @@ -838,24 +838,24 @@

Method Details

}, "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL. - "outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. If not set, this feature is considered disabled. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, HTTP2, or GRPC, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. - "baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s. + "outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service. If not set, this feature is considered disabled. Results of the outlier detection algorithm (ejection of endpoints from the load balancing pool and returning them back to the pool) are executed independently by each proxy instance of the load balancer. In most cases, more than one proxy instance handles the traffic received by a backend service. Thus, it is possible that an unhealthy endpoint is detected and ejected by only some of the proxies, and while this happens, other proxies may continue to send requests to the same unhealthy endpoint until they detect and eject the unhealthy endpoint. Applicable backend endpoints can be: - VM instances in an Instance Group - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT) - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT) - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud Functions Services - Private Service Connect NEGs, that resolve to Google-managed regional API endpoints or managed services published using Private Service Connect Applicable backend service types can be: - A global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. - A regional backend service with the serviceProtocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not supported for Serverless NEGs. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. + "baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a backend endpoint is ejected for. Defaults to 30000ms or 30s. After a backend endpoint is returned back to the load balancing pool, it can be ejected again in another ejection analysis. Thus, the total ejection time is equal to the base ejection time multiplied by the number of times the backend endpoint has been ejected. Defaults to 30000ms or 30s. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "consecutiveErrors": 42, # Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingConsecutiveErrors": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingSuccessRate": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. - "interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second. + "consecutiveErrors": 42, # Number of consecutive errors before a backend endpoint is ejected from the load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. + "consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. + "enforcingConsecutiveErrors": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. + "enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. + "enforcingSuccessRate": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service uses Serverless NEG. + "interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections and backend endpoints being returned to service. The interval is equal to the number of seconds as defined in outlierDetection.interval.seconds plus the number of nanoseconds as defined in outlierDetection.interval.nanos. Defaults to 1 second. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxEjectionPercent": 42, # Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%. - "successRateMinimumHosts": 42, # The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5. - "successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100. - "successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. + "maxEjectionPercent": 42, # Maximum percentage of backend endpoints in the load balancing pool for the backend service that can be ejected if the ejection conditions are met. Defaults to 50%. + "successRateMinimumHosts": 42, # The number of backend endpoints in the load balancing pool that must have enough request volume to detect success rate outliers. If the number of backend endpoints is fewer than this setting, outlier detection via success rate statistics is not performed for any backend endpoint in the load balancing pool. Defaults to 5. Not supported when the backend service uses Serverless NEG. + "successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this backend endpoint in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that backend endpoint. Defaults to 100. Not supported when the backend service uses Serverless NEG. + "successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * successRateStdevFactor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. Not supported when the backend service uses Serverless NEG. }, "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port. "portName": "A String", # A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be [defined on each backend instance group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports). This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name. @@ -1182,24 +1182,24 @@

Method Details

}, "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL. - "outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. If not set, this feature is considered disabled. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, HTTP2, or GRPC, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. - "baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s. + "outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service. If not set, this feature is considered disabled. Results of the outlier detection algorithm (ejection of endpoints from the load balancing pool and returning them back to the pool) are executed independently by each proxy instance of the load balancer. In most cases, more than one proxy instance handles the traffic received by a backend service. Thus, it is possible that an unhealthy endpoint is detected and ejected by only some of the proxies, and while this happens, other proxies may continue to send requests to the same unhealthy endpoint until they detect and eject the unhealthy endpoint. Applicable backend endpoints can be: - VM instances in an Instance Group - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT) - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT) - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud Functions Services - Private Service Connect NEGs, that resolve to Google-managed regional API endpoints or managed services published using Private Service Connect Applicable backend service types can be: - A global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. - A regional backend service with the serviceProtocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not supported for Serverless NEGs. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. + "baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a backend endpoint is ejected for. Defaults to 30000ms or 30s. After a backend endpoint is returned back to the load balancing pool, it can be ejected again in another ejection analysis. Thus, the total ejection time is equal to the base ejection time multiplied by the number of times the backend endpoint has been ejected. Defaults to 30000ms or 30s. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "consecutiveErrors": 42, # Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingConsecutiveErrors": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingSuccessRate": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. - "interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second. + "consecutiveErrors": 42, # Number of consecutive errors before a backend endpoint is ejected from the load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. + "consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. + "enforcingConsecutiveErrors": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. + "enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. + "enforcingSuccessRate": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service uses Serverless NEG. + "interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections and backend endpoints being returned to service. The interval is equal to the number of seconds as defined in outlierDetection.interval.seconds plus the number of nanoseconds as defined in outlierDetection.interval.nanos. Defaults to 1 second. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxEjectionPercent": 42, # Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%. - "successRateMinimumHosts": 42, # The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5. - "successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100. - "successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. + "maxEjectionPercent": 42, # Maximum percentage of backend endpoints in the load balancing pool for the backend service that can be ejected if the ejection conditions are met. Defaults to 50%. + "successRateMinimumHosts": 42, # The number of backend endpoints in the load balancing pool that must have enough request volume to detect success rate outliers. If the number of backend endpoints is fewer than this setting, outlier detection via success rate statistics is not performed for any backend endpoint in the load balancing pool. Defaults to 5. Not supported when the backend service uses Serverless NEG. + "successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this backend endpoint in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that backend endpoint. Defaults to 100. Not supported when the backend service uses Serverless NEG. + "successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * successRateStdevFactor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. Not supported when the backend service uses Serverless NEG. }, "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port. "portName": "A String", # A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be [defined on each backend instance group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports). This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name. @@ -1477,24 +1477,24 @@

Method Details

}, "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL. - "outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. If not set, this feature is considered disabled. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, HTTP2, or GRPC, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. - "baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s. + "outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service. If not set, this feature is considered disabled. Results of the outlier detection algorithm (ejection of endpoints from the load balancing pool and returning them back to the pool) are executed independently by each proxy instance of the load balancer. In most cases, more than one proxy instance handles the traffic received by a backend service. Thus, it is possible that an unhealthy endpoint is detected and ejected by only some of the proxies, and while this happens, other proxies may continue to send requests to the same unhealthy endpoint until they detect and eject the unhealthy endpoint. Applicable backend endpoints can be: - VM instances in an Instance Group - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT) - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT) - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud Functions Services - Private Service Connect NEGs, that resolve to Google-managed regional API endpoints or managed services published using Private Service Connect Applicable backend service types can be: - A global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. - A regional backend service with the serviceProtocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not supported for Serverless NEGs. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. + "baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a backend endpoint is ejected for. Defaults to 30000ms or 30s. After a backend endpoint is returned back to the load balancing pool, it can be ejected again in another ejection analysis. Thus, the total ejection time is equal to the base ejection time multiplied by the number of times the backend endpoint has been ejected. Defaults to 30000ms or 30s. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "consecutiveErrors": 42, # Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingConsecutiveErrors": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingSuccessRate": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. - "interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second. + "consecutiveErrors": 42, # Number of consecutive errors before a backend endpoint is ejected from the load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. + "consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. + "enforcingConsecutiveErrors": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. + "enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. + "enforcingSuccessRate": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service uses Serverless NEG. + "interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections and backend endpoints being returned to service. The interval is equal to the number of seconds as defined in outlierDetection.interval.seconds plus the number of nanoseconds as defined in outlierDetection.interval.nanos. Defaults to 1 second. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxEjectionPercent": 42, # Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%. - "successRateMinimumHosts": 42, # The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5. - "successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100. - "successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. + "maxEjectionPercent": 42, # Maximum percentage of backend endpoints in the load balancing pool for the backend service that can be ejected if the ejection conditions are met. Defaults to 50%. + "successRateMinimumHosts": 42, # The number of backend endpoints in the load balancing pool that must have enough request volume to detect success rate outliers. If the number of backend endpoints is fewer than this setting, outlier detection via success rate statistics is not performed for any backend endpoint in the load balancing pool. Defaults to 5. Not supported when the backend service uses Serverless NEG. + "successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this backend endpoint in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that backend endpoint. Defaults to 100. Not supported when the backend service uses Serverless NEG. + "successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * successRateStdevFactor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. Not supported when the backend service uses Serverless NEG. }, "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port. "portName": "A String", # A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be [defined on each backend instance group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports). This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name. @@ -1703,24 +1703,24 @@

Method Details

}, "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL. - "outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. If not set, this feature is considered disabled. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, HTTP2, or GRPC, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. - "baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s. + "outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service. If not set, this feature is considered disabled. Results of the outlier detection algorithm (ejection of endpoints from the load balancing pool and returning them back to the pool) are executed independently by each proxy instance of the load balancer. In most cases, more than one proxy instance handles the traffic received by a backend service. Thus, it is possible that an unhealthy endpoint is detected and ejected by only some of the proxies, and while this happens, other proxies may continue to send requests to the same unhealthy endpoint until they detect and eject the unhealthy endpoint. Applicable backend endpoints can be: - VM instances in an Instance Group - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT) - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT) - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud Functions Services - Private Service Connect NEGs, that resolve to Google-managed regional API endpoints or managed services published using Private Service Connect Applicable backend service types can be: - A global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. - A regional backend service with the serviceProtocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not supported for Serverless NEGs. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. + "baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a backend endpoint is ejected for. Defaults to 30000ms or 30s. After a backend endpoint is returned back to the load balancing pool, it can be ejected again in another ejection analysis. Thus, the total ejection time is equal to the base ejection time multiplied by the number of times the backend endpoint has been ejected. Defaults to 30000ms or 30s. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "consecutiveErrors": 42, # Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingConsecutiveErrors": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingSuccessRate": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. - "interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second. + "consecutiveErrors": 42, # Number of consecutive errors before a backend endpoint is ejected from the load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. + "consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. + "enforcingConsecutiveErrors": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. + "enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. + "enforcingSuccessRate": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service uses Serverless NEG. + "interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections and backend endpoints being returned to service. The interval is equal to the number of seconds as defined in outlierDetection.interval.seconds plus the number of nanoseconds as defined in outlierDetection.interval.nanos. Defaults to 1 second. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxEjectionPercent": 42, # Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%. - "successRateMinimumHosts": 42, # The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5. - "successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100. - "successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. + "maxEjectionPercent": 42, # Maximum percentage of backend endpoints in the load balancing pool for the backend service that can be ejected if the ejection conditions are met. Defaults to 50%. + "successRateMinimumHosts": 42, # The number of backend endpoints in the load balancing pool that must have enough request volume to detect success rate outliers. If the number of backend endpoints is fewer than this setting, outlier detection via success rate statistics is not performed for any backend endpoint in the load balancing pool. Defaults to 5. Not supported when the backend service uses Serverless NEG. + "successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this backend endpoint in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that backend endpoint. Defaults to 100. Not supported when the backend service uses Serverless NEG. + "successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * successRateStdevFactor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. Not supported when the backend service uses Serverless NEG. }, "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port. "portName": "A String", # A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be [defined on each backend instance group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports). This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name. @@ -2397,24 +2397,24 @@

Method Details

}, "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL. - "outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. If not set, this feature is considered disabled. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, HTTP2, or GRPC, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. - "baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s. + "outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service. If not set, this feature is considered disabled. Results of the outlier detection algorithm (ejection of endpoints from the load balancing pool and returning them back to the pool) are executed independently by each proxy instance of the load balancer. In most cases, more than one proxy instance handles the traffic received by a backend service. Thus, it is possible that an unhealthy endpoint is detected and ejected by only some of the proxies, and while this happens, other proxies may continue to send requests to the same unhealthy endpoint until they detect and eject the unhealthy endpoint. Applicable backend endpoints can be: - VM instances in an Instance Group - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT) - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT) - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud Functions Services - Private Service Connect NEGs, that resolve to Google-managed regional API endpoints or managed services published using Private Service Connect Applicable backend service types can be: - A global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. - A regional backend service with the serviceProtocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not supported for Serverless NEGs. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. + "baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a backend endpoint is ejected for. Defaults to 30000ms or 30s. After a backend endpoint is returned back to the load balancing pool, it can be ejected again in another ejection analysis. Thus, the total ejection time is equal to the base ejection time multiplied by the number of times the backend endpoint has been ejected. Defaults to 30000ms or 30s. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "consecutiveErrors": 42, # Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingConsecutiveErrors": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingSuccessRate": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. - "interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second. + "consecutiveErrors": 42, # Number of consecutive errors before a backend endpoint is ejected from the load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. + "consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. + "enforcingConsecutiveErrors": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. + "enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. + "enforcingSuccessRate": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service uses Serverless NEG. + "interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections and backend endpoints being returned to service. The interval is equal to the number of seconds as defined in outlierDetection.interval.seconds plus the number of nanoseconds as defined in outlierDetection.interval.nanos. Defaults to 1 second. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxEjectionPercent": 42, # Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%. - "successRateMinimumHosts": 42, # The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5. - "successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100. - "successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. + "maxEjectionPercent": 42, # Maximum percentage of backend endpoints in the load balancing pool for the backend service that can be ejected if the ejection conditions are met. Defaults to 50%. + "successRateMinimumHosts": 42, # The number of backend endpoints in the load balancing pool that must have enough request volume to detect success rate outliers. If the number of backend endpoints is fewer than this setting, outlier detection via success rate statistics is not performed for any backend endpoint in the load balancing pool. Defaults to 5. Not supported when the backend service uses Serverless NEG. + "successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this backend endpoint in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that backend endpoint. Defaults to 100. Not supported when the backend service uses Serverless NEG. + "successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * successRateStdevFactor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. Not supported when the backend service uses Serverless NEG. }, "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port. "portName": "A String", # A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be [defined on each backend instance group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports). This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name. diff --git a/docs/dyn/compute_v1.instanceGroupManagers.html b/docs/dyn/compute_v1.instanceGroupManagers.html index 14f61ac553a..a227c863d28 100644 --- a/docs/dyn/compute_v1.instanceGroupManagers.html +++ b/docs/dyn/compute_v1.instanceGroupManagers.html @@ -318,6 +318,9 @@

Method Details

"fingerprint": "A String", # Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager. "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier. "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource. + "instanceLifecyclePolicy": { # The repair policy for this managed instance group. + "forceUpdateOnRepair": "A String", # A bit indicating whether to forcefully apply the group's latest configuration when repairing a VM. Valid options are: - NO (default): If configuration updates are available, they are not forcefully applied during repair. Instead, configuration updates are applied according to the group's update policy. - YES: If configuration updates are available, they are applied during repair. + }, "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. "listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for this managed instance group. @@ -1018,6 +1021,9 @@

Method Details

"fingerprint": "A String", # Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager. "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier. "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource. + "instanceLifecyclePolicy": { # The repair policy for this managed instance group. + "forceUpdateOnRepair": "A String", # A bit indicating whether to forcefully apply the group's latest configuration when repairing a VM. Valid options are: - NO (default): If configuration updates are available, they are not forcefully applied during repair. Instead, configuration updates are applied according to the group's update policy. - YES: If configuration updates are available, they are applied during repair. + }, "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. "listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for this managed instance group. @@ -1134,6 +1140,9 @@

Method Details

"fingerprint": "A String", # Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager. "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier. "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource. + "instanceLifecyclePolicy": { # The repair policy for this managed instance group. + "forceUpdateOnRepair": "A String", # A bit indicating whether to forcefully apply the group's latest configuration when repairing a VM. Valid options are: - NO (default): If configuration updates are available, they are not forcefully applied during repair. Instead, configuration updates are applied according to the group's update policy. - YES: If configuration updates are available, they are applied during repair. + }, "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. "listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for this managed instance group. @@ -1349,6 +1358,9 @@

Method Details

"fingerprint": "A String", # Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager. "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier. "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource. + "instanceLifecyclePolicy": { # The repair policy for this managed instance group. + "forceUpdateOnRepair": "A String", # A bit indicating whether to forcefully apply the group's latest configuration when repairing a VM. Valid options are: - NO (default): If configuration updates are available, they are not forcefully applied during repair. Instead, configuration updates are applied according to the group's update policy. - YES: If configuration updates are available, they are applied during repair. + }, "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. "listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for this managed instance group. @@ -1745,6 +1757,9 @@

Method Details

"fingerprint": "A String", # Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager. "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier. "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource. + "instanceLifecyclePolicy": { # The repair policy for this managed instance group. + "forceUpdateOnRepair": "A String", # A bit indicating whether to forcefully apply the group's latest configuration when repairing a VM. Valid options are: - NO (default): If configuration updates are available, they are not forcefully applied during repair. Instead, configuration updates are applied according to the group's update policy. - YES: If configuration updates are available, they are applied during repair. + }, "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. "listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for this managed instance group. diff --git a/docs/dyn/compute_v1.interconnects.html b/docs/dyn/compute_v1.interconnects.html index 65fd97ce066..3fa62e4acec 100644 --- a/docs/dyn/compute_v1.interconnects.html +++ b/docs/dyn/compute_v1.interconnects.html @@ -285,7 +285,7 @@

Method Details

An object of the form: { # Response for the InterconnectsGetDiagnosticsRequest. - "result": { # Diagnostics information about interconnect, contains detailed and current technical information about Google's side of the connection. + "result": { # Diagnostics information about the Interconnect connection, which contains detailed and current technical information about Google's side of the connection. "arpCaches": [ # A list of InterconnectDiagnostics.ARPEntry objects, describing individual neighbors currently seen by the Google router in the ARP cache for the Interconnect. This will be empty when the Interconnect is not bundled. { # Describing the ARP neighbor entries seen on this link "ipAddress": "A String", # The IP address of this ARP neighbor. diff --git a/docs/dyn/compute_v1.projects.html b/docs/dyn/compute_v1.projects.html index 99bdce2082e..51cf55fb1a4 100644 --- a/docs/dyn/compute_v1.projects.html +++ b/docs/dyn/compute_v1.projects.html @@ -112,7 +112,7 @@

Instance Methods

Moves a persistent disk from one zone to another.

moveInstance(project, body=None, requestId=None, x__xgafv=None)

-

Moves an instance and its attached persistent disks from one zone to another. *Note*: Moving VMs or disks by using this method might cause unexpected behavior. For more information, see the [known issue](/compute/docs/troubleshooting/known-issues#moving_vms_or_disks_using_the_moveinstance_api_or_the_causes_unexpected_behavior).

+

Moves an instance and its attached persistent disks from one zone to another. *Note*: Moving VMs or disks by using this method might cause unexpected behavior. For more information, see the [known issue](/compute/docs/troubleshooting/known-issues#moving_vms_or_disks_using_the_moveinstance_api_or_the_causes_unexpected_behavior). [Deprecated] This method is deprecated. See [moving instance across zones](/compute/docs/instances/moving-instance-across-zones) instead.

setCommonInstanceMetadata(project, body=None, requestId=None, x__xgafv=None)

Sets metadata common to all instances within the specified project using the data included in the request.

@@ -871,7 +871,7 @@

Method Details

moveInstance(project, body=None, requestId=None, x__xgafv=None) -
Moves an instance and its attached persistent disks from one zone to another. *Note*: Moving VMs or disks by using this method might cause unexpected behavior. For more information, see the [known issue](/compute/docs/troubleshooting/known-issues#moving_vms_or_disks_using_the_moveinstance_api_or_the_causes_unexpected_behavior).
+  
Moves an instance and its attached persistent disks from one zone to another. *Note*: Moving VMs or disks by using this method might cause unexpected behavior. For more information, see the [known issue](/compute/docs/troubleshooting/known-issues#moving_vms_or_disks_using_the_moveinstance_api_or_the_causes_unexpected_behavior). [Deprecated] This method is deprecated. See [moving instance across zones](/compute/docs/instances/moving-instance-across-zones) instead.
 
 Args:
   project: string, Project ID for this request. (required)
diff --git a/docs/dyn/compute_v1.regionBackendServices.html b/docs/dyn/compute_v1.regionBackendServices.html
index b45b4fb6937..ab683a11894 100644
--- a/docs/dyn/compute_v1.regionBackendServices.html
+++ b/docs/dyn/compute_v1.regionBackendServices.html
@@ -369,24 +369,24 @@ 

Method Details

}, "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL. - "outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. If not set, this feature is considered disabled. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, HTTP2, or GRPC, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. - "baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s. + "outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service. If not set, this feature is considered disabled. Results of the outlier detection algorithm (ejection of endpoints from the load balancing pool and returning them back to the pool) are executed independently by each proxy instance of the load balancer. In most cases, more than one proxy instance handles the traffic received by a backend service. Thus, it is possible that an unhealthy endpoint is detected and ejected by only some of the proxies, and while this happens, other proxies may continue to send requests to the same unhealthy endpoint until they detect and eject the unhealthy endpoint. Applicable backend endpoints can be: - VM instances in an Instance Group - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT) - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT) - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud Functions Services - Private Service Connect NEGs, that resolve to Google-managed regional API endpoints or managed services published using Private Service Connect Applicable backend service types can be: - A global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. - A regional backend service with the serviceProtocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not supported for Serverless NEGs. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. + "baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a backend endpoint is ejected for. Defaults to 30000ms or 30s. After a backend endpoint is returned back to the load balancing pool, it can be ejected again in another ejection analysis. Thus, the total ejection time is equal to the base ejection time multiplied by the number of times the backend endpoint has been ejected. Defaults to 30000ms or 30s. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "consecutiveErrors": 42, # Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingConsecutiveErrors": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingSuccessRate": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. - "interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second. + "consecutiveErrors": 42, # Number of consecutive errors before a backend endpoint is ejected from the load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. + "consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. + "enforcingConsecutiveErrors": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. + "enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. + "enforcingSuccessRate": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service uses Serverless NEG. + "interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections and backend endpoints being returned to service. The interval is equal to the number of seconds as defined in outlierDetection.interval.seconds plus the number of nanoseconds as defined in outlierDetection.interval.nanos. Defaults to 1 second. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxEjectionPercent": 42, # Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%. - "successRateMinimumHosts": 42, # The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5. - "successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100. - "successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. + "maxEjectionPercent": 42, # Maximum percentage of backend endpoints in the load balancing pool for the backend service that can be ejected if the ejection conditions are met. Defaults to 50%. + "successRateMinimumHosts": 42, # The number of backend endpoints in the load balancing pool that must have enough request volume to detect success rate outliers. If the number of backend endpoints is fewer than this setting, outlier detection via success rate statistics is not performed for any backend endpoint in the load balancing pool. Defaults to 5. Not supported when the backend service uses Serverless NEG. + "successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this backend endpoint in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that backend endpoint. Defaults to 100. Not supported when the backend service uses Serverless NEG. + "successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * successRateStdevFactor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. Not supported when the backend service uses Serverless NEG. }, "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port. "portName": "A String", # A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be [defined on each backend instance group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports). This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name. @@ -716,24 +716,24 @@

Method Details

}, "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL. - "outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. If not set, this feature is considered disabled. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, HTTP2, or GRPC, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. - "baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s. + "outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service. If not set, this feature is considered disabled. Results of the outlier detection algorithm (ejection of endpoints from the load balancing pool and returning them back to the pool) are executed independently by each proxy instance of the load balancer. In most cases, more than one proxy instance handles the traffic received by a backend service. Thus, it is possible that an unhealthy endpoint is detected and ejected by only some of the proxies, and while this happens, other proxies may continue to send requests to the same unhealthy endpoint until they detect and eject the unhealthy endpoint. Applicable backend endpoints can be: - VM instances in an Instance Group - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT) - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT) - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud Functions Services - Private Service Connect NEGs, that resolve to Google-managed regional API endpoints or managed services published using Private Service Connect Applicable backend service types can be: - A global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. - A regional backend service with the serviceProtocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not supported for Serverless NEGs. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. + "baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a backend endpoint is ejected for. Defaults to 30000ms or 30s. After a backend endpoint is returned back to the load balancing pool, it can be ejected again in another ejection analysis. Thus, the total ejection time is equal to the base ejection time multiplied by the number of times the backend endpoint has been ejected. Defaults to 30000ms or 30s. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "consecutiveErrors": 42, # Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingConsecutiveErrors": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingSuccessRate": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. - "interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second. + "consecutiveErrors": 42, # Number of consecutive errors before a backend endpoint is ejected from the load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. + "consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. + "enforcingConsecutiveErrors": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. + "enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. + "enforcingSuccessRate": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service uses Serverless NEG. + "interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections and backend endpoints being returned to service. The interval is equal to the number of seconds as defined in outlierDetection.interval.seconds plus the number of nanoseconds as defined in outlierDetection.interval.nanos. Defaults to 1 second. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxEjectionPercent": 42, # Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%. - "successRateMinimumHosts": 42, # The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5. - "successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100. - "successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. + "maxEjectionPercent": 42, # Maximum percentage of backend endpoints in the load balancing pool for the backend service that can be ejected if the ejection conditions are met. Defaults to 50%. + "successRateMinimumHosts": 42, # The number of backend endpoints in the load balancing pool that must have enough request volume to detect success rate outliers. If the number of backend endpoints is fewer than this setting, outlier detection via success rate statistics is not performed for any backend endpoint in the load balancing pool. Defaults to 5. Not supported when the backend service uses Serverless NEG. + "successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this backend endpoint in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that backend endpoint. Defaults to 100. Not supported when the backend service uses Serverless NEG. + "successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * successRateStdevFactor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. Not supported when the backend service uses Serverless NEG. }, "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port. "portName": "A String", # A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be [defined on each backend instance group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports). This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name. @@ -1012,24 +1012,24 @@

Method Details

}, "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL. - "outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. If not set, this feature is considered disabled. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, HTTP2, or GRPC, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. - "baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s. + "outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service. If not set, this feature is considered disabled. Results of the outlier detection algorithm (ejection of endpoints from the load balancing pool and returning them back to the pool) are executed independently by each proxy instance of the load balancer. In most cases, more than one proxy instance handles the traffic received by a backend service. Thus, it is possible that an unhealthy endpoint is detected and ejected by only some of the proxies, and while this happens, other proxies may continue to send requests to the same unhealthy endpoint until they detect and eject the unhealthy endpoint. Applicable backend endpoints can be: - VM instances in an Instance Group - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT) - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT) - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud Functions Services - Private Service Connect NEGs, that resolve to Google-managed regional API endpoints or managed services published using Private Service Connect Applicable backend service types can be: - A global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. - A regional backend service with the serviceProtocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not supported for Serverless NEGs. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. + "baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a backend endpoint is ejected for. Defaults to 30000ms or 30s. After a backend endpoint is returned back to the load balancing pool, it can be ejected again in another ejection analysis. Thus, the total ejection time is equal to the base ejection time multiplied by the number of times the backend endpoint has been ejected. Defaults to 30000ms or 30s. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "consecutiveErrors": 42, # Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingConsecutiveErrors": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingSuccessRate": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. - "interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second. + "consecutiveErrors": 42, # Number of consecutive errors before a backend endpoint is ejected from the load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. + "consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. + "enforcingConsecutiveErrors": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. + "enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. + "enforcingSuccessRate": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service uses Serverless NEG. + "interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections and backend endpoints being returned to service. The interval is equal to the number of seconds as defined in outlierDetection.interval.seconds plus the number of nanoseconds as defined in outlierDetection.interval.nanos. Defaults to 1 second. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxEjectionPercent": 42, # Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%. - "successRateMinimumHosts": 42, # The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5. - "successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100. - "successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. + "maxEjectionPercent": 42, # Maximum percentage of backend endpoints in the load balancing pool for the backend service that can be ejected if the ejection conditions are met. Defaults to 50%. + "successRateMinimumHosts": 42, # The number of backend endpoints in the load balancing pool that must have enough request volume to detect success rate outliers. If the number of backend endpoints is fewer than this setting, outlier detection via success rate statistics is not performed for any backend endpoint in the load balancing pool. Defaults to 5. Not supported when the backend service uses Serverless NEG. + "successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this backend endpoint in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that backend endpoint. Defaults to 100. Not supported when the backend service uses Serverless NEG. + "successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * successRateStdevFactor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. Not supported when the backend service uses Serverless NEG. }, "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port. "portName": "A String", # A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be [defined on each backend instance group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports). This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name. @@ -1239,24 +1239,24 @@

Method Details

}, "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL. - "outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. If not set, this feature is considered disabled. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, HTTP2, or GRPC, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. - "baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s. + "outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service. If not set, this feature is considered disabled. Results of the outlier detection algorithm (ejection of endpoints from the load balancing pool and returning them back to the pool) are executed independently by each proxy instance of the load balancer. In most cases, more than one proxy instance handles the traffic received by a backend service. Thus, it is possible that an unhealthy endpoint is detected and ejected by only some of the proxies, and while this happens, other proxies may continue to send requests to the same unhealthy endpoint until they detect and eject the unhealthy endpoint. Applicable backend endpoints can be: - VM instances in an Instance Group - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT) - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT) - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud Functions Services - Private Service Connect NEGs, that resolve to Google-managed regional API endpoints or managed services published using Private Service Connect Applicable backend service types can be: - A global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. - A regional backend service with the serviceProtocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not supported for Serverless NEGs. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. + "baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a backend endpoint is ejected for. Defaults to 30000ms or 30s. After a backend endpoint is returned back to the load balancing pool, it can be ejected again in another ejection analysis. Thus, the total ejection time is equal to the base ejection time multiplied by the number of times the backend endpoint has been ejected. Defaults to 30000ms or 30s. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "consecutiveErrors": 42, # Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingConsecutiveErrors": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingSuccessRate": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. - "interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second. + "consecutiveErrors": 42, # Number of consecutive errors before a backend endpoint is ejected from the load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. + "consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. + "enforcingConsecutiveErrors": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. + "enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. + "enforcingSuccessRate": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service uses Serverless NEG. + "interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections and backend endpoints being returned to service. The interval is equal to the number of seconds as defined in outlierDetection.interval.seconds plus the number of nanoseconds as defined in outlierDetection.interval.nanos. Defaults to 1 second. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxEjectionPercent": 42, # Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%. - "successRateMinimumHosts": 42, # The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5. - "successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100. - "successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. + "maxEjectionPercent": 42, # Maximum percentage of backend endpoints in the load balancing pool for the backend service that can be ejected if the ejection conditions are met. Defaults to 50%. + "successRateMinimumHosts": 42, # The number of backend endpoints in the load balancing pool that must have enough request volume to detect success rate outliers. If the number of backend endpoints is fewer than this setting, outlier detection via success rate statistics is not performed for any backend endpoint in the load balancing pool. Defaults to 5. Not supported when the backend service uses Serverless NEG. + "successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this backend endpoint in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that backend endpoint. Defaults to 100. Not supported when the backend service uses Serverless NEG. + "successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * successRateStdevFactor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. Not supported when the backend service uses Serverless NEG. }, "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port. "portName": "A String", # A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be [defined on each backend instance group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports). This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name. @@ -1733,24 +1733,24 @@

Method Details

}, "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL. - "outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. If not set, this feature is considered disabled. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, HTTP2, or GRPC, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. - "baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s. + "outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service. If not set, this feature is considered disabled. Results of the outlier detection algorithm (ejection of endpoints from the load balancing pool and returning them back to the pool) are executed independently by each proxy instance of the load balancer. In most cases, more than one proxy instance handles the traffic received by a backend service. Thus, it is possible that an unhealthy endpoint is detected and ejected by only some of the proxies, and while this happens, other proxies may continue to send requests to the same unhealthy endpoint until they detect and eject the unhealthy endpoint. Applicable backend endpoints can be: - VM instances in an Instance Group - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT) - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT) - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud Functions Services - Private Service Connect NEGs, that resolve to Google-managed regional API endpoints or managed services published using Private Service Connect Applicable backend service types can be: - A global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. - A regional backend service with the serviceProtocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not supported for Serverless NEGs. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. + "baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a backend endpoint is ejected for. Defaults to 30000ms or 30s. After a backend endpoint is returned back to the load balancing pool, it can be ejected again in another ejection analysis. Thus, the total ejection time is equal to the base ejection time multiplied by the number of times the backend endpoint has been ejected. Defaults to 30000ms or 30s. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "consecutiveErrors": 42, # Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingConsecutiveErrors": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. - "enforcingSuccessRate": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. - "interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second. + "consecutiveErrors": 42, # Number of consecutive errors before a backend endpoint is ejected from the load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. + "consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. + "enforcingConsecutiveErrors": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. + "enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. + "enforcingSuccessRate": 42, # The percentage chance that a backend endpoint will be ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service uses Serverless NEG. + "interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections and backend endpoints being returned to service. The interval is equal to the number of seconds as defined in outlierDetection.interval.seconds plus the number of nanoseconds as defined in outlierDetection.interval.nanos. Defaults to 1 second. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxEjectionPercent": 42, # Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%. - "successRateMinimumHosts": 42, # The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5. - "successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100. - "successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. + "maxEjectionPercent": 42, # Maximum percentage of backend endpoints in the load balancing pool for the backend service that can be ejected if the ejection conditions are met. Defaults to 50%. + "successRateMinimumHosts": 42, # The number of backend endpoints in the load balancing pool that must have enough request volume to detect success rate outliers. If the number of backend endpoints is fewer than this setting, outlier detection via success rate statistics is not performed for any backend endpoint in the load balancing pool. Defaults to 5. Not supported when the backend service uses Serverless NEG. + "successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this backend endpoint in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that backend endpoint. Defaults to 100. Not supported when the backend service uses Serverless NEG. + "successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * successRateStdevFactor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. Not supported when the backend service uses Serverless NEG. }, "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port. "portName": "A String", # A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be [defined on each backend instance group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports). This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name. diff --git a/docs/dyn/compute_v1.regionInstanceGroupManagers.html b/docs/dyn/compute_v1.regionInstanceGroupManagers.html index 5a683cf21ea..b5b057c6088 100644 --- a/docs/dyn/compute_v1.regionInstanceGroupManagers.html +++ b/docs/dyn/compute_v1.regionInstanceGroupManagers.html @@ -837,6 +837,9 @@

Method Details

"fingerprint": "A String", # Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager. "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier. "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource. + "instanceLifecyclePolicy": { # The repair policy for this managed instance group. + "forceUpdateOnRepair": "A String", # A bit indicating whether to forcefully apply the group's latest configuration when repairing a VM. Valid options are: - NO (default): If configuration updates are available, they are not forcefully applied during repair. Instead, configuration updates are applied according to the group's update policy. - YES: If configuration updates are available, they are applied during repair. + }, "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. "listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for this managed instance group. @@ -953,6 +956,9 @@

Method Details

"fingerprint": "A String", # Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager. "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier. "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource. + "instanceLifecyclePolicy": { # The repair policy for this managed instance group. + "forceUpdateOnRepair": "A String", # A bit indicating whether to forcefully apply the group's latest configuration when repairing a VM. Valid options are: - NO (default): If configuration updates are available, they are not forcefully applied during repair. Instead, configuration updates are applied according to the group's update policy. - YES: If configuration updates are available, they are applied during repair. + }, "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. "listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for this managed instance group. @@ -1168,6 +1174,9 @@

Method Details

"fingerprint": "A String", # Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager. "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier. "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource. + "instanceLifecyclePolicy": { # The repair policy for this managed instance group. + "forceUpdateOnRepair": "A String", # A bit indicating whether to forcefully apply the group's latest configuration when repairing a VM. Valid options are: - NO (default): If configuration updates are available, they are not forcefully applied during repair. Instead, configuration updates are applied according to the group's update policy. - YES: If configuration updates are available, they are applied during repair. + }, "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. "listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for this managed instance group. @@ -1564,6 +1573,9 @@

Method Details

"fingerprint": "A String", # Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager. "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier. "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource. + "instanceLifecyclePolicy": { # The repair policy for this managed instance group. + "forceUpdateOnRepair": "A String", # A bit indicating whether to forcefully apply the group's latest configuration when repairing a VM. Valid options are: - NO (default): If configuration updates are available, they are not forcefully applied during repair. Instead, configuration updates are applied according to the group's update policy. - YES: If configuration updates are available, they are applied during repair. + }, "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. "listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for this managed instance group. diff --git a/docs/dyn/connectors_v1.projects.locations.connections.eventSubscriptions.html b/docs/dyn/connectors_v1.projects.locations.connections.eventSubscriptions.html new file mode 100644 index 00000000000..9fb7d8bc47d --- /dev/null +++ b/docs/dyn/connectors_v1.projects.locations.connections.eventSubscriptions.html @@ -0,0 +1,421 @@ + + + +

Connectors API . projects . locations . connections . eventSubscriptions

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, eventSubscriptionId=None, x__xgafv=None)

+

Creates a new EventSubscription in a given project,location and connection.

+

+ delete(name, x__xgafv=None)

+

Deletes a single EventSubscription.

+

+ get(name, x__xgafv=None)

+

Gets details of a single EventSubscription.

+

+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

List EventSubscriptions in a given project,location and connection.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, body=None, updateMask=None, x__xgafv=None)

+

Updates the parameters of a single EventSubscription.

+

+ retry(name, body=None, x__xgafv=None)

+

RetryEventSubscription retries the registration of Subscription.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, eventSubscriptionId=None, x__xgafv=None) +
Creates a new EventSubscription in a given project,location and connection.
+
+Args:
+  parent: string, Required. Parent resource of the EventSubscription, of the form: `projects/*/locations/*/connections/*` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # represents the Connector's EventSubscription resource
+  "createTime": "A String", # Output only. Created time.
+  "destinations": { # Message for EventSubscription Destination to act on receiving an event # Optional. The destination to hit when we receive an event
+    "endpoint": { # Endpoint message includes details of the Destination endpoint. # OPTION 1: Hit an endpoint when we receive an event.
+      "endpointUri": "A String", # The URI of the Endpoint.
+      "headers": [ # List of Header to be added to the Endpoint.
+        { # Header details for a given header to be added to Endpoint.
+          "key": "A String", # Key of Header.
+          "value": "A String", # Value of Header.
+        },
+      ],
+    },
+    "serviceAccount": "A String", # Service account needed for runtime plane to trigger IP workflow.
+    "type": "A String", # type of the destination
+  },
+  "eventTypeId": "A String", # Optional. Event type id of the event of current EventSubscription.
+  "name": "A String", # Required. Resource name of the EventSubscription. Format: projects/{project}/locations/{location}/connections/{connection}/eventSubscriptions/{event_subscription}
+  "status": { # EventSubscription Status denotes the status of the EventSubscription resource. # Optional. Status indicates the status of the event subscription resource
+    "description": "A String", # Output only. Description of the state.
+    "state": "A String", # Output only. State of Event Subscription resource.
+  },
+  "subscriber": "A String", # Optional. name of the Subscriber for the current EventSubscription.
+  "subscriberLink": "A String", # Optional. Link for Subscriber of the current EventSubscription.
+  "updateTime": "A String", # Output only. Updated time.
+}
+
+  eventSubscriptionId: string, Required. Identifier to assign to the Event Subscription. Must be unique within scope of the parent resource.
+  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.
+  },
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a single EventSubscription.
+
+Args:
+  name: string, Required. Resource name of the form: `projects/*/locations/*/connections/*/eventsubscriptions/*` (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.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets details of a single EventSubscription.
+
+Args:
+  name: string, Required. Resource name of the form: `projects/*/locations/*/connections/*/eventSubscriptions/*` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # represents the Connector's EventSubscription resource
+  "createTime": "A String", # Output only. Created time.
+  "destinations": { # Message for EventSubscription Destination to act on receiving an event # Optional. The destination to hit when we receive an event
+    "endpoint": { # Endpoint message includes details of the Destination endpoint. # OPTION 1: Hit an endpoint when we receive an event.
+      "endpointUri": "A String", # The URI of the Endpoint.
+      "headers": [ # List of Header to be added to the Endpoint.
+        { # Header details for a given header to be added to Endpoint.
+          "key": "A String", # Key of Header.
+          "value": "A String", # Value of Header.
+        },
+      ],
+    },
+    "serviceAccount": "A String", # Service account needed for runtime plane to trigger IP workflow.
+    "type": "A String", # type of the destination
+  },
+  "eventTypeId": "A String", # Optional. Event type id of the event of current EventSubscription.
+  "name": "A String", # Required. Resource name of the EventSubscription. Format: projects/{project}/locations/{location}/connections/{connection}/eventSubscriptions/{event_subscription}
+  "status": { # EventSubscription Status denotes the status of the EventSubscription resource. # Optional. Status indicates the status of the event subscription resource
+    "description": "A String", # Output only. Description of the state.
+    "state": "A String", # Output only. State of Event Subscription resource.
+  },
+  "subscriber": "A String", # Optional. name of the Subscriber for the current EventSubscription.
+  "subscriberLink": "A String", # Optional. Link for Subscriber of the current EventSubscription.
+  "updateTime": "A String", # Output only. Updated time.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
List EventSubscriptions in a given project,location and connection.
+
+Args:
+  parent: string, Required. Parent resource of the EventSubscription, of the form: `projects/*/locations/*/connections/*` (required)
+  filter: string, Filter. https://g3doc.corp.google.com/cloud/control2/g3doc/dev/apihosting/list_filtering.md#filtering.
+  orderBy: string, Order by parameters.
+  pageSize: integer, Page size.
+  pageToken: string, Page token.
+  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 ConnectorsService.ListEventSubscriptions
+  "eventSubscriptions": [ # Subscriptions.
+    { # represents the Connector's EventSubscription resource
+      "createTime": "A String", # Output only. Created time.
+      "destinations": { # Message for EventSubscription Destination to act on receiving an event # Optional. The destination to hit when we receive an event
+        "endpoint": { # Endpoint message includes details of the Destination endpoint. # OPTION 1: Hit an endpoint when we receive an event.
+          "endpointUri": "A String", # The URI of the Endpoint.
+          "headers": [ # List of Header to be added to the Endpoint.
+            { # Header details for a given header to be added to Endpoint.
+              "key": "A String", # Key of Header.
+              "value": "A String", # Value of Header.
+            },
+          ],
+        },
+        "serviceAccount": "A String", # Service account needed for runtime plane to trigger IP workflow.
+        "type": "A String", # type of the destination
+      },
+      "eventTypeId": "A String", # Optional. Event type id of the event of current EventSubscription.
+      "name": "A String", # Required. Resource name of the EventSubscription. Format: projects/{project}/locations/{location}/connections/{connection}/eventSubscriptions/{event_subscription}
+      "status": { # EventSubscription Status denotes the status of the EventSubscription resource. # Optional. Status indicates the status of the event subscription resource
+        "description": "A String", # Output only. Description of the state.
+        "state": "A String", # Output only. State of Event Subscription resource.
+      },
+      "subscriber": "A String", # Optional. name of the Subscriber for the current EventSubscription.
+      "subscriberLink": "A String", # Optional. Link for Subscriber of the current EventSubscription.
+      "updateTime": "A String", # Output only. Updated time.
+    },
+  ],
+  "nextPageToken": "A String", # Next page token.
+  "unreachable": [ # Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates the parameters of a single EventSubscription.
+
+Args:
+  name: string, Required. Resource name of the EventSubscription. Format: projects/{project}/locations/{location}/connections/{connection}/eventSubscriptions/{event_subscription} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # represents the Connector's EventSubscription resource
+  "createTime": "A String", # Output only. Created time.
+  "destinations": { # Message for EventSubscription Destination to act on receiving an event # Optional. The destination to hit when we receive an event
+    "endpoint": { # Endpoint message includes details of the Destination endpoint. # OPTION 1: Hit an endpoint when we receive an event.
+      "endpointUri": "A String", # The URI of the Endpoint.
+      "headers": [ # List of Header to be added to the Endpoint.
+        { # Header details for a given header to be added to Endpoint.
+          "key": "A String", # Key of Header.
+          "value": "A String", # Value of Header.
+        },
+      ],
+    },
+    "serviceAccount": "A String", # Service account needed for runtime plane to trigger IP workflow.
+    "type": "A String", # type of the destination
+  },
+  "eventTypeId": "A String", # Optional. Event type id of the event of current EventSubscription.
+  "name": "A String", # Required. Resource name of the EventSubscription. Format: projects/{project}/locations/{location}/connections/{connection}/eventSubscriptions/{event_subscription}
+  "status": { # EventSubscription Status denotes the status of the EventSubscription resource. # Optional. Status indicates the status of the event subscription resource
+    "description": "A String", # Output only. Description of the state.
+    "state": "A String", # Output only. State of Event Subscription resource.
+  },
+  "subscriber": "A String", # Optional. name of the Subscriber for the current EventSubscription.
+  "subscriberLink": "A String", # Optional. Link for Subscriber of the current EventSubscription.
+  "updateTime": "A String", # Output only. Updated time.
+}
+
+  updateMask: string, Required. The list of fields to update. Fields are specified relative to the Subscription. A field will be overwritten if it is in the mask. You can modify only the fields listed below. To update the EventSubscription details: * `serviceAccount`
+  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.
+  },
+}
+
+ +
+ retry(name, body=None, x__xgafv=None) +
RetryEventSubscription retries the registration of Subscription.
+
+Args:
+  name: string, Required. Resource name of the form: `projects/*/locations/*/connections/*/eventSubscriptions/*` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for ConnectorsService.RefreshEventSubscription
+}
+
+  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.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/connectors_v1.projects.locations.connections.html b/docs/dyn/connectors_v1.projects.locations.connections.html index 3b746bcc48c..9f544584529 100644 --- a/docs/dyn/connectors_v1.projects.locations.connections.html +++ b/docs/dyn/connectors_v1.projects.locations.connections.html @@ -79,6 +79,11 @@

Instance Methods

Returns the connectionSchemaMetadata Resource.

+

+ eventSubscriptions() +

+

Returns the eventSubscriptions Resource.

+

runtimeActionSchemas()

@@ -116,6 +121,9 @@

Instance Methods

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates the parameters of a single Connection.

+

+ repairEventing(name, body=None, x__xgafv=None)

+

RepaiEventing tries to repair eventing related event subscriptions.

setIamPolicy(resource, body=None, x__xgafv=None)

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

@@ -220,6 +228,9 @@

Method Details

], "connectionRevision": "A String", # Output only. Connection revision. This field is only updated when the connection is created or updated by User. "connectorVersion": "A String", # Required. Connector version on which the connection is created. The format is: projects/*/locations/*/providers/*/connectors/*/versions/* Only global location is supported for ConnectorVersion resource. + "connectorVersionInfraConfig": { # This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version # Output only. Infra configs supported by Connector Version. + "ratelimitThreshold": "A String", # Output only. Max QPS supported by the connector version before throttling of requests. + }, "connectorVersionLaunchStage": "A String", # Output only. Flag to mark the version indicating the launch stage. "createTime": "A String", # Output only. Created time. "description": "A String", # Optional. Description of the resource. @@ -236,6 +247,120 @@

Method Details

}, ], "envoyImageLocation": "A String", # Output only. GCR location where the envoy image is stored. formatted like: gcr.io/{bucketName}/{imageName} + "eventingConfig": { # Eventing Configuration of a connection # Optional. Eventing config of a connection + "additionalVariables": [ # Additional eventing related field values + { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig. + "boolValue": True or False, # Value is a bool. + "encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key. + "kmsKeyName": "A String", # The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed. + "type": "A String", # Type. + }, + "intValue": "A String", # Value is an integer + "key": "A String", # Key of the config variable. + "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "stringValue": "A String", # Value is a string. + }, + ], + "authConfig": { # AuthConfig defines details of a authentication type. # Auth details for the webhook adapter. + "additionalVariables": [ # List containing additional auth configs. + { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig. + "boolValue": True or False, # Value is a bool. + "encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key. + "kmsKeyName": "A String", # The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed. + "type": "A String", # Type. + }, + "intValue": "A String", # Value is an integer + "key": "A String", # Key of the config variable. + "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "stringValue": "A String", # Value is a string. + }, + ], + "authKey": "A String", # Identifier key for auth config + "authType": "A String", # The type of authentication configured. + "oauth2AuthCodeFlow": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication. See https://www.rfc-editor.org/rfc/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlow. + "authCode": "A String", # Authorization code to be exchanged for access and refresh tokens. + "authUri": "A String", # Auth URL for Authorization Code Flow + "clientId": "A String", # Client ID for user-provided OAuth app. + "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Client secret for user-provided OAuth app. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "enablePkce": True or False, # Whether to enable PKCE when the user performs the auth code flow. + "pkceVerifier": "A String", # PKCE verifier to be used during the auth code exchange. + "redirectUri": "A String", # Redirect URI to be provided during the auth code exchange. + "scopes": [ # Scopes the connection will request when the user performs the auth code flow. + "A String", + ], + }, + "oauth2ClientCredentials": { # Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2ClientCredentials. + "clientId": "A String", # The client identifier. + "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + }, + "oauth2JwtBearer": { # Parameters to support JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant based authentication. See https://tools.ietf.org/html/rfc7523 for more details. # Oauth2JwtBearer. + "clientKey": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing a PKCS#8 PEM-encoded private key associated with the Client Certificate. This private key will be used to sign JWTs used for the jwt-bearer authorization grant. Specified in the form as: `projects/*/secrets/*/versions/*`. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "jwtClaims": { # JWT claims used for the jwt-bearer authorization grant. # JwtClaims providers fields to generate the token. + "audience": "A String", # Value for the "aud" claim. + "issuer": "A String", # Value for the "iss" claim. + "subject": "A String", # Value for the "sub" claim. + }, + }, + "sshPublicKey": { # Parameters to support Ssh public key Authentication. # SSH Public Key. + "certType": "A String", # Format of SSH Client cert. + "sshClientCert": { # Secret provides a reference to entries in Secret Manager. # SSH Client Cert. It should contain both public and private key. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "sshClientCertPass": { # Secret provides a reference to entries in Secret Manager. # Password (passphrase) for ssh client certificate if it has one. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "username": "A String", # The user account used to authenticate. + }, + "userPassword": { # Parameters to support Username and Password Authentication. # UserPassword. + "password": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the password. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "username": "A String", # Username. + }, + }, + "encryptionKey": { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig. # Encryption key (can be either Google managed or CMEK). + "boolValue": True or False, # Value is a bool. + "encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key. + "kmsKeyName": "A String", # The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed. + "type": "A String", # Type. + }, + "intValue": "A String", # Value is an integer + "key": "A String", # Key of the config variable. + "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "stringValue": "A String", # Value is a string. + }, + "enrichmentEnabled": True or False, # Enrichment Enabled. + "registrationDestinationConfig": { # Define the Connectors target endpoint. # Registration endpoint for auto regsitration. + "destinations": [ # The destinations for the key. + { + "host": "A String", # For publicly routable host. + "port": 42, # The port is the target port number that is accepted by the destination. + "serviceAttachment": "A String", # PSC service attachments. Format: projects/*/regions/*/serviceAttachments/* + }, + ], + "key": "A String", # The key is the destination identifier that is supported by the Connector. + }, + }, + "eventingEnablementType": "A String", # Optional. Eventing enablement type. Will be nil if eventing is not enabled. + "eventingRuntimeData": { # Eventing runtime data has the details related to eventing managed by the system. # Output only. Eventing Runtime Data. + "eventsListenerEndpoint": "A String", # Output only. Events listener endpoint. The value will populated after provisioning the events listener. + "status": { # EventingStatus indicates the state of eventing. # Output only. Current status of eventing. + "description": "A String", # Output only. Description of error if State is set to "ERROR". + "state": "A String", # Output only. State. + }, + }, "imageLocation": "A String", # Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName} "labels": { # Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources "a_key": "A String", @@ -465,6 +590,9 @@

Method Details

], "connectionRevision": "A String", # Output only. Connection revision. This field is only updated when the connection is created or updated by User. "connectorVersion": "A String", # Required. Connector version on which the connection is created. The format is: projects/*/locations/*/providers/*/connectors/*/versions/* Only global location is supported for ConnectorVersion resource. + "connectorVersionInfraConfig": { # This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version # Output only. Infra configs supported by Connector Version. + "ratelimitThreshold": "A String", # Output only. Max QPS supported by the connector version before throttling of requests. + }, "connectorVersionLaunchStage": "A String", # Output only. Flag to mark the version indicating the launch stage. "createTime": "A String", # Output only. Created time. "description": "A String", # Optional. Description of the resource. @@ -481,6 +609,120 @@

Method Details

}, ], "envoyImageLocation": "A String", # Output only. GCR location where the envoy image is stored. formatted like: gcr.io/{bucketName}/{imageName} + "eventingConfig": { # Eventing Configuration of a connection # Optional. Eventing config of a connection + "additionalVariables": [ # Additional eventing related field values + { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig. + "boolValue": True or False, # Value is a bool. + "encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key. + "kmsKeyName": "A String", # The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed. + "type": "A String", # Type. + }, + "intValue": "A String", # Value is an integer + "key": "A String", # Key of the config variable. + "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "stringValue": "A String", # Value is a string. + }, + ], + "authConfig": { # AuthConfig defines details of a authentication type. # Auth details for the webhook adapter. + "additionalVariables": [ # List containing additional auth configs. + { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig. + "boolValue": True or False, # Value is a bool. + "encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key. + "kmsKeyName": "A String", # The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed. + "type": "A String", # Type. + }, + "intValue": "A String", # Value is an integer + "key": "A String", # Key of the config variable. + "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "stringValue": "A String", # Value is a string. + }, + ], + "authKey": "A String", # Identifier key for auth config + "authType": "A String", # The type of authentication configured. + "oauth2AuthCodeFlow": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication. See https://www.rfc-editor.org/rfc/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlow. + "authCode": "A String", # Authorization code to be exchanged for access and refresh tokens. + "authUri": "A String", # Auth URL for Authorization Code Flow + "clientId": "A String", # Client ID for user-provided OAuth app. + "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Client secret for user-provided OAuth app. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "enablePkce": True or False, # Whether to enable PKCE when the user performs the auth code flow. + "pkceVerifier": "A String", # PKCE verifier to be used during the auth code exchange. + "redirectUri": "A String", # Redirect URI to be provided during the auth code exchange. + "scopes": [ # Scopes the connection will request when the user performs the auth code flow. + "A String", + ], + }, + "oauth2ClientCredentials": { # Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2ClientCredentials. + "clientId": "A String", # The client identifier. + "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + }, + "oauth2JwtBearer": { # Parameters to support JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant based authentication. See https://tools.ietf.org/html/rfc7523 for more details. # Oauth2JwtBearer. + "clientKey": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing a PKCS#8 PEM-encoded private key associated with the Client Certificate. This private key will be used to sign JWTs used for the jwt-bearer authorization grant. Specified in the form as: `projects/*/secrets/*/versions/*`. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "jwtClaims": { # JWT claims used for the jwt-bearer authorization grant. # JwtClaims providers fields to generate the token. + "audience": "A String", # Value for the "aud" claim. + "issuer": "A String", # Value for the "iss" claim. + "subject": "A String", # Value for the "sub" claim. + }, + }, + "sshPublicKey": { # Parameters to support Ssh public key Authentication. # SSH Public Key. + "certType": "A String", # Format of SSH Client cert. + "sshClientCert": { # Secret provides a reference to entries in Secret Manager. # SSH Client Cert. It should contain both public and private key. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "sshClientCertPass": { # Secret provides a reference to entries in Secret Manager. # Password (passphrase) for ssh client certificate if it has one. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "username": "A String", # The user account used to authenticate. + }, + "userPassword": { # Parameters to support Username and Password Authentication. # UserPassword. + "password": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the password. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "username": "A String", # Username. + }, + }, + "encryptionKey": { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig. # Encryption key (can be either Google managed or CMEK). + "boolValue": True or False, # Value is a bool. + "encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key. + "kmsKeyName": "A String", # The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed. + "type": "A String", # Type. + }, + "intValue": "A String", # Value is an integer + "key": "A String", # Key of the config variable. + "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "stringValue": "A String", # Value is a string. + }, + "enrichmentEnabled": True or False, # Enrichment Enabled. + "registrationDestinationConfig": { # Define the Connectors target endpoint. # Registration endpoint for auto regsitration. + "destinations": [ # The destinations for the key. + { + "host": "A String", # For publicly routable host. + "port": 42, # The port is the target port number that is accepted by the destination. + "serviceAttachment": "A String", # PSC service attachments. Format: projects/*/regions/*/serviceAttachments/* + }, + ], + "key": "A String", # The key is the destination identifier that is supported by the Connector. + }, + }, + "eventingEnablementType": "A String", # Optional. Eventing enablement type. Will be nil if eventing is not enabled. + "eventingRuntimeData": { # Eventing runtime data has the details related to eventing managed by the system. # Output only. Eventing Runtime Data. + "eventsListenerEndpoint": "A String", # Output only. Events listener endpoint. The value will populated after provisioning the events listener. + "status": { # EventingStatus indicates the state of eventing. # Output only. Current status of eventing. + "description": "A String", # Output only. Description of error if State is set to "ERROR". + "state": "A String", # Output only. State. + }, + }, "imageLocation": "A String", # Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName} "labels": { # Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources "a_key": "A String", @@ -728,6 +970,9 @@

Method Details

], "connectionRevision": "A String", # Output only. Connection revision. This field is only updated when the connection is created or updated by User. "connectorVersion": "A String", # Required. Connector version on which the connection is created. The format is: projects/*/locations/*/providers/*/connectors/*/versions/* Only global location is supported for ConnectorVersion resource. + "connectorVersionInfraConfig": { # This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version # Output only. Infra configs supported by Connector Version. + "ratelimitThreshold": "A String", # Output only. Max QPS supported by the connector version before throttling of requests. + }, "connectorVersionLaunchStage": "A String", # Output only. Flag to mark the version indicating the launch stage. "createTime": "A String", # Output only. Created time. "description": "A String", # Optional. Description of the resource. @@ -744,6 +989,120 @@

Method Details

}, ], "envoyImageLocation": "A String", # Output only. GCR location where the envoy image is stored. formatted like: gcr.io/{bucketName}/{imageName} + "eventingConfig": { # Eventing Configuration of a connection # Optional. Eventing config of a connection + "additionalVariables": [ # Additional eventing related field values + { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig. + "boolValue": True or False, # Value is a bool. + "encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key. + "kmsKeyName": "A String", # The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed. + "type": "A String", # Type. + }, + "intValue": "A String", # Value is an integer + "key": "A String", # Key of the config variable. + "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "stringValue": "A String", # Value is a string. + }, + ], + "authConfig": { # AuthConfig defines details of a authentication type. # Auth details for the webhook adapter. + "additionalVariables": [ # List containing additional auth configs. + { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig. + "boolValue": True or False, # Value is a bool. + "encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key. + "kmsKeyName": "A String", # The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed. + "type": "A String", # Type. + }, + "intValue": "A String", # Value is an integer + "key": "A String", # Key of the config variable. + "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "stringValue": "A String", # Value is a string. + }, + ], + "authKey": "A String", # Identifier key for auth config + "authType": "A String", # The type of authentication configured. + "oauth2AuthCodeFlow": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication. See https://www.rfc-editor.org/rfc/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlow. + "authCode": "A String", # Authorization code to be exchanged for access and refresh tokens. + "authUri": "A String", # Auth URL for Authorization Code Flow + "clientId": "A String", # Client ID for user-provided OAuth app. + "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Client secret for user-provided OAuth app. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "enablePkce": True or False, # Whether to enable PKCE when the user performs the auth code flow. + "pkceVerifier": "A String", # PKCE verifier to be used during the auth code exchange. + "redirectUri": "A String", # Redirect URI to be provided during the auth code exchange. + "scopes": [ # Scopes the connection will request when the user performs the auth code flow. + "A String", + ], + }, + "oauth2ClientCredentials": { # Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2ClientCredentials. + "clientId": "A String", # The client identifier. + "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + }, + "oauth2JwtBearer": { # Parameters to support JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant based authentication. See https://tools.ietf.org/html/rfc7523 for more details. # Oauth2JwtBearer. + "clientKey": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing a PKCS#8 PEM-encoded private key associated with the Client Certificate. This private key will be used to sign JWTs used for the jwt-bearer authorization grant. Specified in the form as: `projects/*/secrets/*/versions/*`. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "jwtClaims": { # JWT claims used for the jwt-bearer authorization grant. # JwtClaims providers fields to generate the token. + "audience": "A String", # Value for the "aud" claim. + "issuer": "A String", # Value for the "iss" claim. + "subject": "A String", # Value for the "sub" claim. + }, + }, + "sshPublicKey": { # Parameters to support Ssh public key Authentication. # SSH Public Key. + "certType": "A String", # Format of SSH Client cert. + "sshClientCert": { # Secret provides a reference to entries in Secret Manager. # SSH Client Cert. It should contain both public and private key. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "sshClientCertPass": { # Secret provides a reference to entries in Secret Manager. # Password (passphrase) for ssh client certificate if it has one. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "username": "A String", # The user account used to authenticate. + }, + "userPassword": { # Parameters to support Username and Password Authentication. # UserPassword. + "password": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the password. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "username": "A String", # Username. + }, + }, + "encryptionKey": { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig. # Encryption key (can be either Google managed or CMEK). + "boolValue": True or False, # Value is a bool. + "encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key. + "kmsKeyName": "A String", # The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed. + "type": "A String", # Type. + }, + "intValue": "A String", # Value is an integer + "key": "A String", # Key of the config variable. + "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "stringValue": "A String", # Value is a string. + }, + "enrichmentEnabled": True or False, # Enrichment Enabled. + "registrationDestinationConfig": { # Define the Connectors target endpoint. # Registration endpoint for auto regsitration. + "destinations": [ # The destinations for the key. + { + "host": "A String", # For publicly routable host. + "port": 42, # The port is the target port number that is accepted by the destination. + "serviceAttachment": "A String", # PSC service attachments. Format: projects/*/regions/*/serviceAttachments/* + }, + ], + "key": "A String", # The key is the destination identifier that is supported by the Connector. + }, + }, + "eventingEnablementType": "A String", # Optional. Eventing enablement type. Will be nil if eventing is not enabled. + "eventingRuntimeData": { # Eventing runtime data has the details related to eventing managed by the system. # Output only. Eventing Runtime Data. + "eventsListenerEndpoint": "A String", # Output only. Events listener endpoint. The value will populated after provisioning the events listener. + "status": { # EventingStatus indicates the state of eventing. # Output only. Current status of eventing. + "description": "A String", # Output only. Description of error if State is set to "ERROR". + "state": "A String", # Output only. State. + }, + }, "imageLocation": "A String", # Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName} "labels": { # Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources "a_key": "A String", @@ -919,6 +1278,9 @@

Method Details

], "connectionRevision": "A String", # Output only. Connection revision. This field is only updated when the connection is created or updated by User. "connectorVersion": "A String", # Required. Connector version on which the connection is created. The format is: projects/*/locations/*/providers/*/connectors/*/versions/* Only global location is supported for ConnectorVersion resource. + "connectorVersionInfraConfig": { # This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version # Output only. Infra configs supported by Connector Version. + "ratelimitThreshold": "A String", # Output only. Max QPS supported by the connector version before throttling of requests. + }, "connectorVersionLaunchStage": "A String", # Output only. Flag to mark the version indicating the launch stage. "createTime": "A String", # Output only. Created time. "description": "A String", # Optional. Description of the resource. @@ -935,6 +1297,120 @@

Method Details

}, ], "envoyImageLocation": "A String", # Output only. GCR location where the envoy image is stored. formatted like: gcr.io/{bucketName}/{imageName} + "eventingConfig": { # Eventing Configuration of a connection # Optional. Eventing config of a connection + "additionalVariables": [ # Additional eventing related field values + { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig. + "boolValue": True or False, # Value is a bool. + "encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key. + "kmsKeyName": "A String", # The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed. + "type": "A String", # Type. + }, + "intValue": "A String", # Value is an integer + "key": "A String", # Key of the config variable. + "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "stringValue": "A String", # Value is a string. + }, + ], + "authConfig": { # AuthConfig defines details of a authentication type. # Auth details for the webhook adapter. + "additionalVariables": [ # List containing additional auth configs. + { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig. + "boolValue": True or False, # Value is a bool. + "encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key. + "kmsKeyName": "A String", # The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed. + "type": "A String", # Type. + }, + "intValue": "A String", # Value is an integer + "key": "A String", # Key of the config variable. + "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "stringValue": "A String", # Value is a string. + }, + ], + "authKey": "A String", # Identifier key for auth config + "authType": "A String", # The type of authentication configured. + "oauth2AuthCodeFlow": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication. See https://www.rfc-editor.org/rfc/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlow. + "authCode": "A String", # Authorization code to be exchanged for access and refresh tokens. + "authUri": "A String", # Auth URL for Authorization Code Flow + "clientId": "A String", # Client ID for user-provided OAuth app. + "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Client secret for user-provided OAuth app. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "enablePkce": True or False, # Whether to enable PKCE when the user performs the auth code flow. + "pkceVerifier": "A String", # PKCE verifier to be used during the auth code exchange. + "redirectUri": "A String", # Redirect URI to be provided during the auth code exchange. + "scopes": [ # Scopes the connection will request when the user performs the auth code flow. + "A String", + ], + }, + "oauth2ClientCredentials": { # Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2ClientCredentials. + "clientId": "A String", # The client identifier. + "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + }, + "oauth2JwtBearer": { # Parameters to support JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant based authentication. See https://tools.ietf.org/html/rfc7523 for more details. # Oauth2JwtBearer. + "clientKey": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing a PKCS#8 PEM-encoded private key associated with the Client Certificate. This private key will be used to sign JWTs used for the jwt-bearer authorization grant. Specified in the form as: `projects/*/secrets/*/versions/*`. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "jwtClaims": { # JWT claims used for the jwt-bearer authorization grant. # JwtClaims providers fields to generate the token. + "audience": "A String", # Value for the "aud" claim. + "issuer": "A String", # Value for the "iss" claim. + "subject": "A String", # Value for the "sub" claim. + }, + }, + "sshPublicKey": { # Parameters to support Ssh public key Authentication. # SSH Public Key. + "certType": "A String", # Format of SSH Client cert. + "sshClientCert": { # Secret provides a reference to entries in Secret Manager. # SSH Client Cert. It should contain both public and private key. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "sshClientCertPass": { # Secret provides a reference to entries in Secret Manager. # Password (passphrase) for ssh client certificate if it has one. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "username": "A String", # The user account used to authenticate. + }, + "userPassword": { # Parameters to support Username and Password Authentication. # UserPassword. + "password": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the password. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "username": "A String", # Username. + }, + }, + "encryptionKey": { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig. # Encryption key (can be either Google managed or CMEK). + "boolValue": True or False, # Value is a bool. + "encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key. + "kmsKeyName": "A String", # The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed. + "type": "A String", # Type. + }, + "intValue": "A String", # Value is an integer + "key": "A String", # Key of the config variable. + "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "stringValue": "A String", # Value is a string. + }, + "enrichmentEnabled": True or False, # Enrichment Enabled. + "registrationDestinationConfig": { # Define the Connectors target endpoint. # Registration endpoint for auto regsitration. + "destinations": [ # The destinations for the key. + { + "host": "A String", # For publicly routable host. + "port": 42, # The port is the target port number that is accepted by the destination. + "serviceAttachment": "A String", # PSC service attachments. Format: projects/*/regions/*/serviceAttachments/* + }, + ], + "key": "A String", # The key is the destination identifier that is supported by the Connector. + }, + }, + "eventingEnablementType": "A String", # Optional. Eventing enablement type. Will be nil if eventing is not enabled. + "eventingRuntimeData": { # Eventing runtime data has the details related to eventing managed by the system. # Output only. Eventing Runtime Data. + "eventsListenerEndpoint": "A String", # Output only. Events listener endpoint. The value will populated after provisioning the events listener. + "status": { # EventingStatus indicates the state of eventing. # Output only. Current status of eventing. + "description": "A String", # Output only. Description of error if State is set to "ERROR". + "state": "A String", # Output only. State. + }, + }, "imageLocation": "A String", # Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName} "labels": { # Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources "a_key": "A String", @@ -1027,6 +1503,47 @@

Method Details

}
+
+ repairEventing(name, body=None, x__xgafv=None) +
RepaiEventing tries to repair eventing related event subscriptions.
+
+Args:
+  name: string, Required. Resource name of the form: `projects/*/locations/*/connections/*` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for ConnectorsService.RepairEventing
+}
+
+  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.
+  },
+}
+
+
setIamPolicy(resource, body=None, x__xgafv=None)
Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
diff --git a/docs/dyn/connectors_v1.projects.locations.global_.html b/docs/dyn/connectors_v1.projects.locations.global_.html
index 738fb37d38f..8875a8efe78 100644
--- a/docs/dyn/connectors_v1.projects.locations.global_.html
+++ b/docs/dyn/connectors_v1.projects.locations.global_.html
@@ -85,6 +85,9 @@ 

Instance Methods

getSettings(name, x__xgafv=None)

GetGlobalSettings gets settings of a project. GlobalSettings is a singleton resource.

+

+ updateSettings(name, body=None, updateMask=None, x__xgafv=None)

+

Update the global settings of a project.

Method Details

close() @@ -113,4 +116,50 @@

Method Details

}
+
+ updateSettings(name, body=None, updateMask=None, x__xgafv=None) +
Update the global settings of a project.
+
+Args:
+  name: string, Output only. Resource name of the Connection. Format: projects/{project}/locations/global/settings} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Global Settings details.
+  "name": "A String", # Output only. Resource name of the Connection. Format: projects/{project}/locations/global/settings}
+  "payg": True or False, # Output only. Flag indicates if user is in PayG model
+  "tenantProjectId": "A String", # Output only. Tenant project id of the consumer project.
+  "vpcsc": True or False, # Optional. Flag indicates whether vpc-sc is enabled.
+}
+
+  updateMask: string, Required. The list of fields to update.
+  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.
+  },
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/connectors_v1.projects.locations.providers.connectors.html b/docs/dyn/connectors_v1.projects.locations.providers.connectors.html index 8a3f95685b5..286b5447e55 100644 --- a/docs/dyn/connectors_v1.projects.locations.providers.connectors.html +++ b/docs/dyn/connectors_v1.projects.locations.providers.connectors.html @@ -116,6 +116,17 @@

Method Details

"description": "A String", # Output only. Description of the resource. "displayName": "A String", # Output only. Display name. "documentationUri": "A String", # Output only. Link to documentation page. + "eventingDetails": { # Eventing Details message. # Output only. Eventing details. Will be null if eventing is not supported. + "customEventTypes": True or False, # Output only. Custom Event Types. + "description": "A String", # Output only. Description. + "documentationLink": "A String", # Output only. Link to public documentation. + "iconLocation": "A String", # Output only. Cloud storage location of the icon. + "launchStage": "A String", # Output only. Eventing Launch Stage. + "name": "A String", # Output only. Name of the Eventing trigger. + "searchTags": [ # Output only. Array of search keywords. + "A String", + ], + }, "externalUri": "A String", # Output only. Link to external page. "labels": { # Output only. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources "a_key": "A String", @@ -151,6 +162,17 @@

Method Details

"description": "A String", # Output only. Description of the resource. "displayName": "A String", # Output only. Display name. "documentationUri": "A String", # Output only. Link to documentation page. + "eventingDetails": { # Eventing Details message. # Output only. Eventing details. Will be null if eventing is not supported. + "customEventTypes": True or False, # Output only. Custom Event Types. + "description": "A String", # Output only. Description. + "documentationLink": "A String", # Output only. Link to public documentation. + "iconLocation": "A String", # Output only. Cloud storage location of the icon. + "launchStage": "A String", # Output only. Eventing Launch Stage. + "name": "A String", # Output only. Name of the Eventing trigger. + "searchTags": [ # Output only. Array of search keywords. + "A String", + ], + }, "externalUri": "A String", # Output only. Link to external page. "labels": { # Output only. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources "a_key": "A String", diff --git a/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.eventtypes.html b/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.eventtypes.html new file mode 100644 index 00000000000..88b5674427d --- /dev/null +++ b/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.eventtypes.html @@ -0,0 +1,168 @@ + + + +

Connectors API . projects . locations . providers . connectors . versions . eventtypes

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets details of a single event type.

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists Event Types in a given Connector Version.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets details of a single event type.
+
+Args:
+  name: string, Required. Resource name of the form: `projects/*/locations/*/providers/*/connectors/*/versions/*/eventtypes/*` Only global location is supported for EventType resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # EventType includes fields.
+  "createTime": "A String", # Output only. Created time.
+  "enrichedEventPayloadSchema": "A String", # Output only. Schema of the event payload after enriched. Will be null if read before send is not supported.
+  "entityType": "A String", # Output only. Runtime entity type name. Will be null if entity type map is not available. Used for read before send feature.
+  "eventPayloadSchema": "A String", # Output only. Schema of webhook event payload.
+  "eventTypeId": "A String", # Output only. Event type id. Example: `ticket.created`.
+  "idPath": "A String", # Output only. Id path denotes the path of id in webhook payload.
+  "name": "A String", # Output only. Resource name of the eventtype. Format: projects/{project}/locations/{location}/providers/{provider}/connectors/{connector}/versions/{version}/eventtypes/{eventtype} Only global location is supported for Connector resource.
+  "updateTime": "A String", # Output only. Updated time.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists Event Types in a given Connector Version.
+
+Args:
+  parent: string, Required. Parent resource of the connectors, of the form: `projects/*/locations/*/providers/*/connectors/*/versions/*` Only global location is supported for EventType resource. (required)
+  pageSize: integer, Page size.
+  pageToken: string, Page token.
+  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 Connectors.ListEventTypes.
+  "eventTypes": [ # A list of connector versions.
+    { # EventType includes fields.
+      "createTime": "A String", # Output only. Created time.
+      "enrichedEventPayloadSchema": "A String", # Output only. Schema of the event payload after enriched. Will be null if read before send is not supported.
+      "entityType": "A String", # Output only. Runtime entity type name. Will be null if entity type map is not available. Used for read before send feature.
+      "eventPayloadSchema": "A String", # Output only. Schema of webhook event payload.
+      "eventTypeId": "A String", # Output only. Event type id. Example: `ticket.created`.
+      "idPath": "A String", # Output only. Id path denotes the path of id in webhook payload.
+      "name": "A String", # Output only. Resource name of the eventtype. Format: projects/{project}/locations/{location}/providers/{provider}/connectors/{connector}/versions/{version}/eventtypes/{eventtype} Only global location is supported for Connector resource.
+      "updateTime": "A String", # Output only. Updated time.
+    },
+  ],
+  "nextPageToken": "A String", # Next page token.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html b/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html index ef012166d30..fbdbcc4ff33 100644 --- a/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html +++ b/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html @@ -74,6 +74,11 @@

Connectors API . projects . locations . providers . connectors . versions

Instance Methods

+

+ eventtypes() +

+

Returns the eventtypes Resource.

+

close()

Close httplib2 connections.

@@ -224,6 +229,9 @@

Method Details

"valueType": "A String", # Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation. }, ], + "connectorInfraConfig": { # This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version # Output only. Infra configs supported by Connector. + "ratelimitThreshold": "A String", # Max QPS supported by the connector version before throttling of requests. + }, "createTime": "A String", # Output only. Created time. "destinationConfigTemplates": [ # Output only. List of destination configs needed to create a connection. { # DestinationConfigTemplate defines required destinations supported by the Connector. @@ -253,6 +261,185 @@

Method Details

], }, }, + "eventingConfigTemplate": { # Eventing Config details of a connector version. # Output only. Eventing configuration supported by the Connector. + "additionalVariables": [ # Additional fields that need to be rendered. + { # ConfigVariableTemplate provides metadata about a `ConfigVariable` that is used in a Connection. + "authorizationCodeLink": { # This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow. # Authorization code link options. To be populated if `ValueType` is `AUTHORIZATION_CODE` + "clientId": "A String", # The client ID assigned to the GCP Connectors OAuth app for the connector data source. + "enablePkce": True or False, # Whether to enable PKCE for the auth code flow. + "scopes": [ # The scopes for which the user will authorize GCP Connectors on the connector data source. + "A String", + ], + "uri": "A String", # The base URI the user must click to trigger the authorization code login flow. + }, + "description": "A String", # Description. + "displayName": "A String", # Display name of the parameter. + "enumOptions": [ # Enum options. To be populated if `ValueType` is `ENUM` + { # EnumOption definition + "displayName": "A String", # Display name of the option. + "id": "A String", # Id of the option. + }, + ], + "isAdvanced": True or False, # Indicates if current template is part of advanced settings + "key": "A String", # Key of the config variable. + "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. + "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. + "fieldComparisons": [ # A list of fields to be compared. + { # Field that needs to be compared. + "boolValue": True or False, # Boolean value + "comparator": "A String", # Comparator to use for comparing the field value. + "intValue": "A String", # Integer value + "key": "A String", # Key of the field. + "stringValue": "A String", # String value + }, + ], + "logicalExpressions": [ # A list of nested conditions to be compared. + # Object with schema name: LogicalExpression + ], + "logicalOperator": "A String", # The logical operator to use between the fields and conditions. + }, + "roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular GCP resource for the selected principal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Role grant configuration for the config variable. + "helperTextTemplate": "A String", # Template that UI can use to provide helper text to customers. + "principal": "A String", # Prinicipal/Identity for whom the role need to assigned. + "resource": { # Resource definition # Resource on which the roles needs to be granted for the principal. + "pathTemplate": "A String", # Template to uniquely represent a GCP resource in a format IAM expects This is a template that can have references to other values provided in the config variable template. + "type": "A String", # Different types of resource supported. + }, + "roles": [ # List of roles that need to be granted. + "A String", + ], + }, + "state": "A String", # State of the config variable. + "validationRegex": "A String", # Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`. + "valueType": "A String", # Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation. + }, + ], + "authConfigTemplates": [ # AuthConfigTemplates represents the auth values for the webhook adapter. + { # AuthConfigTemplate defines required field over an authentication type. + "authKey": "A String", # Identifier key for auth config + "authType": "A String", # The type of authentication configured. + "configVariableTemplates": [ # Config variables to describe an `AuthConfig` for a `Connection`. + { # ConfigVariableTemplate provides metadata about a `ConfigVariable` that is used in a Connection. + "authorizationCodeLink": { # This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow. # Authorization code link options. To be populated if `ValueType` is `AUTHORIZATION_CODE` + "clientId": "A String", # The client ID assigned to the GCP Connectors OAuth app for the connector data source. + "enablePkce": True or False, # Whether to enable PKCE for the auth code flow. + "scopes": [ # The scopes for which the user will authorize GCP Connectors on the connector data source. + "A String", + ], + "uri": "A String", # The base URI the user must click to trigger the authorization code login flow. + }, + "description": "A String", # Description. + "displayName": "A String", # Display name of the parameter. + "enumOptions": [ # Enum options. To be populated if `ValueType` is `ENUM` + { # EnumOption definition + "displayName": "A String", # Display name of the option. + "id": "A String", # Id of the option. + }, + ], + "isAdvanced": True or False, # Indicates if current template is part of advanced settings + "key": "A String", # Key of the config variable. + "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. + "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. + "fieldComparisons": [ # A list of fields to be compared. + { # Field that needs to be compared. + "boolValue": True or False, # Boolean value + "comparator": "A String", # Comparator to use for comparing the field value. + "intValue": "A String", # Integer value + "key": "A String", # Key of the field. + "stringValue": "A String", # String value + }, + ], + "logicalExpressions": [ # A list of nested conditions to be compared. + # Object with schema name: LogicalExpression + ], + "logicalOperator": "A String", # The logical operator to use between the fields and conditions. + }, + "roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular GCP resource for the selected principal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Role grant configuration for the config variable. + "helperTextTemplate": "A String", # Template that UI can use to provide helper text to customers. + "principal": "A String", # Prinicipal/Identity for whom the role need to assigned. + "resource": { # Resource definition # Resource on which the roles needs to be granted for the principal. + "pathTemplate": "A String", # Template to uniquely represent a GCP resource in a format IAM expects This is a template that can have references to other values provided in the config variable template. + "type": "A String", # Different types of resource supported. + }, + "roles": [ # List of roles that need to be granted. + "A String", + ], + }, + "state": "A String", # State of the config variable. + "validationRegex": "A String", # Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`. + "valueType": "A String", # Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation. + }, + ], + "description": "A String", # Connector specific description for an authentication template. + "displayName": "A String", # Display name for authentication template. + }, + ], + "autoRefresh": True or False, # Auto refresh to extend webhook life. + "autoRegistrationSupported": True or False, # Auto Registration supported. + "encryptionKeyTemplate": { # ConfigVariableTemplate provides metadata about a `ConfigVariable` that is used in a Connection. # Encryption key (can be either Google managed or CMEK). + "authorizationCodeLink": { # This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow. # Authorization code link options. To be populated if `ValueType` is `AUTHORIZATION_CODE` + "clientId": "A String", # The client ID assigned to the GCP Connectors OAuth app for the connector data source. + "enablePkce": True or False, # Whether to enable PKCE for the auth code flow. + "scopes": [ # The scopes for which the user will authorize GCP Connectors on the connector data source. + "A String", + ], + "uri": "A String", # The base URI the user must click to trigger the authorization code login flow. + }, + "description": "A String", # Description. + "displayName": "A String", # Display name of the parameter. + "enumOptions": [ # Enum options. To be populated if `ValueType` is `ENUM` + { # EnumOption definition + "displayName": "A String", # Display name of the option. + "id": "A String", # Id of the option. + }, + ], + "isAdvanced": True or False, # Indicates if current template is part of advanced settings + "key": "A String", # Key of the config variable. + "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. + "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. + "fieldComparisons": [ # A list of fields to be compared. + { # Field that needs to be compared. + "boolValue": True or False, # Boolean value + "comparator": "A String", # Comparator to use for comparing the field value. + "intValue": "A String", # Integer value + "key": "A String", # Key of the field. + "stringValue": "A String", # String value + }, + ], + "logicalExpressions": [ # A list of nested conditions to be compared. + # Object with schema name: LogicalExpression + ], + "logicalOperator": "A String", # The logical operator to use between the fields and conditions. + }, + "roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular GCP resource for the selected principal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Role grant configuration for the config variable. + "helperTextTemplate": "A String", # Template that UI can use to provide helper text to customers. + "principal": "A String", # Prinicipal/Identity for whom the role need to assigned. + "resource": { # Resource definition # Resource on which the roles needs to be granted for the principal. + "pathTemplate": "A String", # Template to uniquely represent a GCP resource in a format IAM expects This is a template that can have references to other values provided in the config variable template. + "type": "A String", # Different types of resource supported. + }, + "roles": [ # List of roles that need to be granted. + "A String", + ], + }, + "state": "A String", # State of the config variable. + "validationRegex": "A String", # Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`. + "valueType": "A String", # Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation. + }, + "enrichmentSupported": True or False, # Enrichment Supported. + "isEventingSupported": True or False, # Is Eventing Supported. + "registrationDestinationConfig": { # DestinationConfigTemplate defines required destinations supported by the Connector. # Registration host destination config template. + "defaultPort": 42, # The default port. + "description": "A String", # Description. + "displayName": "A String", # Display name of the parameter. + "isAdvanced": True or False, # Whether the current destination tempalate is part of Advanced settings + "key": "A String", # Key of the destination. + "max": 42, # The maximum number of destinations supported for this key. + "min": 42, # The minimum number of destinations supported for this key. + "portFieldType": "A String", # Whether port number should be provided by customers. + "regexPattern": "A String", # Regex pattern for host. + }, + }, "labels": { # Output only. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources "a_key": "A String", }, @@ -490,6 +677,9 @@

Method Details

"valueType": "A String", # Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation. }, ], + "connectorInfraConfig": { # This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version # Output only. Infra configs supported by Connector. + "ratelimitThreshold": "A String", # Max QPS supported by the connector version before throttling of requests. + }, "createTime": "A String", # Output only. Created time. "destinationConfigTemplates": [ # Output only. List of destination configs needed to create a connection. { # DestinationConfigTemplate defines required destinations supported by the Connector. @@ -519,6 +709,185 @@

Method Details

], }, }, + "eventingConfigTemplate": { # Eventing Config details of a connector version. # Output only. Eventing configuration supported by the Connector. + "additionalVariables": [ # Additional fields that need to be rendered. + { # ConfigVariableTemplate provides metadata about a `ConfigVariable` that is used in a Connection. + "authorizationCodeLink": { # This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow. # Authorization code link options. To be populated if `ValueType` is `AUTHORIZATION_CODE` + "clientId": "A String", # The client ID assigned to the GCP Connectors OAuth app for the connector data source. + "enablePkce": True or False, # Whether to enable PKCE for the auth code flow. + "scopes": [ # The scopes for which the user will authorize GCP Connectors on the connector data source. + "A String", + ], + "uri": "A String", # The base URI the user must click to trigger the authorization code login flow. + }, + "description": "A String", # Description. + "displayName": "A String", # Display name of the parameter. + "enumOptions": [ # Enum options. To be populated if `ValueType` is `ENUM` + { # EnumOption definition + "displayName": "A String", # Display name of the option. + "id": "A String", # Id of the option. + }, + ], + "isAdvanced": True or False, # Indicates if current template is part of advanced settings + "key": "A String", # Key of the config variable. + "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. + "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. + "fieldComparisons": [ # A list of fields to be compared. + { # Field that needs to be compared. + "boolValue": True or False, # Boolean value + "comparator": "A String", # Comparator to use for comparing the field value. + "intValue": "A String", # Integer value + "key": "A String", # Key of the field. + "stringValue": "A String", # String value + }, + ], + "logicalExpressions": [ # A list of nested conditions to be compared. + # Object with schema name: LogicalExpression + ], + "logicalOperator": "A String", # The logical operator to use between the fields and conditions. + }, + "roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular GCP resource for the selected principal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Role grant configuration for the config variable. + "helperTextTemplate": "A String", # Template that UI can use to provide helper text to customers. + "principal": "A String", # Prinicipal/Identity for whom the role need to assigned. + "resource": { # Resource definition # Resource on which the roles needs to be granted for the principal. + "pathTemplate": "A String", # Template to uniquely represent a GCP resource in a format IAM expects This is a template that can have references to other values provided in the config variable template. + "type": "A String", # Different types of resource supported. + }, + "roles": [ # List of roles that need to be granted. + "A String", + ], + }, + "state": "A String", # State of the config variable. + "validationRegex": "A String", # Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`. + "valueType": "A String", # Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation. + }, + ], + "authConfigTemplates": [ # AuthConfigTemplates represents the auth values for the webhook adapter. + { # AuthConfigTemplate defines required field over an authentication type. + "authKey": "A String", # Identifier key for auth config + "authType": "A String", # The type of authentication configured. + "configVariableTemplates": [ # Config variables to describe an `AuthConfig` for a `Connection`. + { # ConfigVariableTemplate provides metadata about a `ConfigVariable` that is used in a Connection. + "authorizationCodeLink": { # This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow. # Authorization code link options. To be populated if `ValueType` is `AUTHORIZATION_CODE` + "clientId": "A String", # The client ID assigned to the GCP Connectors OAuth app for the connector data source. + "enablePkce": True or False, # Whether to enable PKCE for the auth code flow. + "scopes": [ # The scopes for which the user will authorize GCP Connectors on the connector data source. + "A String", + ], + "uri": "A String", # The base URI the user must click to trigger the authorization code login flow. + }, + "description": "A String", # Description. + "displayName": "A String", # Display name of the parameter. + "enumOptions": [ # Enum options. To be populated if `ValueType` is `ENUM` + { # EnumOption definition + "displayName": "A String", # Display name of the option. + "id": "A String", # Id of the option. + }, + ], + "isAdvanced": True or False, # Indicates if current template is part of advanced settings + "key": "A String", # Key of the config variable. + "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. + "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. + "fieldComparisons": [ # A list of fields to be compared. + { # Field that needs to be compared. + "boolValue": True or False, # Boolean value + "comparator": "A String", # Comparator to use for comparing the field value. + "intValue": "A String", # Integer value + "key": "A String", # Key of the field. + "stringValue": "A String", # String value + }, + ], + "logicalExpressions": [ # A list of nested conditions to be compared. + # Object with schema name: LogicalExpression + ], + "logicalOperator": "A String", # The logical operator to use between the fields and conditions. + }, + "roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular GCP resource for the selected principal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Role grant configuration for the config variable. + "helperTextTemplate": "A String", # Template that UI can use to provide helper text to customers. + "principal": "A String", # Prinicipal/Identity for whom the role need to assigned. + "resource": { # Resource definition # Resource on which the roles needs to be granted for the principal. + "pathTemplate": "A String", # Template to uniquely represent a GCP resource in a format IAM expects This is a template that can have references to other values provided in the config variable template. + "type": "A String", # Different types of resource supported. + }, + "roles": [ # List of roles that need to be granted. + "A String", + ], + }, + "state": "A String", # State of the config variable. + "validationRegex": "A String", # Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`. + "valueType": "A String", # Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation. + }, + ], + "description": "A String", # Connector specific description for an authentication template. + "displayName": "A String", # Display name for authentication template. + }, + ], + "autoRefresh": True or False, # Auto refresh to extend webhook life. + "autoRegistrationSupported": True or False, # Auto Registration supported. + "encryptionKeyTemplate": { # ConfigVariableTemplate provides metadata about a `ConfigVariable` that is used in a Connection. # Encryption key (can be either Google managed or CMEK). + "authorizationCodeLink": { # This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow. # Authorization code link options. To be populated if `ValueType` is `AUTHORIZATION_CODE` + "clientId": "A String", # The client ID assigned to the GCP Connectors OAuth app for the connector data source. + "enablePkce": True or False, # Whether to enable PKCE for the auth code flow. + "scopes": [ # The scopes for which the user will authorize GCP Connectors on the connector data source. + "A String", + ], + "uri": "A String", # The base URI the user must click to trigger the authorization code login flow. + }, + "description": "A String", # Description. + "displayName": "A String", # Display name of the parameter. + "enumOptions": [ # Enum options. To be populated if `ValueType` is `ENUM` + { # EnumOption definition + "displayName": "A String", # Display name of the option. + "id": "A String", # Id of the option. + }, + ], + "isAdvanced": True or False, # Indicates if current template is part of advanced settings + "key": "A String", # Key of the config variable. + "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. + "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. + "fieldComparisons": [ # A list of fields to be compared. + { # Field that needs to be compared. + "boolValue": True or False, # Boolean value + "comparator": "A String", # Comparator to use for comparing the field value. + "intValue": "A String", # Integer value + "key": "A String", # Key of the field. + "stringValue": "A String", # String value + }, + ], + "logicalExpressions": [ # A list of nested conditions to be compared. + # Object with schema name: LogicalExpression + ], + "logicalOperator": "A String", # The logical operator to use between the fields and conditions. + }, + "roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular GCP resource for the selected principal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Role grant configuration for the config variable. + "helperTextTemplate": "A String", # Template that UI can use to provide helper text to customers. + "principal": "A String", # Prinicipal/Identity for whom the role need to assigned. + "resource": { # Resource definition # Resource on which the roles needs to be granted for the principal. + "pathTemplate": "A String", # Template to uniquely represent a GCP resource in a format IAM expects This is a template that can have references to other values provided in the config variable template. + "type": "A String", # Different types of resource supported. + }, + "roles": [ # List of roles that need to be granted. + "A String", + ], + }, + "state": "A String", # State of the config variable. + "validationRegex": "A String", # Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`. + "valueType": "A String", # Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation. + }, + "enrichmentSupported": True or False, # Enrichment Supported. + "isEventingSupported": True or False, # Is Eventing Supported. + "registrationDestinationConfig": { # DestinationConfigTemplate defines required destinations supported by the Connector. # Registration host destination config template. + "defaultPort": 42, # The default port. + "description": "A String", # Description. + "displayName": "A String", # Display name of the parameter. + "isAdvanced": True or False, # Whether the current destination tempalate is part of Advanced settings + "key": "A String", # Key of the destination. + "max": 42, # The maximum number of destinations supported for this key. + "min": 42, # The minimum number of destinations supported for this key. + "portFieldType": "A String", # Whether port number should be provided by customers. + "regexPattern": "A String", # Regex pattern for host. + }, + }, "labels": { # Output only. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources "a_key": "A String", }, diff --git a/docs/dyn/container_v1.projects.locations.clusters.html b/docs/dyn/container_v1.projects.locations.clusters.html index 6ef4ca33c49..6eba0b18ee9 100644 --- a/docs/dyn/container_v1.projects.locations.clusters.html +++ b/docs/dyn/container_v1.projects.locations.clusters.html @@ -436,7 +436,7 @@

Method Details

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false. "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true. - "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "ipv6AccessType": "A String", # The ipv6 access type (internal or external) when create_subnetwork is true "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block. "nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. @@ -522,6 +522,10 @@

Method Details

"enableCertificates": True or False, # enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty). }, "monitoringConfig": { # MonitoringConfig is cluster monitoring configuration. # Monitoring configuration for the cluster. + "advancedDatapathObservabilityConfig": { # AdvancedDatapathObservabilityConfig specifies configuration of observability features of advanced datapath. # Configuration of Advanced Datapath Observability features. + "enableMetrics": True or False, # Expose flow metrics on nodes + "relayMode": "A String", # Method used to make Relay available + }, "componentConfig": { # MonitoringComponentConfig is cluster monitoring component configuration. # Monitoring components configuration "enableComponents": [ # Select components to collect metrics. An empty set would disable all monitoring. "A String", @@ -874,7 +878,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -1293,7 +1297,7 @@

Method Details

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false. "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true. - "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "ipv6AccessType": "A String", # The ipv6 access type (internal or external) when create_subnetwork is true "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block. "nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. @@ -1379,6 +1383,10 @@

Method Details

"enableCertificates": True or False, # enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty). }, "monitoringConfig": { # MonitoringConfig is cluster monitoring configuration. # Monitoring configuration for the cluster. + "advancedDatapathObservabilityConfig": { # AdvancedDatapathObservabilityConfig specifies configuration of observability features of advanced datapath. # Configuration of Advanced Datapath Observability features. + "enableMetrics": True or False, # Expose flow metrics on nodes + "relayMode": "A String", # Method used to make Relay available + }, "componentConfig": { # MonitoringComponentConfig is cluster monitoring component configuration. # Monitoring components configuration "enableComponents": [ # Select components to collect metrics. An empty set would disable all monitoring. "A String", @@ -1731,7 +1739,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -2053,7 +2061,7 @@

Method Details

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false. "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true. - "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "ipv6AccessType": "A String", # The ipv6 access type (internal or external) when create_subnetwork is true "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block. "nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. @@ -2139,6 +2147,10 @@

Method Details

"enableCertificates": True or False, # enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty). }, "monitoringConfig": { # MonitoringConfig is cluster monitoring configuration. # Monitoring configuration for the cluster. + "advancedDatapathObservabilityConfig": { # AdvancedDatapathObservabilityConfig specifies configuration of observability features of advanced datapath. # Configuration of Advanced Datapath Observability features. + "enableMetrics": True or False, # Expose flow metrics on nodes + "relayMode": "A String", # Method used to make Relay available + }, "componentConfig": { # MonitoringComponentConfig is cluster monitoring component configuration. # Monitoring components configuration "enableComponents": [ # Select components to collect metrics. An empty set would disable all monitoring. "A String", @@ -2491,7 +2503,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -3649,6 +3661,10 @@

Method Details

"enableCertificates": True or False, # enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty). }, "desiredMonitoringConfig": { # MonitoringConfig is cluster monitoring configuration. # The desired monitoring configuration. + "advancedDatapathObservabilityConfig": { # AdvancedDatapathObservabilityConfig specifies configuration of observability features of advanced datapath. # Configuration of Advanced Datapath Observability features. + "enableMetrics": True or False, # Expose flow metrics on nodes + "relayMode": "A String", # Method used to make Relay available + }, "componentConfig": { # MonitoringComponentConfig is cluster monitoring component configuration. # Monitoring components configuration "enableComponents": [ # Select components to collect metrics. An empty set would disable all monitoring. "A String", diff --git a/docs/dyn/container_v1.projects.locations.clusters.nodePools.html b/docs/dyn/container_v1.projects.locations.clusters.nodePools.html index 9d653ddb349..50d497565d1 100644 --- a/docs/dyn/container_v1.projects.locations.clusters.nodePools.html +++ b/docs/dyn/container_v1.projects.locations.clusters.nodePools.html @@ -318,7 +318,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -681,7 +681,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -910,7 +910,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -1345,7 +1345,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "nodePoolId": "A String", # Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. diff --git a/docs/dyn/container_v1.projects.zones.clusters.html b/docs/dyn/container_v1.projects.zones.clusters.html index cfedb8f6405..ad0f9a37ccd 100644 --- a/docs/dyn/container_v1.projects.zones.clusters.html +++ b/docs/dyn/container_v1.projects.zones.clusters.html @@ -512,7 +512,7 @@

Method Details

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false. "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true. - "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "ipv6AccessType": "A String", # The ipv6 access type (internal or external) when create_subnetwork is true "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block. "nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. @@ -598,6 +598,10 @@

Method Details

"enableCertificates": True or False, # enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty). }, "monitoringConfig": { # MonitoringConfig is cluster monitoring configuration. # Monitoring configuration for the cluster. + "advancedDatapathObservabilityConfig": { # AdvancedDatapathObservabilityConfig specifies configuration of observability features of advanced datapath. # Configuration of Advanced Datapath Observability features. + "enableMetrics": True or False, # Expose flow metrics on nodes + "relayMode": "A String", # Method used to make Relay available + }, "componentConfig": { # MonitoringComponentConfig is cluster monitoring component configuration. # Monitoring components configuration "enableComponents": [ # Select components to collect metrics. An empty set would disable all monitoring. "A String", @@ -950,7 +954,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -1369,7 +1373,7 @@

Method Details

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false. "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true. - "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "ipv6AccessType": "A String", # The ipv6 access type (internal or external) when create_subnetwork is true "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block. "nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. @@ -1455,6 +1459,10 @@

Method Details

"enableCertificates": True or False, # enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty). }, "monitoringConfig": { # MonitoringConfig is cluster monitoring configuration. # Monitoring configuration for the cluster. + "advancedDatapathObservabilityConfig": { # AdvancedDatapathObservabilityConfig specifies configuration of observability features of advanced datapath. # Configuration of Advanced Datapath Observability features. + "enableMetrics": True or False, # Expose flow metrics on nodes + "relayMode": "A String", # Method used to make Relay available + }, "componentConfig": { # MonitoringComponentConfig is cluster monitoring component configuration. # Monitoring components configuration "enableComponents": [ # Select components to collect metrics. An empty set would disable all monitoring. "A String", @@ -1807,7 +1815,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -2173,7 +2181,7 @@

Method Details

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false. "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true. - "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "ipv6AccessType": "A String", # The ipv6 access type (internal or external) when create_subnetwork is true "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block. "nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. @@ -2259,6 +2267,10 @@

Method Details

"enableCertificates": True or False, # enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty). }, "monitoringConfig": { # MonitoringConfig is cluster monitoring configuration. # Monitoring configuration for the cluster. + "advancedDatapathObservabilityConfig": { # AdvancedDatapathObservabilityConfig specifies configuration of observability features of advanced datapath. # Configuration of Advanced Datapath Observability features. + "enableMetrics": True or False, # Expose flow metrics on nodes + "relayMode": "A String", # Method used to make Relay available + }, "componentConfig": { # MonitoringComponentConfig is cluster monitoring component configuration. # Monitoring components configuration "enableComponents": [ # Select components to collect metrics. An empty set would disable all monitoring. "A String", @@ -2611,7 +2623,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -3676,6 +3688,10 @@

Method Details

"enableCertificates": True or False, # enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty). }, "desiredMonitoringConfig": { # MonitoringConfig is cluster monitoring configuration. # The desired monitoring configuration. + "advancedDatapathObservabilityConfig": { # AdvancedDatapathObservabilityConfig specifies configuration of observability features of advanced datapath. # Configuration of Advanced Datapath Observability features. + "enableMetrics": True or False, # Expose flow metrics on nodes + "relayMode": "A String", # Method used to make Relay available + }, "componentConfig": { # MonitoringComponentConfig is cluster monitoring component configuration. # Monitoring components configuration "enableComponents": [ # Select components to collect metrics. An empty set would disable all monitoring. "A String", diff --git a/docs/dyn/container_v1.projects.zones.clusters.nodePools.html b/docs/dyn/container_v1.projects.zones.clusters.nodePools.html index 9c7e853f651..dd0a4c9b0ce 100644 --- a/docs/dyn/container_v1.projects.zones.clusters.nodePools.html +++ b/docs/dyn/container_v1.projects.zones.clusters.nodePools.html @@ -383,7 +383,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -746,7 +746,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -975,7 +975,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -1335,7 +1335,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "nodePoolId": "A String", # Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. diff --git a/docs/dyn/container_v1beta1.projects.locations.clusters.html b/docs/dyn/container_v1beta1.projects.locations.clusters.html index 2405e6d5bc9..3bdb318fe2e 100644 --- a/docs/dyn/container_v1beta1.projects.locations.clusters.html +++ b/docs/dyn/container_v1beta1.projects.locations.clusters.html @@ -447,7 +447,7 @@

Method Details

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases and create_subnetwork is false. "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true. - "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "ipv6AccessType": "A String", # The ipv6 access type (internal or external) when create_subnetwork is true "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block. "nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. @@ -536,6 +536,10 @@

Method Details

"enableCertificates": True or False, # enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty). }, "monitoringConfig": { # MonitoringConfig is cluster monitoring configuration. # Monitoring configuration for the cluster. + "advancedDatapathObservabilityConfig": { # AdvancedDatapathObservabilityConfig specifies configuration of observability features of advanced datapath. # Configuration of Advanced Datapath Observability features. + "enableMetrics": True or False, # Expose flow metrics on nodes + "relayMode": "A String", # Method used to make Relay available + }, "componentConfig": { # MonitoringComponentConfig is cluster monitoring component configuration. # Monitoring components configuration "enableComponents": [ # Select components to collect metrics. An empty set would disable all monitoring. "A String", @@ -901,7 +905,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -1355,7 +1359,7 @@

Method Details

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases and create_subnetwork is false. "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true. - "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "ipv6AccessType": "A String", # The ipv6 access type (internal or external) when create_subnetwork is true "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block. "nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. @@ -1444,6 +1448,10 @@

Method Details

"enableCertificates": True or False, # enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty). }, "monitoringConfig": { # MonitoringConfig is cluster monitoring configuration. # Monitoring configuration for the cluster. + "advancedDatapathObservabilityConfig": { # AdvancedDatapathObservabilityConfig specifies configuration of observability features of advanced datapath. # Configuration of Advanced Datapath Observability features. + "enableMetrics": True or False, # Expose flow metrics on nodes + "relayMode": "A String", # Method used to make Relay available + }, "componentConfig": { # MonitoringComponentConfig is cluster monitoring component configuration. # Monitoring components configuration "enableComponents": [ # Select components to collect metrics. An empty set would disable all monitoring. "A String", @@ -1809,7 +1817,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -2166,7 +2174,7 @@

Method Details

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases and create_subnetwork is false. "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true. - "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "ipv6AccessType": "A String", # The ipv6 access type (internal or external) when create_subnetwork is true "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block. "nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. @@ -2255,6 +2263,10 @@

Method Details

"enableCertificates": True or False, # enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty). }, "monitoringConfig": { # MonitoringConfig is cluster monitoring configuration. # Monitoring configuration for the cluster. + "advancedDatapathObservabilityConfig": { # AdvancedDatapathObservabilityConfig specifies configuration of observability features of advanced datapath. # Configuration of Advanced Datapath Observability features. + "enableMetrics": True or False, # Expose flow metrics on nodes + "relayMode": "A String", # Method used to make Relay available + }, "componentConfig": { # MonitoringComponentConfig is cluster monitoring component configuration. # Monitoring components configuration "enableComponents": [ # Select components to collect metrics. An empty set would disable all monitoring. "A String", @@ -2620,7 +2632,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -3821,6 +3833,10 @@

Method Details

"enableCertificates": True or False, # enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty). }, "desiredMonitoringConfig": { # MonitoringConfig is cluster monitoring configuration. # The desired monitoring configuration. + "advancedDatapathObservabilityConfig": { # AdvancedDatapathObservabilityConfig specifies configuration of observability features of advanced datapath. # Configuration of Advanced Datapath Observability features. + "enableMetrics": True or False, # Expose flow metrics on nodes + "relayMode": "A String", # Method used to make Relay available + }, "componentConfig": { # MonitoringComponentConfig is cluster monitoring component configuration. # Monitoring components configuration "enableComponents": [ # Select components to collect metrics. An empty set would disable all monitoring. "A String", diff --git a/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html b/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html index baa19fac7be..45dbd5427ff 100644 --- a/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html +++ b/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html @@ -325,7 +325,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -696,7 +696,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -933,7 +933,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -1370,7 +1370,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "nodePoolId": "A String", # Required. Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.html b/docs/dyn/container_v1beta1.projects.zones.clusters.html index bd1d89cb54d..60a5346c592 100644 --- a/docs/dyn/container_v1beta1.projects.zones.clusters.html +++ b/docs/dyn/container_v1beta1.projects.zones.clusters.html @@ -530,7 +530,7 @@

Method Details

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases and create_subnetwork is false. "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true. - "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "ipv6AccessType": "A String", # The ipv6 access type (internal or external) when create_subnetwork is true "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block. "nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. @@ -619,6 +619,10 @@

Method Details

"enableCertificates": True or False, # enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty). }, "monitoringConfig": { # MonitoringConfig is cluster monitoring configuration. # Monitoring configuration for the cluster. + "advancedDatapathObservabilityConfig": { # AdvancedDatapathObservabilityConfig specifies configuration of observability features of advanced datapath. # Configuration of Advanced Datapath Observability features. + "enableMetrics": True or False, # Expose flow metrics on nodes + "relayMode": "A String", # Method used to make Relay available + }, "componentConfig": { # MonitoringComponentConfig is cluster monitoring component configuration. # Monitoring components configuration "enableComponents": [ # Select components to collect metrics. An empty set would disable all monitoring. "A String", @@ -984,7 +988,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -1438,7 +1442,7 @@

Method Details

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases and create_subnetwork is false. "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true. - "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "ipv6AccessType": "A String", # The ipv6 access type (internal or external) when create_subnetwork is true "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block. "nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. @@ -1527,6 +1531,10 @@

Method Details

"enableCertificates": True or False, # enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty). }, "monitoringConfig": { # MonitoringConfig is cluster monitoring configuration. # Monitoring configuration for the cluster. + "advancedDatapathObservabilityConfig": { # AdvancedDatapathObservabilityConfig specifies configuration of observability features of advanced datapath. # Configuration of Advanced Datapath Observability features. + "enableMetrics": True or False, # Expose flow metrics on nodes + "relayMode": "A String", # Method used to make Relay available + }, "componentConfig": { # MonitoringComponentConfig is cluster monitoring component configuration. # Monitoring components configuration "enableComponents": [ # Select components to collect metrics. An empty set would disable all monitoring. "A String", @@ -1892,7 +1900,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -2293,7 +2301,7 @@

Method Details

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases and create_subnetwork is false. "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true. - "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "ipv6AccessType": "A String", # The ipv6 access type (internal or external) when create_subnetwork is true "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block. "nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. @@ -2382,6 +2390,10 @@

Method Details

"enableCertificates": True or False, # enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty). }, "monitoringConfig": { # MonitoringConfig is cluster monitoring configuration. # Monitoring configuration for the cluster. + "advancedDatapathObservabilityConfig": { # AdvancedDatapathObservabilityConfig specifies configuration of observability features of advanced datapath. # Configuration of Advanced Datapath Observability features. + "enableMetrics": True or False, # Expose flow metrics on nodes + "relayMode": "A String", # Method used to make Relay available + }, "componentConfig": { # MonitoringComponentConfig is cluster monitoring component configuration. # Monitoring components configuration "enableComponents": [ # Select components to collect metrics. An empty set would disable all monitoring. "A String", @@ -2747,7 +2759,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -3848,6 +3860,10 @@

Method Details

"enableCertificates": True or False, # enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty). }, "desiredMonitoringConfig": { # MonitoringConfig is cluster monitoring configuration. # The desired monitoring configuration. + "advancedDatapathObservabilityConfig": { # AdvancedDatapathObservabilityConfig specifies configuration of observability features of advanced datapath. # Configuration of Advanced Datapath Observability features. + "enableMetrics": True or False, # Expose flow metrics on nodes + "relayMode": "A String", # Method used to make Relay available + }, "componentConfig": { # MonitoringComponentConfig is cluster monitoring component configuration. # Monitoring components configuration "enableComponents": [ # Select components to collect metrics. An empty set would disable all monitoring. "A String", diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html b/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html index 9f1e38a4562..0e70ee155e7 100644 --- a/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html +++ b/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html @@ -390,7 +390,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -761,7 +761,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -998,7 +998,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -1360,7 +1360,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "nodePoolId": "A String", # Required. Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. diff --git a/docs/dyn/dataflow_v1b3.projects.locations.templates.html b/docs/dyn/dataflow_v1b3.projects.locations.templates.html index a3cb4b62875..9ba99934aab 100644 --- a/docs/dyn/dataflow_v1b3.projects.locations.templates.html +++ b/docs/dyn/dataflow_v1b3.projects.locations.templates.html @@ -111,6 +111,7 @@

Method Details

"a_key": "A String", }, "bypassTempDirValidation": True or False, # Optional. Whether to bypass the safety checks for the job's temporary directory. Use with caution. + "diskSizeGb": 42, # Optional. The disk size, in gigabytes, to use on each remote Compute Engine worker instance. "enableStreamingEngine": True or False, # Optional. Whether to enable Streaming Engine for the job. "ipConfiguration": "A String", # Optional. Configuration for VM IPs. "kmsKeyName": "A String", # Optional. Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/ @@ -566,6 +567,7 @@

Method Details

"a_key": "A String", }, "bypassTempDirValidation": True or False, # Optional. Whether to bypass the safety checks for the job's temporary directory. Use with caution. + "diskSizeGb": 42, # Optional. The disk size, in gigabytes, to use on each remote Compute Engine worker instance. "enableStreamingEngine": True or False, # Optional. Whether to enable Streaming Engine for the job. "ipConfiguration": "A String", # Optional. Configuration for VM IPs. "kmsKeyName": "A String", # Optional. Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/ diff --git a/docs/dyn/dataflow_v1b3.projects.templates.html b/docs/dyn/dataflow_v1b3.projects.templates.html index 4d27f1b1ce8..da691740ffc 100644 --- a/docs/dyn/dataflow_v1b3.projects.templates.html +++ b/docs/dyn/dataflow_v1b3.projects.templates.html @@ -110,6 +110,7 @@

Method Details

"a_key": "A String", }, "bypassTempDirValidation": True or False, # Optional. Whether to bypass the safety checks for the job's temporary directory. Use with caution. + "diskSizeGb": 42, # Optional. The disk size, in gigabytes, to use on each remote Compute Engine worker instance. "enableStreamingEngine": True or False, # Optional. Whether to enable Streaming Engine for the job. "ipConfiguration": "A String", # Optional. Configuration for VM IPs. "kmsKeyName": "A String", # Optional. Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/ @@ -564,6 +565,7 @@

Method Details

"a_key": "A String", }, "bypassTempDirValidation": True or False, # Optional. Whether to bypass the safety checks for the job's temporary directory. Use with caution. + "diskSizeGb": 42, # Optional. The disk size, in gigabytes, to use on each remote Compute Engine worker instance. "enableStreamingEngine": True or False, # Optional. Whether to enable Streaming Engine for the job. "ipConfiguration": "A String", # Optional. Configuration for VM IPs. "kmsKeyName": "A String", # Optional. Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/ diff --git a/docs/dyn/datamigration_v1.projects.locations.conversionWorkspaces.html b/docs/dyn/datamigration_v1.projects.locations.conversionWorkspaces.html index 466afa9859e..7bb0c5befae 100644 --- a/docs/dyn/datamigration_v1.projects.locations.conversionWorkspaces.html +++ b/docs/dyn/datamigration_v1.projects.locations.conversionWorkspaces.html @@ -101,7 +101,7 @@

Instance Methods

describeConversionWorkspaceRevisions(conversionWorkspace, commitId=None, x__xgafv=None)

Retrieves a list of committed revisions of a specific conversion workspace.

- describeDatabaseEntities(conversionWorkspace, commitId=None, filter=None, pageSize=None, pageToken=None, tree=None, uncommitted=None, x__xgafv=None)

+ describeDatabaseEntities(conversionWorkspace, commitId=None, filter=None, pageSize=None, pageToken=None, tree=None, uncommitted=None, view=None, x__xgafv=None)

Describes the database entities tree for a specific conversion workspace and a specific tree type. Database entities are not resources like conversion workspaces or mapping rules, and they can't be created, updated or deleted. Instead, they are simple data objects describing the structure of the client database.

describeDatabaseEntities_next()

@@ -147,7 +147,9 @@

Method Details

The object takes the form of: { # Request message for 'ApplyConversionWorkspace' request. - "connectionProfile": "A String", # Fully qualified (Uri) name of the destination connection profile. + "autoCommit": True or False, # Optional. Specifies whether the conversion workspace is to be committed automatically after the apply. + "connectionProfile": "A String", # Optional. Fully qualified (Uri) name of the destination connection profile. + "dryRun": True or False, # Optional. Only validates the apply process, but doesn't change the destination database. Only works for PostgreSQL destination connection profile. "filter": "A String", # Filter which entities to apply. Leaving this field empty will apply all of the entities. Supports Google AIP 160 based filtering. } @@ -237,8 +239,9 @@

Method Details

The object takes the form of: { # Request message for 'ConvertConversionWorkspace' request. - "autoCommit": True or False, # Specifies whether the conversion workspace is to be committed automatically after the conversion. - "filter": "A String", # Filter the entities to convert. Leaving this field empty will convert all of the entities. Supports Google AIP-160 style filtering. + "autoCommit": True or False, # Optional. Specifies whether the conversion workspace is to be committed automatically after the conversion. + "convertFullPath": True or False, # Optional. Automatically convert the full entity path for each entity specified by the filter. For example, if the filter specifies a table, that table schema (and database if there is one) will also be converted. + "filter": "A String", # Optional. Filter the entities to convert. Leaving this field empty will convert all of the entities. Supports Google AIP-160 style filtering. } x__xgafv: string, V1 error format. @@ -285,8 +288,8 @@

Method Details

"engine": "A String", # Required. Engine type. "version": "A String", # Required. Engine named version, for example 12.c.1. }, - "displayName": "A String", # The display name for the workspace. - "globalSettings": { # A generic list of settings for the workspace. The settings are database pair dependant and can indicate default behavior for the mapping rules engine or turn on or off specific features. Such examples can be: convert_foreign_key_to_interleave=true, skip_triggers=false, ignore_non_table_synonyms=true + "displayName": "A String", # Optional. The display name for the workspace. + "globalSettings": { # Optional. A generic list of settings for the workspace. The settings are database pair dependant and can indicate default behavior for the mapping rules engine or turn on or off specific features. Such examples can be: convert_foreign_key_to_interleave=true, skip_triggers=false, ignore_non_table_synonyms=true "a_key": "A String", }, "hasUncommittedChanges": True or False, # Output only. Whether the workspace has uncommitted changes (changes which were made after the workspace was committed). @@ -391,8 +394,8 @@

Method Details

"engine": "A String", # Required. Engine type. "version": "A String", # Required. Engine named version, for example 12.c.1. }, - "displayName": "A String", # The display name for the workspace. - "globalSettings": { # A generic list of settings for the workspace. The settings are database pair dependant and can indicate default behavior for the mapping rules engine or turn on or off specific features. Such examples can be: convert_foreign_key_to_interleave=true, skip_triggers=false, ignore_non_table_synonyms=true + "displayName": "A String", # Optional. The display name for the workspace. + "globalSettings": { # Optional. A generic list of settings for the workspace. The settings are database pair dependant and can indicate default behavior for the mapping rules engine or turn on or off specific features. Such examples can be: convert_foreign_key_to_interleave=true, skip_triggers=false, ignore_non_table_synonyms=true "a_key": "A String", }, "hasUncommittedChanges": True or False, # Output only. Whether the workspace has uncommitted changes (changes which were made after the workspace was committed). @@ -410,22 +413,28 @@

Method Details

- describeDatabaseEntities(conversionWorkspace, commitId=None, filter=None, pageSize=None, pageToken=None, tree=None, uncommitted=None, x__xgafv=None) + describeDatabaseEntities(conversionWorkspace, commitId=None, filter=None, pageSize=None, pageToken=None, tree=None, uncommitted=None, view=None, x__xgafv=None)
Describes the database entities tree for a specific conversion workspace and a specific tree type. Database entities are not resources like conversion workspaces or mapping rules, and they can't be created, updated or deleted. Instead, they are simple data objects describing the structure of the client database.
 
 Args:
   conversionWorkspace: string, Required. Name of the conversion workspace resource whose database entities are described. Must be in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}. (required)
-  commitId: string, Request a specific commit ID. If not specified, the entities from the latest commit are returned.
-  filter: string, Filter the returned entities based on AIP-160 standard.
-  pageSize: integer, The maximum number of entities to return. The service may return fewer entities than the value specifies.
-  pageToken: string, The nextPageToken value received in the previous call to conversionWorkspace.describeDatabaseEntities, used in the subsequent request to retrieve the next page of results. On first call this should be left blank. When paginating, all other parameters provided to conversionWorkspace.describeDatabaseEntities must match the call that provided the page token.
-  tree: string, The tree to fetch.
+  commitId: string, Optional. Request a specific commit ID. If not specified, the entities from the latest commit are returned.
+  filter: string, Optional. Filter the returned entities based on AIP-160 standard.
+  pageSize: integer, Optional. The maximum number of entities to return. The service may return fewer entities than the value specifies.
+  pageToken: string, Optional. The nextPageToken value received in the previous call to conversionWorkspace.describeDatabaseEntities, used in the subsequent request to retrieve the next page of results. On first call this should be left blank. When paginating, all other parameters provided to conversionWorkspace.describeDatabaseEntities must match the call that provided the page token.
+  tree: string, Required. The tree to fetch.
     Allowed values
       DB_TREE_TYPE_UNSPECIFIED - Unspecified tree type.
       SOURCE_TREE - The source database tree.
       DRAFT_TREE - The draft database tree.
       DESTINATION_TREE - The destination database tree.
-  uncommitted: boolean, Whether to retrieve the latest committed version of the entities or the latest version. This field is ignored if a specific commit_id is specified.
+  uncommitted: boolean, Optional. Whether to retrieve the latest committed version of the entities or the latest version. This field is ignored if a specific commit_id is specified.
+  view: string, Optional. Results view based on AIP-157
+    Allowed values
+      DATABASE_ENTITY_VIEW_UNSPECIFIED - Unspecified view. Defaults to basic view.
+      DATABASE_ENTITY_VIEW_BASIC - Default view. Does not return DDLs or Issues.
+      DATABASE_ENTITY_VIEW_FULL - Return full entity details including mappings, ddl and issues.
+      DATABASE_ENTITY_VIEW_ROOT_SUMMARY - Top-most (Database, Schema) nodes which are returned contains summary details for their decendents such as the number of entities per type and issues rollups. When this view is used, only a single page of result is returned and the page_size property of the request is ignored. The returned page will only include the top-most node types.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -437,6 +446,11 @@ 

Method Details

{ # Response message for 'DescribeDatabaseEntities' request. "databaseEntities": [ # The list of database entities for the conversion workspace. { # The base entity type for all the database related entities. The message contains the entity name, the name of its parent, the entity type, and the specific details per entity type. + "database": { # DatabaseInstance acts as a parent entity to other database entities. # Database. + "customFeatures": { # Custom engine specific features. + "a_key": "", # Properties of the object. + }, + }, "databaseFunction": { # Function's parent is a schema. # Function. "customFeatures": { # Custom engine specific features. "a_key": "", # Properties of the object. @@ -450,7 +464,35 @@

Method Details

"packageBody": "A String", # The SQL code which creates the package body. If the package specification has cursors or subprograms, then the package body is mandatory. "packageSqlCode": "A String", # The SQL code which creates the package. }, + "entityDdl": [ # Details about the entity DDL script. Multiple DDL scripts are provided for child entities such as a table entity will have one DDL for the table with additional DDLs for each index, constraint and such. + { # A single DDL statement for a specific entity + "ddl": "A String", # The actual ddl code. + "ddlType": "A String", # Type of DDL (Create, Alter). + "entity": "A String", # The name of the database entity the ddl refers to. + "entityType": "A String", # The entity type (if the DDL is for a sub entity). + "issueId": [ # EntityIssues found for this ddl. + "A String", + ], + }, + ], "entityType": "A String", # The type of the database entity (table, view, index, ...). + "issues": [ # Details about the various issues found for the entity. + { # Issue related to the entity. + "code": "A String", # Error/Warning code + "ddl": "A String", # The ddl which caused the issue, if relevant. + "entityType": "A String", # The entity type (if the DDL is for a sub entity). + "id": "A String", # Unique Issue ID. + "message": "A String", # Issue detailed message + "position": { # Issue position. # The position of the issue found, if relevant. + "column": 42, # Issue column number + "length": 42, # Issue length + "line": 42, # Issue line number + "offset": 42, # Issue offset + }, + "severity": "A String", # Severity of the issue + "type": "A String", # The type of the issue. + }, + ], "mappings": [ # Details about entity mappings. For source tree entities, this holds the draft entities which were generated by the mapping rules. For draft tree entities, this holds the source entities which were converted to form the draft entity. Destination entities will have no mapping details. { # Details of the mappings of a database entity. "draftEntity": "A String", # Target entity full name. The draft entity can also include a column, index or constraint using the same naming notation schema.table.column. @@ -466,6 +508,12 @@

Method Details

"sourceType": "A String", # Type of source entity. }, ], + "materializedView": { # MaterializedView's parent is a schema. # Materialized view. + "customFeatures": { # Custom engine specific features. + "a_key": "", # Properties of the object. + }, + "sqlCode": "A String", # The SQL code which creates the view. + }, "parentEntity": "A String", # The full name of the parent entity (e.g. schema name). "schema": { # Schema typically has no parent entity, but can have a parent entity DatabaseInstance (for database engines which support it). For some database engines, the terms schema and user can be used interchangeably when they refer to a namespace or a collection of other database entities. Can store additional information which is schema specific. # Schema. "customFeatures": { # Custom engine specific features. @@ -573,6 +621,13 @@

Method Details

], }, "tree": "A String", # The type of tree the entity belongs to. + "udt": { # UDT's parent is a schema. # UDT. + "customFeatures": { # Custom engine specific features. + "a_key": "", # Properties of the object. + }, + "udtBody": "A String", # The SQL code which creates the udt body. + "udtSqlCode": "A String", # The SQL code which creates the udt. + }, "view": { # View's parent is a schema. # View. "constraints": [ # View constraints. { # Constraint is not used as an independent entity, it is retrieved as part of another entity such as Table or View. @@ -636,8 +691,8 @@

Method Details

"engine": "A String", # Required. Engine type. "version": "A String", # Required. Engine named version, for example 12.c.1. }, - "displayName": "A String", # The display name for the workspace. - "globalSettings": { # A generic list of settings for the workspace. The settings are database pair dependant and can indicate default behavior for the mapping rules engine or turn on or off specific features. Such examples can be: convert_foreign_key_to_interleave=true, skip_triggers=false, ignore_non_table_synonyms=true + "displayName": "A String", # Optional. The display name for the workspace. + "globalSettings": { # Optional. A generic list of settings for the workspace. The settings are database pair dependant and can indicate default behavior for the mapping rules engine or turn on or off specific features. Such examples can be: convert_foreign_key_to_interleave=true, skip_triggers=false, ignore_non_table_synonyms=true "a_key": "A String", }, "hasUncommittedChanges": True or False, # Output only. Whether the workspace has uncommitted changes (changes which were made after the workspace was committed). @@ -725,8 +780,8 @@

Method Details

"engine": "A String", # Required. Engine type. "version": "A String", # Required. Engine named version, for example 12.c.1. }, - "displayName": "A String", # The display name for the workspace. - "globalSettings": { # A generic list of settings for the workspace. The settings are database pair dependant and can indicate default behavior for the mapping rules engine or turn on or off specific features. Such examples can be: convert_foreign_key_to_interleave=true, skip_triggers=false, ignore_non_table_synonyms=true + "displayName": "A String", # Optional. The display name for the workspace. + "globalSettings": { # Optional. A generic list of settings for the workspace. The settings are database pair dependant and can indicate default behavior for the mapping rules engine or turn on or off specific features. Such examples can be: convert_foreign_key_to_interleave=true, skip_triggers=false, ignore_non_table_synonyms=true "a_key": "A String", }, "hasUncommittedChanges": True or False, # Output only. Whether the workspace has uncommitted changes (changes which were made after the workspace was committed). @@ -776,8 +831,8 @@

Method Details

"engine": "A String", # Required. Engine type. "version": "A String", # Required. Engine named version, for example 12.c.1. }, - "displayName": "A String", # The display name for the workspace. - "globalSettings": { # A generic list of settings for the workspace. The settings are database pair dependant and can indicate default behavior for the mapping rules engine or turn on or off specific features. Such examples can be: convert_foreign_key_to_interleave=true, skip_triggers=false, ignore_non_table_synonyms=true + "displayName": "A String", # Optional. The display name for the workspace. + "globalSettings": { # Optional. A generic list of settings for the workspace. The settings are database pair dependant and can indicate default behavior for the mapping rules engine or turn on or off specific features. Such examples can be: convert_foreign_key_to_interleave=true, skip_triggers=false, ignore_non_table_synonyms=true "a_key": "A String", }, "hasUncommittedChanges": True or False, # Output only. Whether the workspace has uncommitted changes (changes which were made after the workspace was committed). @@ -883,27 +938,27 @@

Method Details

{ # Response message for 'SearchBackgroundJobs' request. "jobs": [ # The list of conversion workspace mapping rules. { # Execution log of a background job. - "applyJobDetails": { # Details regarding an Apply background job. # Apply job details. - "connectionProfile": "A String", # The connection profile which was used for the apply job. - "filter": "A String", # AIP-160 based filter used to specify the entities to apply + "applyJobDetails": { # Details regarding an Apply background job. # Output only. Apply job details. + "connectionProfile": "A String", # Output only. The connection profile which was used for the apply job. + "filter": "A String", # Output only. AIP-160 based filter used to specify the entities to apply }, - "completionComment": "A String", # Job completion comment, such as how many entities were seeded, how many warnings were found during conversion, and similar information. - "completionState": "A String", # Job completion state, i.e. the final state after the job completed. - "convertJobDetails": { # Details regarding a Convert background job. # Convert job details. - "filter": "A String", # AIP-160 based filter used to specify the entities to convert + "completionComment": "A String", # Output only. Job completion comment, such as how many entities were seeded, how many warnings were found during conversion, and similar information. + "completionState": "A String", # Output only. Job completion state, i.e. the final state after the job completed. + "convertJobDetails": { # Details regarding a Convert background job. # Output only. Convert job details. + "filter": "A String", # Output only. AIP-160 based filter used to specify the entities to convert }, "finishTime": "A String", # The timestamp when the background job was finished. "id": "A String", # The background job log entry ID. - "importRulesJobDetails": { # Details regarding an Import Rules background job. # Import rules job details. - "fileFormat": "A String", # The requested file format. - "files": [ # File names used for the import rules job. + "importRulesJobDetails": { # Details regarding an Import Rules background job. # Output only. Import rules job details. + "fileFormat": "A String", # Output only. The requested file format. + "files": [ # Output only. File names used for the import rules job. "A String", ], }, "jobType": "A String", # The type of job that was executed. - "requestAutocommit": True or False, # Whether the client requested the conversion workspace to be committed after a successful completion of the job. - "seedJobDetails": { # Details regarding a Seed background job. # Seed job details. - "connectionProfile": "A String", # The connection profile which was used for the seed job. + "requestAutocommit": True or False, # Output only. Whether the client requested the conversion workspace to be committed after a successful completion of the job. + "seedJobDetails": { # Details regarding a Seed background job. # Output only. Seed job details. + "connectionProfile": "A String", # Output only. The connection profile which was used for the seed job. }, "startTime": "A String", # The timestamp when the background job was started. }, @@ -922,8 +977,8 @@

Method Details

{ # Request message for 'SeedConversionWorkspace' request. "autoCommit": True or False, # Should the conversion workspace be committed automatically after the seed operation. - "destinationConnectionProfile": "A String", # Fully qualified (Uri) name of the destination connection profile. - "sourceConnectionProfile": "A String", # Fully qualified (Uri) name of the source connection profile. + "destinationConnectionProfile": "A String", # Optional. Fully qualified (Uri) name of the destination connection profile. + "sourceConnectionProfile": "A String", # Optional. Fully qualified (Uri) name of the source connection profile. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/datamigration_v1.projects.locations.conversionWorkspaces.mappingRules.html b/docs/dyn/datamigration_v1.projects.locations.conversionWorkspaces.mappingRules.html index 804f29abf5b..dd67977a3ea 100644 --- a/docs/dyn/datamigration_v1.projects.locations.conversionWorkspaces.mappingRules.html +++ b/docs/dyn/datamigration_v1.projects.locations.conversionWorkspaces.mappingRules.html @@ -77,15 +77,525 @@

Instance Methods

close()

Close httplib2 connections.

+

+ create(parent, body=None, mappingRuleId=None, requestId=None, x__xgafv=None)

+

Creates a new mapping rule for a given conversion workspace.

+

+ delete(name, requestId=None, x__xgafv=None)

+

Deletes a single mapping rule.

+

+ get(name, x__xgafv=None)

+

Gets the details of a mapping rule.

import_(parent, body=None, x__xgafv=None)

Imports the mapping rules for a given conversion workspace. Supports various formats of external rules files.

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists the mapping rules for a specific conversion workspace.

+

+ list_next()

+

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
+
+ create(parent, body=None, mappingRuleId=None, requestId=None, x__xgafv=None) +
Creates a new mapping rule for a given conversion workspace.
+
+Args:
+  parent: string, Required. The parent which owns this collection of mapping rules. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Definition of a transformation that is to be applied to a group of entities in the source schema. Several such transformations can be applied to an entity sequentially to define the corresponding entity in the target schema.
+  "conditionalColumnSetValue": { # Options to configure rule type ConditionalColumnSetValue. The rule is used to transform the data which is being replicated/migrated. The rule filter field can refer to one or more entities. The rule scope can be one of: Column. # Optional. Rule to specify how the data contained in a column should be transformed (such as trimmed, rounded, etc) provided that the data meets certain criteria.
+    "customFeatures": { # Optional. Custom engine specific features.
+      "a_key": "", # Properties of the object.
+    },
+    "sourceNumericFilter": { # Filter for fixed point number data types such as NUMERIC/NUMBER # Optional. Optional filter on source column precision and scale. Used for fixed point numbers such as NUMERIC/NUMBER data types.
+      "numericFilterOption": "A String", # Required. Enum to set the option defining the datatypes numeric filter has to be applied to
+      "sourceMaxPrecisionFilter": 42, # Optional. The filter will match columns with precision smaller than or equal to this number.
+      "sourceMaxScaleFilter": 42, # Optional. The filter will match columns with scale smaller than or equal to this number.
+      "sourceMinPrecisionFilter": 42, # Optional. The filter will match columns with precision greater than or equal to this number.
+      "sourceMinScaleFilter": 42, # Optional. The filter will match columns with scale greater than or equal to this number.
+    },
+    "sourceTextFilter": { # Filter for text-based data types like varchar. # Optional. Optional filter on source column length. Used for text based data types like varchar.
+      "sourceMaxLengthFilter": "A String", # Optional. The filter will match columns with length smaller than or equal to this number.
+      "sourceMinLengthFilter": "A String", # Optional. The filter will match columns with length greater than or equal to this number.
+    },
+    "valueTransformation": { # Description of data transformation during migration as part of the ConditionalColumnSetValue. # Required. Description of data transformation during migration.
+      "applyHash": { # Apply a hash function on the value. # Optional. Applies a hash function on the data
+        "uuidFromBytes": { # 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); } # Optional. Generate UUID from the data's byte array
+        },
+      },
+      "assignMaxValue": { # 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); } # Optional. Set to max_value - if integer or numeric, will use int.maxvalue, etc
+      },
+      "assignMinValue": { # 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); } # Optional. Set to min_value - if integer or numeric, will use int.minvalue, etc
+      },
+      "assignNull": { # 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); } # Optional. Set to null
+      },
+      "assignSpecificValue": { # Set to a specific value (value is converted to fit the target data type) # Optional. Set to a specific value (value is converted to fit the target data type)
+        "value": "A String", # Required. Specific value to be assigned
+      },
+      "doubleComparison": { # Filter based on relation between source value and compare value of type double in ConditionalColumnSetValue # Optional. Filter on relation between source value and compare value of type double.
+        "value": 3.14, # Required. Double compare value to be used
+        "valueComparison": "A String", # Required. Relation between source value and compare value
+      },
+      "intComparison": { # Filter based on relation between source value and compare value of type integer in ConditionalColumnSetValue # Optional. Filter on relation between source value and compare value of type integer.
+        "value": "A String", # Required. Integer compare value to be used
+        "valueComparison": "A String", # Required. Relation between source value and compare value
+      },
+      "isNull": { # 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); } # Optional. Value is null
+      },
+      "roundScale": { # This allows the data to change scale, for example if the source is 2 digits after the decimal point, specify round to scale value = 2. If for example the value needs to be converted to an integer, use round to scale value = 0. # Optional. Allows the data to change scale
+        "scale": 42, # Required. Scale value to be used
+      },
+      "valueList": { # A list of values to filter by in ConditionalColumnSetValue # Optional. Value is found in the specified list.
+        "ignoreCase": True or False, # Required. Whether to ignore case when filtering by values. Defaults to false
+        "valuePresentList": "A String", # Required. Indicates whether the filter matches rows with values that are present in the list or those with values not present in it.
+        "values": [ # Required. The list to be used to filter by
+          "A String",
+        ],
+      },
+    },
+  },
+  "convertRowidColumn": { # Options to configure rule type ConvertROWIDToColumn. The rule is used to add column rowid to destination tables based on an Oracle rowid function/property. The rule filter field can refer to one or more entities. The rule scope can be one of: Table. This rule requires additional filter to be specified beyond the basic rule filter field, which is whether or not to work on tables which already have a primary key defined. # Optional. Rule to specify how multiple tables should be converted with an additional rowid column.
+    "onlyIfNoPrimaryKey": True or False, # Required. Only work on tables without primary key defined
+  },
+  "displayName": "A String", # Optional. A human readable name
+  "entityMove": { # Options to configure rule type EntityMove. The rule is used to move an entity to a new schema. The rule filter field can refer to one or more entities. The rule scope can be one of: Table, Column, Constraint, Index, View, Function, Stored Procedure, Materialized View, Sequence, UDT # Optional. Rule to specify how multiple entities should be relocated into a different schema.
+    "newSchema": "A String", # Required. The new schema
+  },
+  "filter": { # A filter defining the entities that a mapping rule should be applied to. When more than one field is specified, the rule is applied only to entities which match all the fields. # Required. The rule filter
+    "entities": [ # Optional. The rule should be applied to specific entities defined by their fully qualified names.
+      "A String",
+    ],
+    "entityNameContains": "A String", # Optional. The rule should be applied to entities whose non-qualified name contains the given string.
+    "entityNamePrefix": "A String", # Optional. The rule should be applied to entities whose non-qualified name starts with the given prefix.
+    "entityNameSuffix": "A String", # Optional. The rule should be applied to entities whose non-qualified name ends with the given suffix.
+    "parentEntity": "A String", # Optional. The rule should be applied to entities whose parent entity (fully qualified name) matches the given value. For example, if the rule applies to a table entity, the expected value should be a schema (schema). If the rule applies to a column or index entity, the expected value can be either a schema (schema) or a table (schema.table)
+  },
+  "filterTableColumns": { # Options to configure rule type FilterTableColumns. The rule is used to filter the list of columns to include or exclude from a table. The rule filter field can refer to one entity. The rule scope can be: Table Only one of the two lists can be specified for the rule. # Optional. Rule to specify the list of columns to include or exclude from a table.
+    "excludeColumns": [ # Optional. List of columns to be excluded for a particular table.
+      "A String",
+    ],
+    "includeColumns": [ # Optional. List of columns to be included for a particular table.
+      "A String",
+    ],
+  },
+  "multiColumnDataTypeChange": { # Options to configure rule type MultiColumnDatatypeChange. The rule is used to change the data type and associated properties of multiple columns at once. The rule filter field can refer to one or more entities. The rule scope can be one of:Column. This rule requires additional filters to be specified beyond the basic rule filter field, which is the source data type, but the rule supports additional filtering capabilities such as the minimum and maximum field length. All additional filters which are specified are required to be met in order for the rule to be applied (logical AND between the fields). # Optional. Rule to specify how multiple columns should be converted to a different data type.
+    "customFeatures": { # Optional. Custom engine specific features.
+      "a_key": "", # Properties of the object.
+    },
+    "newDataType": "A String", # Required. New data type.
+    "overrideFractionalSecondsPrecision": 42, # Optional. Column fractional seconds precision - used only for timestamp based datatypes - if not specified and relevant uses the source column fractional seconds precision.
+    "overrideLength": "A String", # Optional. Column length - e.g. varchar (50) - if not specified and relevant uses the source column length.
+    "overridePrecision": 42, # Optional. Column precision - when relevant - if not specified and relevant uses the source column precision.
+    "overrideScale": 42, # Optional. Column scale - when relevant - if not specified and relevant uses the source column scale.
+    "sourceDataTypeFilter": "A String", # Required. Filter on source data type.
+    "sourceNumericFilter": { # Filter for fixed point number data types such as NUMERIC/NUMBER # Optional. Filter for fixed point number data types such as NUMERIC/NUMBER.
+      "numericFilterOption": "A String", # Required. Enum to set the option defining the datatypes numeric filter has to be applied to
+      "sourceMaxPrecisionFilter": 42, # Optional. The filter will match columns with precision smaller than or equal to this number.
+      "sourceMaxScaleFilter": 42, # Optional. The filter will match columns with scale smaller than or equal to this number.
+      "sourceMinPrecisionFilter": 42, # Optional. The filter will match columns with precision greater than or equal to this number.
+      "sourceMinScaleFilter": 42, # Optional. The filter will match columns with scale greater than or equal to this number.
+    },
+    "sourceTextFilter": { # Filter for text-based data types like varchar. # Optional. Filter for text-based data types like varchar.
+      "sourceMaxLengthFilter": "A String", # Optional. The filter will match columns with length smaller than or equal to this number.
+      "sourceMinLengthFilter": "A String", # Optional. The filter will match columns with length greater than or equal to this number.
+    },
+  },
+  "multiEntityRename": { # Options to configure rule type MultiEntityRename. The rule is used to rename multiple entities. The rule filter field can refer to one or more entities. The rule scope can be one of: Database, Schema, Table, Column, Constraint, Index, View, Function, Stored Procedure, Materialized View, Sequence, UDT # Optional. Rule to specify how multiple entities should be renamed.
+    "newNamePattern": "A String", # Optional. The pattern used to generate the new entity's name. This pattern must include the characters '{name}', which will be replaced with the name of the original entity. For example, the pattern 't_{name}' for an entity name jobs would be converted to 't_jobs'. If unspecified, the default value for this field is '{name}'
+    "sourceNameTransformation": "A String", # Optional. Additional transformation that can be done on the source entity name before it is being used by the new_name_pattern, for example lower case. If no transformation is desired, use NO_TRANSFORMATION
+  },
+  "name": "A String", # Full name of the mapping rule resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{set}/mappingRule/{rule}.
+  "revisionCreateTime": "A String", # Output only. The timestamp that the revision was created.
+  "revisionId": "A String", # Output only. The revision ID of the mapping rule. A new revision is committed whenever the mapping rule is changed in any way. The format is an 8-character hexadecimal string.
+  "ruleOrder": "A String", # Required. The order in which the rule is applied. Lower order rules are applied before higher value rules so they may end up being overridden.
+  "ruleScope": "A String", # Required. The rule scope
+  "setTablePrimaryKey": { # Options to configure rule type SetTablePrimaryKey. The rule is used to specify the columns and name to configure/alter the primary key of a table. The rule filter field can refer to one entity. The rule scope can be one of: Table. # Optional. Rule to specify the primary key for a table
+    "primaryKey": "A String", # Optional. Name for the primary key
+    "primaryKeyColumns": [ # Required. List of column names for the primary key
+      "A String",
+    ],
+  },
+  "singleColumnChange": { # Options to configure rule type SingleColumnChange. The rule is used to change the properties of a column. The rule filter field can refer to one entity. The rule scope can be one of: Column. When using this rule, if a field is not specified than the destination column's configuration will be the same as the one in the source column.. # Optional. Rule to specify how a single column is converted.
+    "array": True or False, # Optional. Is the column of array type.
+    "arrayLength": 42, # Optional. The length of the array, only relevant if the column type is an array.
+    "autoGenerated": True or False, # Optional. Is the column auto-generated/identity.
+    "charset": "A String", # Optional. Charset override - instead of table level charset.
+    "collation": "A String", # Optional. Collation override - instead of table level collation.
+    "comment": "A String", # Optional. Comment associated with the column.
+    "customFeatures": { # Optional. Custom engine specific features.
+      "a_key": "", # Properties of the object.
+    },
+    "dataType": "A String", # Optional. Column data type name.
+    "fractionalSecondsPrecision": 42, # Optional. Column fractional seconds precision - e.g. 2 as in timestamp (2) - when relevant.
+    "length": "A String", # Optional. Column length - e.g. 50 as in varchar (50) - when relevant.
+    "nullable": True or False, # Optional. Is the column nullable.
+    "precision": 42, # Optional. Column precision - e.g. 8 as in double (8,2) - when relevant.
+    "scale": 42, # Optional. Column scale - e.g. 2 as in double (8,2) - when relevant.
+    "setValues": [ # Optional. Specifies the list of values allowed in the column.
+      "A String",
+    ],
+    "udt": True or False, # Optional. Is the column a UDT (User-defined Type).
+  },
+  "singleEntityRename": { # Options to configure rule type SingleEntityRename. The rule is used to rename an entity. The rule filter field can refer to only one entity. The rule scope can be one of: Database, Schema, Table, Column, Constraint, Index, View, Function, Stored Procedure, Materialized View, Sequence, UDT, Synonym # Optional. Rule to specify how a single entity should be renamed.
+    "newName": "A String", # Required. The new name of the destination entity
+  },
+  "singlePackageChange": { # Options to configure rule type SinglePackageChange. The rule is used to alter the sql code for a package entities. The rule filter field can refer to one entity. The rule scope can be: Package # Optional. Rule to specify how a single package is converted.
+    "packageBody": "A String", # Optional. Sql code for package body
+    "packageDescription": "A String", # Optional. Sql code for package description
+  },
+  "sourceSqlChange": { # Options to configure rule type SourceSqlChange. The rule is used to alter the sql code for database entities. The rule filter field can refer to one entity. The rule scope can be: StoredProcedure, Function, Trigger, View # Optional. Rule to change the sql code for an entity, for example, function, procedure.
+    "sqlCode": "A String", # Required. Sql code for source (stored procedure, function, trigger or view)
+  },
+  "state": "A String", # Optional. The mapping rule state
+}
+
+  mappingRuleId: string, Required. The ID of the rule to create.
+  requestId: string, A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored. It is recommended to always set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Definition of a transformation that is to be applied to a group of entities in the source schema. Several such transformations can be applied to an entity sequentially to define the corresponding entity in the target schema.
+  "conditionalColumnSetValue": { # Options to configure rule type ConditionalColumnSetValue. The rule is used to transform the data which is being replicated/migrated. The rule filter field can refer to one or more entities. The rule scope can be one of: Column. # Optional. Rule to specify how the data contained in a column should be transformed (such as trimmed, rounded, etc) provided that the data meets certain criteria.
+    "customFeatures": { # Optional. Custom engine specific features.
+      "a_key": "", # Properties of the object.
+    },
+    "sourceNumericFilter": { # Filter for fixed point number data types such as NUMERIC/NUMBER # Optional. Optional filter on source column precision and scale. Used for fixed point numbers such as NUMERIC/NUMBER data types.
+      "numericFilterOption": "A String", # Required. Enum to set the option defining the datatypes numeric filter has to be applied to
+      "sourceMaxPrecisionFilter": 42, # Optional. The filter will match columns with precision smaller than or equal to this number.
+      "sourceMaxScaleFilter": 42, # Optional. The filter will match columns with scale smaller than or equal to this number.
+      "sourceMinPrecisionFilter": 42, # Optional. The filter will match columns with precision greater than or equal to this number.
+      "sourceMinScaleFilter": 42, # Optional. The filter will match columns with scale greater than or equal to this number.
+    },
+    "sourceTextFilter": { # Filter for text-based data types like varchar. # Optional. Optional filter on source column length. Used for text based data types like varchar.
+      "sourceMaxLengthFilter": "A String", # Optional. The filter will match columns with length smaller than or equal to this number.
+      "sourceMinLengthFilter": "A String", # Optional. The filter will match columns with length greater than or equal to this number.
+    },
+    "valueTransformation": { # Description of data transformation during migration as part of the ConditionalColumnSetValue. # Required. Description of data transformation during migration.
+      "applyHash": { # Apply a hash function on the value. # Optional. Applies a hash function on the data
+        "uuidFromBytes": { # 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); } # Optional. Generate UUID from the data's byte array
+        },
+      },
+      "assignMaxValue": { # 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); } # Optional. Set to max_value - if integer or numeric, will use int.maxvalue, etc
+      },
+      "assignMinValue": { # 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); } # Optional. Set to min_value - if integer or numeric, will use int.minvalue, etc
+      },
+      "assignNull": { # 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); } # Optional. Set to null
+      },
+      "assignSpecificValue": { # Set to a specific value (value is converted to fit the target data type) # Optional. Set to a specific value (value is converted to fit the target data type)
+        "value": "A String", # Required. Specific value to be assigned
+      },
+      "doubleComparison": { # Filter based on relation between source value and compare value of type double in ConditionalColumnSetValue # Optional. Filter on relation between source value and compare value of type double.
+        "value": 3.14, # Required. Double compare value to be used
+        "valueComparison": "A String", # Required. Relation between source value and compare value
+      },
+      "intComparison": { # Filter based on relation between source value and compare value of type integer in ConditionalColumnSetValue # Optional. Filter on relation between source value and compare value of type integer.
+        "value": "A String", # Required. Integer compare value to be used
+        "valueComparison": "A String", # Required. Relation between source value and compare value
+      },
+      "isNull": { # 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); } # Optional. Value is null
+      },
+      "roundScale": { # This allows the data to change scale, for example if the source is 2 digits after the decimal point, specify round to scale value = 2. If for example the value needs to be converted to an integer, use round to scale value = 0. # Optional. Allows the data to change scale
+        "scale": 42, # Required. Scale value to be used
+      },
+      "valueList": { # A list of values to filter by in ConditionalColumnSetValue # Optional. Value is found in the specified list.
+        "ignoreCase": True or False, # Required. Whether to ignore case when filtering by values. Defaults to false
+        "valuePresentList": "A String", # Required. Indicates whether the filter matches rows with values that are present in the list or those with values not present in it.
+        "values": [ # Required. The list to be used to filter by
+          "A String",
+        ],
+      },
+    },
+  },
+  "convertRowidColumn": { # Options to configure rule type ConvertROWIDToColumn. The rule is used to add column rowid to destination tables based on an Oracle rowid function/property. The rule filter field can refer to one or more entities. The rule scope can be one of: Table. This rule requires additional filter to be specified beyond the basic rule filter field, which is whether or not to work on tables which already have a primary key defined. # Optional. Rule to specify how multiple tables should be converted with an additional rowid column.
+    "onlyIfNoPrimaryKey": True or False, # Required. Only work on tables without primary key defined
+  },
+  "displayName": "A String", # Optional. A human readable name
+  "entityMove": { # Options to configure rule type EntityMove. The rule is used to move an entity to a new schema. The rule filter field can refer to one or more entities. The rule scope can be one of: Table, Column, Constraint, Index, View, Function, Stored Procedure, Materialized View, Sequence, UDT # Optional. Rule to specify how multiple entities should be relocated into a different schema.
+    "newSchema": "A String", # Required. The new schema
+  },
+  "filter": { # A filter defining the entities that a mapping rule should be applied to. When more than one field is specified, the rule is applied only to entities which match all the fields. # Required. The rule filter
+    "entities": [ # Optional. The rule should be applied to specific entities defined by their fully qualified names.
+      "A String",
+    ],
+    "entityNameContains": "A String", # Optional. The rule should be applied to entities whose non-qualified name contains the given string.
+    "entityNamePrefix": "A String", # Optional. The rule should be applied to entities whose non-qualified name starts with the given prefix.
+    "entityNameSuffix": "A String", # Optional. The rule should be applied to entities whose non-qualified name ends with the given suffix.
+    "parentEntity": "A String", # Optional. The rule should be applied to entities whose parent entity (fully qualified name) matches the given value. For example, if the rule applies to a table entity, the expected value should be a schema (schema). If the rule applies to a column or index entity, the expected value can be either a schema (schema) or a table (schema.table)
+  },
+  "filterTableColumns": { # Options to configure rule type FilterTableColumns. The rule is used to filter the list of columns to include or exclude from a table. The rule filter field can refer to one entity. The rule scope can be: Table Only one of the two lists can be specified for the rule. # Optional. Rule to specify the list of columns to include or exclude from a table.
+    "excludeColumns": [ # Optional. List of columns to be excluded for a particular table.
+      "A String",
+    ],
+    "includeColumns": [ # Optional. List of columns to be included for a particular table.
+      "A String",
+    ],
+  },
+  "multiColumnDataTypeChange": { # Options to configure rule type MultiColumnDatatypeChange. The rule is used to change the data type and associated properties of multiple columns at once. The rule filter field can refer to one or more entities. The rule scope can be one of:Column. This rule requires additional filters to be specified beyond the basic rule filter field, which is the source data type, but the rule supports additional filtering capabilities such as the minimum and maximum field length. All additional filters which are specified are required to be met in order for the rule to be applied (logical AND between the fields). # Optional. Rule to specify how multiple columns should be converted to a different data type.
+    "customFeatures": { # Optional. Custom engine specific features.
+      "a_key": "", # Properties of the object.
+    },
+    "newDataType": "A String", # Required. New data type.
+    "overrideFractionalSecondsPrecision": 42, # Optional. Column fractional seconds precision - used only for timestamp based datatypes - if not specified and relevant uses the source column fractional seconds precision.
+    "overrideLength": "A String", # Optional. Column length - e.g. varchar (50) - if not specified and relevant uses the source column length.
+    "overridePrecision": 42, # Optional. Column precision - when relevant - if not specified and relevant uses the source column precision.
+    "overrideScale": 42, # Optional. Column scale - when relevant - if not specified and relevant uses the source column scale.
+    "sourceDataTypeFilter": "A String", # Required. Filter on source data type.
+    "sourceNumericFilter": { # Filter for fixed point number data types such as NUMERIC/NUMBER # Optional. Filter for fixed point number data types such as NUMERIC/NUMBER.
+      "numericFilterOption": "A String", # Required. Enum to set the option defining the datatypes numeric filter has to be applied to
+      "sourceMaxPrecisionFilter": 42, # Optional. The filter will match columns with precision smaller than or equal to this number.
+      "sourceMaxScaleFilter": 42, # Optional. The filter will match columns with scale smaller than or equal to this number.
+      "sourceMinPrecisionFilter": 42, # Optional. The filter will match columns with precision greater than or equal to this number.
+      "sourceMinScaleFilter": 42, # Optional. The filter will match columns with scale greater than or equal to this number.
+    },
+    "sourceTextFilter": { # Filter for text-based data types like varchar. # Optional. Filter for text-based data types like varchar.
+      "sourceMaxLengthFilter": "A String", # Optional. The filter will match columns with length smaller than or equal to this number.
+      "sourceMinLengthFilter": "A String", # Optional. The filter will match columns with length greater than or equal to this number.
+    },
+  },
+  "multiEntityRename": { # Options to configure rule type MultiEntityRename. The rule is used to rename multiple entities. The rule filter field can refer to one or more entities. The rule scope can be one of: Database, Schema, Table, Column, Constraint, Index, View, Function, Stored Procedure, Materialized View, Sequence, UDT # Optional. Rule to specify how multiple entities should be renamed.
+    "newNamePattern": "A String", # Optional. The pattern used to generate the new entity's name. This pattern must include the characters '{name}', which will be replaced with the name of the original entity. For example, the pattern 't_{name}' for an entity name jobs would be converted to 't_jobs'. If unspecified, the default value for this field is '{name}'
+    "sourceNameTransformation": "A String", # Optional. Additional transformation that can be done on the source entity name before it is being used by the new_name_pattern, for example lower case. If no transformation is desired, use NO_TRANSFORMATION
+  },
+  "name": "A String", # Full name of the mapping rule resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{set}/mappingRule/{rule}.
+  "revisionCreateTime": "A String", # Output only. The timestamp that the revision was created.
+  "revisionId": "A String", # Output only. The revision ID of the mapping rule. A new revision is committed whenever the mapping rule is changed in any way. The format is an 8-character hexadecimal string.
+  "ruleOrder": "A String", # Required. The order in which the rule is applied. Lower order rules are applied before higher value rules so they may end up being overridden.
+  "ruleScope": "A String", # Required. The rule scope
+  "setTablePrimaryKey": { # Options to configure rule type SetTablePrimaryKey. The rule is used to specify the columns and name to configure/alter the primary key of a table. The rule filter field can refer to one entity. The rule scope can be one of: Table. # Optional. Rule to specify the primary key for a table
+    "primaryKey": "A String", # Optional. Name for the primary key
+    "primaryKeyColumns": [ # Required. List of column names for the primary key
+      "A String",
+    ],
+  },
+  "singleColumnChange": { # Options to configure rule type SingleColumnChange. The rule is used to change the properties of a column. The rule filter field can refer to one entity. The rule scope can be one of: Column. When using this rule, if a field is not specified than the destination column's configuration will be the same as the one in the source column.. # Optional. Rule to specify how a single column is converted.
+    "array": True or False, # Optional. Is the column of array type.
+    "arrayLength": 42, # Optional. The length of the array, only relevant if the column type is an array.
+    "autoGenerated": True or False, # Optional. Is the column auto-generated/identity.
+    "charset": "A String", # Optional. Charset override - instead of table level charset.
+    "collation": "A String", # Optional. Collation override - instead of table level collation.
+    "comment": "A String", # Optional. Comment associated with the column.
+    "customFeatures": { # Optional. Custom engine specific features.
+      "a_key": "", # Properties of the object.
+    },
+    "dataType": "A String", # Optional. Column data type name.
+    "fractionalSecondsPrecision": 42, # Optional. Column fractional seconds precision - e.g. 2 as in timestamp (2) - when relevant.
+    "length": "A String", # Optional. Column length - e.g. 50 as in varchar (50) - when relevant.
+    "nullable": True or False, # Optional. Is the column nullable.
+    "precision": 42, # Optional. Column precision - e.g. 8 as in double (8,2) - when relevant.
+    "scale": 42, # Optional. Column scale - e.g. 2 as in double (8,2) - when relevant.
+    "setValues": [ # Optional. Specifies the list of values allowed in the column.
+      "A String",
+    ],
+    "udt": True or False, # Optional. Is the column a UDT (User-defined Type).
+  },
+  "singleEntityRename": { # Options to configure rule type SingleEntityRename. The rule is used to rename an entity. The rule filter field can refer to only one entity. The rule scope can be one of: Database, Schema, Table, Column, Constraint, Index, View, Function, Stored Procedure, Materialized View, Sequence, UDT, Synonym # Optional. Rule to specify how a single entity should be renamed.
+    "newName": "A String", # Required. The new name of the destination entity
+  },
+  "singlePackageChange": { # Options to configure rule type SinglePackageChange. The rule is used to alter the sql code for a package entities. The rule filter field can refer to one entity. The rule scope can be: Package # Optional. Rule to specify how a single package is converted.
+    "packageBody": "A String", # Optional. Sql code for package body
+    "packageDescription": "A String", # Optional. Sql code for package description
+  },
+  "sourceSqlChange": { # Options to configure rule type SourceSqlChange. The rule is used to alter the sql code for database entities. The rule filter field can refer to one entity. The rule scope can be: StoredProcedure, Function, Trigger, View # Optional. Rule to change the sql code for an entity, for example, function, procedure.
+    "sqlCode": "A String", # Required. Sql code for source (stored procedure, function, trigger or view)
+  },
+  "state": "A String", # Optional. The mapping rule state
+}
+
+ +
+ delete(name, requestId=None, x__xgafv=None) +
Deletes a single mapping rule.
+
+Args:
+  name: string, Required. Name of the mapping rule resource to delete. (required)
+  requestId: string, Optional. A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored. It is recommended to always set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
+  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); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets the details of a mapping rule.
+
+Args:
+  name: string, Required. Name of the mapping rule resource to get. Example: conversionWorkspaces/123/mappingRules/rule123 In order to retrieve a previous revision of the mapping rule, also provide the revision ID. Example: conversionWorkspace/123/mappingRules/rule123@c7cfa2a8c7cfa2a8c7cfa2a8c7cfa2a8 (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Definition of a transformation that is to be applied to a group of entities in the source schema. Several such transformations can be applied to an entity sequentially to define the corresponding entity in the target schema.
+  "conditionalColumnSetValue": { # Options to configure rule type ConditionalColumnSetValue. The rule is used to transform the data which is being replicated/migrated. The rule filter field can refer to one or more entities. The rule scope can be one of: Column. # Optional. Rule to specify how the data contained in a column should be transformed (such as trimmed, rounded, etc) provided that the data meets certain criteria.
+    "customFeatures": { # Optional. Custom engine specific features.
+      "a_key": "", # Properties of the object.
+    },
+    "sourceNumericFilter": { # Filter for fixed point number data types such as NUMERIC/NUMBER # Optional. Optional filter on source column precision and scale. Used for fixed point numbers such as NUMERIC/NUMBER data types.
+      "numericFilterOption": "A String", # Required. Enum to set the option defining the datatypes numeric filter has to be applied to
+      "sourceMaxPrecisionFilter": 42, # Optional. The filter will match columns with precision smaller than or equal to this number.
+      "sourceMaxScaleFilter": 42, # Optional. The filter will match columns with scale smaller than or equal to this number.
+      "sourceMinPrecisionFilter": 42, # Optional. The filter will match columns with precision greater than or equal to this number.
+      "sourceMinScaleFilter": 42, # Optional. The filter will match columns with scale greater than or equal to this number.
+    },
+    "sourceTextFilter": { # Filter for text-based data types like varchar. # Optional. Optional filter on source column length. Used for text based data types like varchar.
+      "sourceMaxLengthFilter": "A String", # Optional. The filter will match columns with length smaller than or equal to this number.
+      "sourceMinLengthFilter": "A String", # Optional. The filter will match columns with length greater than or equal to this number.
+    },
+    "valueTransformation": { # Description of data transformation during migration as part of the ConditionalColumnSetValue. # Required. Description of data transformation during migration.
+      "applyHash": { # Apply a hash function on the value. # Optional. Applies a hash function on the data
+        "uuidFromBytes": { # 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); } # Optional. Generate UUID from the data's byte array
+        },
+      },
+      "assignMaxValue": { # 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); } # Optional. Set to max_value - if integer or numeric, will use int.maxvalue, etc
+      },
+      "assignMinValue": { # 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); } # Optional. Set to min_value - if integer or numeric, will use int.minvalue, etc
+      },
+      "assignNull": { # 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); } # Optional. Set to null
+      },
+      "assignSpecificValue": { # Set to a specific value (value is converted to fit the target data type) # Optional. Set to a specific value (value is converted to fit the target data type)
+        "value": "A String", # Required. Specific value to be assigned
+      },
+      "doubleComparison": { # Filter based on relation between source value and compare value of type double in ConditionalColumnSetValue # Optional. Filter on relation between source value and compare value of type double.
+        "value": 3.14, # Required. Double compare value to be used
+        "valueComparison": "A String", # Required. Relation between source value and compare value
+      },
+      "intComparison": { # Filter based on relation between source value and compare value of type integer in ConditionalColumnSetValue # Optional. Filter on relation between source value and compare value of type integer.
+        "value": "A String", # Required. Integer compare value to be used
+        "valueComparison": "A String", # Required. Relation between source value and compare value
+      },
+      "isNull": { # 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); } # Optional. Value is null
+      },
+      "roundScale": { # This allows the data to change scale, for example if the source is 2 digits after the decimal point, specify round to scale value = 2. If for example the value needs to be converted to an integer, use round to scale value = 0. # Optional. Allows the data to change scale
+        "scale": 42, # Required. Scale value to be used
+      },
+      "valueList": { # A list of values to filter by in ConditionalColumnSetValue # Optional. Value is found in the specified list.
+        "ignoreCase": True or False, # Required. Whether to ignore case when filtering by values. Defaults to false
+        "valuePresentList": "A String", # Required. Indicates whether the filter matches rows with values that are present in the list or those with values not present in it.
+        "values": [ # Required. The list to be used to filter by
+          "A String",
+        ],
+      },
+    },
+  },
+  "convertRowidColumn": { # Options to configure rule type ConvertROWIDToColumn. The rule is used to add column rowid to destination tables based on an Oracle rowid function/property. The rule filter field can refer to one or more entities. The rule scope can be one of: Table. This rule requires additional filter to be specified beyond the basic rule filter field, which is whether or not to work on tables which already have a primary key defined. # Optional. Rule to specify how multiple tables should be converted with an additional rowid column.
+    "onlyIfNoPrimaryKey": True or False, # Required. Only work on tables without primary key defined
+  },
+  "displayName": "A String", # Optional. A human readable name
+  "entityMove": { # Options to configure rule type EntityMove. The rule is used to move an entity to a new schema. The rule filter field can refer to one or more entities. The rule scope can be one of: Table, Column, Constraint, Index, View, Function, Stored Procedure, Materialized View, Sequence, UDT # Optional. Rule to specify how multiple entities should be relocated into a different schema.
+    "newSchema": "A String", # Required. The new schema
+  },
+  "filter": { # A filter defining the entities that a mapping rule should be applied to. When more than one field is specified, the rule is applied only to entities which match all the fields. # Required. The rule filter
+    "entities": [ # Optional. The rule should be applied to specific entities defined by their fully qualified names.
+      "A String",
+    ],
+    "entityNameContains": "A String", # Optional. The rule should be applied to entities whose non-qualified name contains the given string.
+    "entityNamePrefix": "A String", # Optional. The rule should be applied to entities whose non-qualified name starts with the given prefix.
+    "entityNameSuffix": "A String", # Optional. The rule should be applied to entities whose non-qualified name ends with the given suffix.
+    "parentEntity": "A String", # Optional. The rule should be applied to entities whose parent entity (fully qualified name) matches the given value. For example, if the rule applies to a table entity, the expected value should be a schema (schema). If the rule applies to a column or index entity, the expected value can be either a schema (schema) or a table (schema.table)
+  },
+  "filterTableColumns": { # Options to configure rule type FilterTableColumns. The rule is used to filter the list of columns to include or exclude from a table. The rule filter field can refer to one entity. The rule scope can be: Table Only one of the two lists can be specified for the rule. # Optional. Rule to specify the list of columns to include or exclude from a table.
+    "excludeColumns": [ # Optional. List of columns to be excluded for a particular table.
+      "A String",
+    ],
+    "includeColumns": [ # Optional. List of columns to be included for a particular table.
+      "A String",
+    ],
+  },
+  "multiColumnDataTypeChange": { # Options to configure rule type MultiColumnDatatypeChange. The rule is used to change the data type and associated properties of multiple columns at once. The rule filter field can refer to one or more entities. The rule scope can be one of:Column. This rule requires additional filters to be specified beyond the basic rule filter field, which is the source data type, but the rule supports additional filtering capabilities such as the minimum and maximum field length. All additional filters which are specified are required to be met in order for the rule to be applied (logical AND between the fields). # Optional. Rule to specify how multiple columns should be converted to a different data type.
+    "customFeatures": { # Optional. Custom engine specific features.
+      "a_key": "", # Properties of the object.
+    },
+    "newDataType": "A String", # Required. New data type.
+    "overrideFractionalSecondsPrecision": 42, # Optional. Column fractional seconds precision - used only for timestamp based datatypes - if not specified and relevant uses the source column fractional seconds precision.
+    "overrideLength": "A String", # Optional. Column length - e.g. varchar (50) - if not specified and relevant uses the source column length.
+    "overridePrecision": 42, # Optional. Column precision - when relevant - if not specified and relevant uses the source column precision.
+    "overrideScale": 42, # Optional. Column scale - when relevant - if not specified and relevant uses the source column scale.
+    "sourceDataTypeFilter": "A String", # Required. Filter on source data type.
+    "sourceNumericFilter": { # Filter for fixed point number data types such as NUMERIC/NUMBER # Optional. Filter for fixed point number data types such as NUMERIC/NUMBER.
+      "numericFilterOption": "A String", # Required. Enum to set the option defining the datatypes numeric filter has to be applied to
+      "sourceMaxPrecisionFilter": 42, # Optional. The filter will match columns with precision smaller than or equal to this number.
+      "sourceMaxScaleFilter": 42, # Optional. The filter will match columns with scale smaller than or equal to this number.
+      "sourceMinPrecisionFilter": 42, # Optional. The filter will match columns with precision greater than or equal to this number.
+      "sourceMinScaleFilter": 42, # Optional. The filter will match columns with scale greater than or equal to this number.
+    },
+    "sourceTextFilter": { # Filter for text-based data types like varchar. # Optional. Filter for text-based data types like varchar.
+      "sourceMaxLengthFilter": "A String", # Optional. The filter will match columns with length smaller than or equal to this number.
+      "sourceMinLengthFilter": "A String", # Optional. The filter will match columns with length greater than or equal to this number.
+    },
+  },
+  "multiEntityRename": { # Options to configure rule type MultiEntityRename. The rule is used to rename multiple entities. The rule filter field can refer to one or more entities. The rule scope can be one of: Database, Schema, Table, Column, Constraint, Index, View, Function, Stored Procedure, Materialized View, Sequence, UDT # Optional. Rule to specify how multiple entities should be renamed.
+    "newNamePattern": "A String", # Optional. The pattern used to generate the new entity's name. This pattern must include the characters '{name}', which will be replaced with the name of the original entity. For example, the pattern 't_{name}' for an entity name jobs would be converted to 't_jobs'. If unspecified, the default value for this field is '{name}'
+    "sourceNameTransformation": "A String", # Optional. Additional transformation that can be done on the source entity name before it is being used by the new_name_pattern, for example lower case. If no transformation is desired, use NO_TRANSFORMATION
+  },
+  "name": "A String", # Full name of the mapping rule resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{set}/mappingRule/{rule}.
+  "revisionCreateTime": "A String", # Output only. The timestamp that the revision was created.
+  "revisionId": "A String", # Output only. The revision ID of the mapping rule. A new revision is committed whenever the mapping rule is changed in any way. The format is an 8-character hexadecimal string.
+  "ruleOrder": "A String", # Required. The order in which the rule is applied. Lower order rules are applied before higher value rules so they may end up being overridden.
+  "ruleScope": "A String", # Required. The rule scope
+  "setTablePrimaryKey": { # Options to configure rule type SetTablePrimaryKey. The rule is used to specify the columns and name to configure/alter the primary key of a table. The rule filter field can refer to one entity. The rule scope can be one of: Table. # Optional. Rule to specify the primary key for a table
+    "primaryKey": "A String", # Optional. Name for the primary key
+    "primaryKeyColumns": [ # Required. List of column names for the primary key
+      "A String",
+    ],
+  },
+  "singleColumnChange": { # Options to configure rule type SingleColumnChange. The rule is used to change the properties of a column. The rule filter field can refer to one entity. The rule scope can be one of: Column. When using this rule, if a field is not specified than the destination column's configuration will be the same as the one in the source column.. # Optional. Rule to specify how a single column is converted.
+    "array": True or False, # Optional. Is the column of array type.
+    "arrayLength": 42, # Optional. The length of the array, only relevant if the column type is an array.
+    "autoGenerated": True or False, # Optional. Is the column auto-generated/identity.
+    "charset": "A String", # Optional. Charset override - instead of table level charset.
+    "collation": "A String", # Optional. Collation override - instead of table level collation.
+    "comment": "A String", # Optional. Comment associated with the column.
+    "customFeatures": { # Optional. Custom engine specific features.
+      "a_key": "", # Properties of the object.
+    },
+    "dataType": "A String", # Optional. Column data type name.
+    "fractionalSecondsPrecision": 42, # Optional. Column fractional seconds precision - e.g. 2 as in timestamp (2) - when relevant.
+    "length": "A String", # Optional. Column length - e.g. 50 as in varchar (50) - when relevant.
+    "nullable": True or False, # Optional. Is the column nullable.
+    "precision": 42, # Optional. Column precision - e.g. 8 as in double (8,2) - when relevant.
+    "scale": 42, # Optional. Column scale - e.g. 2 as in double (8,2) - when relevant.
+    "setValues": [ # Optional. Specifies the list of values allowed in the column.
+      "A String",
+    ],
+    "udt": True or False, # Optional. Is the column a UDT (User-defined Type).
+  },
+  "singleEntityRename": { # Options to configure rule type SingleEntityRename. The rule is used to rename an entity. The rule filter field can refer to only one entity. The rule scope can be one of: Database, Schema, Table, Column, Constraint, Index, View, Function, Stored Procedure, Materialized View, Sequence, UDT, Synonym # Optional. Rule to specify how a single entity should be renamed.
+    "newName": "A String", # Required. The new name of the destination entity
+  },
+  "singlePackageChange": { # Options to configure rule type SinglePackageChange. The rule is used to alter the sql code for a package entities. The rule filter field can refer to one entity. The rule scope can be: Package # Optional. Rule to specify how a single package is converted.
+    "packageBody": "A String", # Optional. Sql code for package body
+    "packageDescription": "A String", # Optional. Sql code for package description
+  },
+  "sourceSqlChange": { # Options to configure rule type SourceSqlChange. The rule is used to alter the sql code for database entities. The rule filter field can refer to one entity. The rule scope can be: StoredProcedure, Function, Trigger, View # Optional. Rule to change the sql code for an entity, for example, function, procedure.
+    "sqlCode": "A String", # Required. Sql code for source (stored procedure, function, trigger or view)
+  },
+  "state": "A String", # Optional. The mapping rule state
+}
+
+
import_(parent, body=None, x__xgafv=None)
Imports the mapping rules for a given conversion workspace. Supports various formats of external rules files.
@@ -96,14 +606,14 @@ 

Method Details

The object takes the form of: { # Request message for 'ImportMappingRules' request. - "autoCommit": True or False, # Should the conversion workspace be committed automatically after the import operation. - "rulesFiles": [ # One or more rules files. + "autoCommit": True or False, # Required. Should the conversion workspace be committed automatically after the import operation. + "rulesFiles": [ # Required. One or more rules files. { # Details of a single rules file. - "rulesContent": "A String", # The text content of the rules that needs to be converted. - "rulesSourceFilename": "A String", # The filename of the rules that needs to be converted. The filename is used mainly so that future logs of the import rules job contain it, and can therefore be searched by it. + "rulesContent": "A String", # Required. The text content of the rules that needs to be converted. + "rulesSourceFilename": "A String", # Required. The filename of the rules that needs to be converted. The filename is used mainly so that future logs of the import rules job contain it, and can therefore be searched by it. }, ], - "rulesFormat": "A String", # The format of the rules content file. + "rulesFormat": "A String", # Required. The format of the rules content file. } x__xgafv: string, V1 error format. @@ -135,4 +645,187 @@

Method Details

}
+
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists the mapping rules for a specific conversion workspace.
+
+Args:
+  parent: string, Required. Name of the conversion workspace resource whose mapping rules are listed in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}. (required)
+  pageSize: integer, The maximum number of rules to return. The service may return fewer than this value.
+  pageToken: string, The nextPageToken value received in the previous call to mappingRules.list, used in the subsequent request to retrieve the next page of results. On first call this should be left blank. When paginating, all other parameters provided to mappingRules.list must match the call that provided the page token.
+  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 'ListMappingRulesRequest' request.
+  "mappingRules": [ # The list of conversion workspace mapping rules.
+    { # Definition of a transformation that is to be applied to a group of entities in the source schema. Several such transformations can be applied to an entity sequentially to define the corresponding entity in the target schema.
+      "conditionalColumnSetValue": { # Options to configure rule type ConditionalColumnSetValue. The rule is used to transform the data which is being replicated/migrated. The rule filter field can refer to one or more entities. The rule scope can be one of: Column. # Optional. Rule to specify how the data contained in a column should be transformed (such as trimmed, rounded, etc) provided that the data meets certain criteria.
+        "customFeatures": { # Optional. Custom engine specific features.
+          "a_key": "", # Properties of the object.
+        },
+        "sourceNumericFilter": { # Filter for fixed point number data types such as NUMERIC/NUMBER # Optional. Optional filter on source column precision and scale. Used for fixed point numbers such as NUMERIC/NUMBER data types.
+          "numericFilterOption": "A String", # Required. Enum to set the option defining the datatypes numeric filter has to be applied to
+          "sourceMaxPrecisionFilter": 42, # Optional. The filter will match columns with precision smaller than or equal to this number.
+          "sourceMaxScaleFilter": 42, # Optional. The filter will match columns with scale smaller than or equal to this number.
+          "sourceMinPrecisionFilter": 42, # Optional. The filter will match columns with precision greater than or equal to this number.
+          "sourceMinScaleFilter": 42, # Optional. The filter will match columns with scale greater than or equal to this number.
+        },
+        "sourceTextFilter": { # Filter for text-based data types like varchar. # Optional. Optional filter on source column length. Used for text based data types like varchar.
+          "sourceMaxLengthFilter": "A String", # Optional. The filter will match columns with length smaller than or equal to this number.
+          "sourceMinLengthFilter": "A String", # Optional. The filter will match columns with length greater than or equal to this number.
+        },
+        "valueTransformation": { # Description of data transformation during migration as part of the ConditionalColumnSetValue. # Required. Description of data transformation during migration.
+          "applyHash": { # Apply a hash function on the value. # Optional. Applies a hash function on the data
+            "uuidFromBytes": { # 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); } # Optional. Generate UUID from the data's byte array
+            },
+          },
+          "assignMaxValue": { # 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); } # Optional. Set to max_value - if integer or numeric, will use int.maxvalue, etc
+          },
+          "assignMinValue": { # 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); } # Optional. Set to min_value - if integer or numeric, will use int.minvalue, etc
+          },
+          "assignNull": { # 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); } # Optional. Set to null
+          },
+          "assignSpecificValue": { # Set to a specific value (value is converted to fit the target data type) # Optional. Set to a specific value (value is converted to fit the target data type)
+            "value": "A String", # Required. Specific value to be assigned
+          },
+          "doubleComparison": { # Filter based on relation between source value and compare value of type double in ConditionalColumnSetValue # Optional. Filter on relation between source value and compare value of type double.
+            "value": 3.14, # Required. Double compare value to be used
+            "valueComparison": "A String", # Required. Relation between source value and compare value
+          },
+          "intComparison": { # Filter based on relation between source value and compare value of type integer in ConditionalColumnSetValue # Optional. Filter on relation between source value and compare value of type integer.
+            "value": "A String", # Required. Integer compare value to be used
+            "valueComparison": "A String", # Required. Relation between source value and compare value
+          },
+          "isNull": { # 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); } # Optional. Value is null
+          },
+          "roundScale": { # This allows the data to change scale, for example if the source is 2 digits after the decimal point, specify round to scale value = 2. If for example the value needs to be converted to an integer, use round to scale value = 0. # Optional. Allows the data to change scale
+            "scale": 42, # Required. Scale value to be used
+          },
+          "valueList": { # A list of values to filter by in ConditionalColumnSetValue # Optional. Value is found in the specified list.
+            "ignoreCase": True or False, # Required. Whether to ignore case when filtering by values. Defaults to false
+            "valuePresentList": "A String", # Required. Indicates whether the filter matches rows with values that are present in the list or those with values not present in it.
+            "values": [ # Required. The list to be used to filter by
+              "A String",
+            ],
+          },
+        },
+      },
+      "convertRowidColumn": { # Options to configure rule type ConvertROWIDToColumn. The rule is used to add column rowid to destination tables based on an Oracle rowid function/property. The rule filter field can refer to one or more entities. The rule scope can be one of: Table. This rule requires additional filter to be specified beyond the basic rule filter field, which is whether or not to work on tables which already have a primary key defined. # Optional. Rule to specify how multiple tables should be converted with an additional rowid column.
+        "onlyIfNoPrimaryKey": True or False, # Required. Only work on tables without primary key defined
+      },
+      "displayName": "A String", # Optional. A human readable name
+      "entityMove": { # Options to configure rule type EntityMove. The rule is used to move an entity to a new schema. The rule filter field can refer to one or more entities. The rule scope can be one of: Table, Column, Constraint, Index, View, Function, Stored Procedure, Materialized View, Sequence, UDT # Optional. Rule to specify how multiple entities should be relocated into a different schema.
+        "newSchema": "A String", # Required. The new schema
+      },
+      "filter": { # A filter defining the entities that a mapping rule should be applied to. When more than one field is specified, the rule is applied only to entities which match all the fields. # Required. The rule filter
+        "entities": [ # Optional. The rule should be applied to specific entities defined by their fully qualified names.
+          "A String",
+        ],
+        "entityNameContains": "A String", # Optional. The rule should be applied to entities whose non-qualified name contains the given string.
+        "entityNamePrefix": "A String", # Optional. The rule should be applied to entities whose non-qualified name starts with the given prefix.
+        "entityNameSuffix": "A String", # Optional. The rule should be applied to entities whose non-qualified name ends with the given suffix.
+        "parentEntity": "A String", # Optional. The rule should be applied to entities whose parent entity (fully qualified name) matches the given value. For example, if the rule applies to a table entity, the expected value should be a schema (schema). If the rule applies to a column or index entity, the expected value can be either a schema (schema) or a table (schema.table)
+      },
+      "filterTableColumns": { # Options to configure rule type FilterTableColumns. The rule is used to filter the list of columns to include or exclude from a table. The rule filter field can refer to one entity. The rule scope can be: Table Only one of the two lists can be specified for the rule. # Optional. Rule to specify the list of columns to include or exclude from a table.
+        "excludeColumns": [ # Optional. List of columns to be excluded for a particular table.
+          "A String",
+        ],
+        "includeColumns": [ # Optional. List of columns to be included for a particular table.
+          "A String",
+        ],
+      },
+      "multiColumnDataTypeChange": { # Options to configure rule type MultiColumnDatatypeChange. The rule is used to change the data type and associated properties of multiple columns at once. The rule filter field can refer to one or more entities. The rule scope can be one of:Column. This rule requires additional filters to be specified beyond the basic rule filter field, which is the source data type, but the rule supports additional filtering capabilities such as the minimum and maximum field length. All additional filters which are specified are required to be met in order for the rule to be applied (logical AND between the fields). # Optional. Rule to specify how multiple columns should be converted to a different data type.
+        "customFeatures": { # Optional. Custom engine specific features.
+          "a_key": "", # Properties of the object.
+        },
+        "newDataType": "A String", # Required. New data type.
+        "overrideFractionalSecondsPrecision": 42, # Optional. Column fractional seconds precision - used only for timestamp based datatypes - if not specified and relevant uses the source column fractional seconds precision.
+        "overrideLength": "A String", # Optional. Column length - e.g. varchar (50) - if not specified and relevant uses the source column length.
+        "overridePrecision": 42, # Optional. Column precision - when relevant - if not specified and relevant uses the source column precision.
+        "overrideScale": 42, # Optional. Column scale - when relevant - if not specified and relevant uses the source column scale.
+        "sourceDataTypeFilter": "A String", # Required. Filter on source data type.
+        "sourceNumericFilter": { # Filter for fixed point number data types such as NUMERIC/NUMBER # Optional. Filter for fixed point number data types such as NUMERIC/NUMBER.
+          "numericFilterOption": "A String", # Required. Enum to set the option defining the datatypes numeric filter has to be applied to
+          "sourceMaxPrecisionFilter": 42, # Optional. The filter will match columns with precision smaller than or equal to this number.
+          "sourceMaxScaleFilter": 42, # Optional. The filter will match columns with scale smaller than or equal to this number.
+          "sourceMinPrecisionFilter": 42, # Optional. The filter will match columns with precision greater than or equal to this number.
+          "sourceMinScaleFilter": 42, # Optional. The filter will match columns with scale greater than or equal to this number.
+        },
+        "sourceTextFilter": { # Filter for text-based data types like varchar. # Optional. Filter for text-based data types like varchar.
+          "sourceMaxLengthFilter": "A String", # Optional. The filter will match columns with length smaller than or equal to this number.
+          "sourceMinLengthFilter": "A String", # Optional. The filter will match columns with length greater than or equal to this number.
+        },
+      },
+      "multiEntityRename": { # Options to configure rule type MultiEntityRename. The rule is used to rename multiple entities. The rule filter field can refer to one or more entities. The rule scope can be one of: Database, Schema, Table, Column, Constraint, Index, View, Function, Stored Procedure, Materialized View, Sequence, UDT # Optional. Rule to specify how multiple entities should be renamed.
+        "newNamePattern": "A String", # Optional. The pattern used to generate the new entity's name. This pattern must include the characters '{name}', which will be replaced with the name of the original entity. For example, the pattern 't_{name}' for an entity name jobs would be converted to 't_jobs'. If unspecified, the default value for this field is '{name}'
+        "sourceNameTransformation": "A String", # Optional. Additional transformation that can be done on the source entity name before it is being used by the new_name_pattern, for example lower case. If no transformation is desired, use NO_TRANSFORMATION
+      },
+      "name": "A String", # Full name of the mapping rule resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{set}/mappingRule/{rule}.
+      "revisionCreateTime": "A String", # Output only. The timestamp that the revision was created.
+      "revisionId": "A String", # Output only. The revision ID of the mapping rule. A new revision is committed whenever the mapping rule is changed in any way. The format is an 8-character hexadecimal string.
+      "ruleOrder": "A String", # Required. The order in which the rule is applied. Lower order rules are applied before higher value rules so they may end up being overridden.
+      "ruleScope": "A String", # Required. The rule scope
+      "setTablePrimaryKey": { # Options to configure rule type SetTablePrimaryKey. The rule is used to specify the columns and name to configure/alter the primary key of a table. The rule filter field can refer to one entity. The rule scope can be one of: Table. # Optional. Rule to specify the primary key for a table
+        "primaryKey": "A String", # Optional. Name for the primary key
+        "primaryKeyColumns": [ # Required. List of column names for the primary key
+          "A String",
+        ],
+      },
+      "singleColumnChange": { # Options to configure rule type SingleColumnChange. The rule is used to change the properties of a column. The rule filter field can refer to one entity. The rule scope can be one of: Column. When using this rule, if a field is not specified than the destination column's configuration will be the same as the one in the source column.. # Optional. Rule to specify how a single column is converted.
+        "array": True or False, # Optional. Is the column of array type.
+        "arrayLength": 42, # Optional. The length of the array, only relevant if the column type is an array.
+        "autoGenerated": True or False, # Optional. Is the column auto-generated/identity.
+        "charset": "A String", # Optional. Charset override - instead of table level charset.
+        "collation": "A String", # Optional. Collation override - instead of table level collation.
+        "comment": "A String", # Optional. Comment associated with the column.
+        "customFeatures": { # Optional. Custom engine specific features.
+          "a_key": "", # Properties of the object.
+        },
+        "dataType": "A String", # Optional. Column data type name.
+        "fractionalSecondsPrecision": 42, # Optional. Column fractional seconds precision - e.g. 2 as in timestamp (2) - when relevant.
+        "length": "A String", # Optional. Column length - e.g. 50 as in varchar (50) - when relevant.
+        "nullable": True or False, # Optional. Is the column nullable.
+        "precision": 42, # Optional. Column precision - e.g. 8 as in double (8,2) - when relevant.
+        "scale": 42, # Optional. Column scale - e.g. 2 as in double (8,2) - when relevant.
+        "setValues": [ # Optional. Specifies the list of values allowed in the column.
+          "A String",
+        ],
+        "udt": True or False, # Optional. Is the column a UDT (User-defined Type).
+      },
+      "singleEntityRename": { # Options to configure rule type SingleEntityRename. The rule is used to rename an entity. The rule filter field can refer to only one entity. The rule scope can be one of: Database, Schema, Table, Column, Constraint, Index, View, Function, Stored Procedure, Materialized View, Sequence, UDT, Synonym # Optional. Rule to specify how a single entity should be renamed.
+        "newName": "A String", # Required. The new name of the destination entity
+      },
+      "singlePackageChange": { # Options to configure rule type SinglePackageChange. The rule is used to alter the sql code for a package entities. The rule filter field can refer to one entity. The rule scope can be: Package # Optional. Rule to specify how a single package is converted.
+        "packageBody": "A String", # Optional. Sql code for package body
+        "packageDescription": "A String", # Optional. Sql code for package description
+      },
+      "sourceSqlChange": { # Options to configure rule type SourceSqlChange. The rule is used to alter the sql code for database entities. The rule filter field can refer to one entity. The rule scope can be: StoredProcedure, Function, Trigger, View # Optional. Rule to change the sql code for an entity, for example, function, procedure.
+        "sqlCode": "A String", # Required. Sql code for source (stored procedure, function, trigger or view)
+      },
+      "state": "A String", # Optional. The mapping rule state
+    },
+  ],
+  "nextPageToken": "A String", # A token which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ \ No newline at end of file diff --git a/docs/dyn/datamigration_v1.projects.locations.migrationJobs.html b/docs/dyn/datamigration_v1.projects.locations.migrationJobs.html index a70508b22c4..a0345e49fb8 100644 --- a/docs/dyn/datamigration_v1.projects.locations.migrationJobs.html +++ b/docs/dyn/datamigration_v1.projects.locations.migrationJobs.html @@ -86,6 +86,9 @@

Instance Methods

generateSshScript(migrationJob, body=None, x__xgafv=None)

Generate a SSH configuration script to configure the reverse SSH connectivity.

+

+ generateTcpProxyScript(migrationJob, body=None, x__xgafv=None)

+

Generate a TCP Proxy configuration script to configure a cloud-hosted VM running a TCP Proxy.

get(name, x__xgafv=None)

Gets details of a single migration job.

@@ -201,7 +204,7 @@

Method Details

} migrationJobId: string, Required. The ID of the instance to create. - requestId: string, A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored. It is recommended to always set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. + requestId: string, Optional. A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored. It is recommended to always set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -303,6 +306,35 @@

Method Details

}
+
+ generateTcpProxyScript(migrationJob, body=None, x__xgafv=None) +
Generate a TCP Proxy configuration script to configure a cloud-hosted VM running a TCP Proxy.
+
+Args:
+  migrationJob: string, Name of the migration job resource to generate the TCP Proxy script. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for 'GenerateTcpProxyScript' request.
+  "vmMachineType": "A String", # Required. The type of the Compute instance that will host the proxy.
+  "vmName": "A String", # Required. The name of the Compute instance that will host the proxy.
+  "vmSubnet": "A String", # Required. The name of the subnet the Compute instance will use for private connectivity. Must be supplied in the form of projects/{project}/regions/{region}/subnetworks/{subnetwork}. Note: the region for the subnet must match the Compute instance region.
+  "vmZone": "A String", # Optional. The Google Cloud Platform zone to create the VM in. The fully qualified name of the zone must be specified, including the region name, for example "us-central1-b". If not specified, uses the "-b" zone of the destination Connection Profile's region.
+}
+
+  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 'GenerateTcpProxyScript' request.
+  "script": "A String", # The TCP Proxy configuration script.
+}
+
+
get(name, x__xgafv=None)
Gets details of a single migration job.
@@ -957,6 +989,66 @@ 

Method Details

The object takes the form of: { # Request message for 'VerifyMigrationJob' request. + "migrationJob": { # Represents a Database Migration Service migration job object. # Optional. The changed migration job parameters to verify. It will not update the migration job. + "cmekKeyName": "A String", # The CMEK (customer-managed encryption key) fully qualified key name used for the migration job. This field supports all migration jobs types except for: * Mysql to Mysql (use the cmek field in the cloudsql connection profile instead). * PostrgeSQL to PostgreSQL (use the cmek field in the cloudsql connection profile instead). * PostgreSQL to AlloyDB (use the kms_key_name field in the alloydb connection profile instead). Each Cloud CMEK key has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME] + "conversionWorkspace": { # A conversion workspace's version. # The conversion workspace used by the migration. + "commitId": "A String", # The commit ID of the conversion workspace. + "name": "A String", # The resource name (URI) of the conversion workspace. + }, + "createTime": "A String", # Output only. The timestamp when the migration job resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z". + "destination": "A String", # Required. The resource name (URI) of the destination connection profile. + "destinationDatabase": { # A message defining the database engine and provider. # The database engine type and provider of the destination. + "engine": "A String", # The database engine. + "provider": "A String", # The database provider. + }, + "displayName": "A String", # The migration job display name. + "dumpFlags": { # Dump flags definition. # The initial dump flags. This field and the "dump_path" field are mutually exclusive. + "dumpFlags": [ # The flags for the initial dump. + { # Dump flag definition. + "name": "A String", # The name of the flag + "value": "A String", # The value of the flag. + }, + ], + }, + "dumpPath": "A String", # The path to the dump file in Google Cloud Storage, in the format: (gs://[BUCKET_NAME]/[OBJECT_NAME]). This field and the "dump_flags" field are mutually exclusive. + "duration": "A String", # Output only. The duration of the migration job (in seconds). A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s". + "endTime": "A String", # Output only. If the migration job is completed, the time when it was completed. + "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). # Output only. The error details in case of state FAILED. + "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. + }, + "filter": "A String", # This field can be used to select the entities to migrate as part of the migration job. It uses AIP-160 notation to select a subset of the entities configured on the associated conversion-workspace. This field should not be set on migration-jobs that are not associated with a conversion workspace. + "labels": { # The resource labels for migration job to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`. + "a_key": "A String", + }, + "name": "A String", # The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}. + "phase": "A String", # Output only. The current migration job phase. + "reverseSshConnectivity": { # The details needed to configure a reverse SSH tunnel between the source and destination databases. These details will be used when calling the generateSshScript method (see https://cloud.google.com/database-migration/docs/reference/rest/v1/projects.locations.migrationJobs/generateSshScript) to produce the script that will help set up the reverse SSH tunnel, and to set up the VPC peering between the Cloud SQL private network and the VPC. # The details needed to communicate to the source over Reverse SSH tunnel connectivity. + "vm": "A String", # The name of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel. + "vmIp": "A String", # Required. The IP of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel. + "vmPort": 42, # Required. The forwarding port of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel. + "vpc": "A String", # The name of the VPC to peer with the Cloud SQL private network. + }, + "source": "A String", # Required. The resource name (URI) of the source connection profile. + "sourceDatabase": { # A message defining the database engine and provider. # The database engine type and provider of the source. + "engine": "A String", # The database engine. + "provider": "A String", # The database provider. + }, + "state": "A String", # The current migration job state. + "staticIpConnectivity": { # The source database will allow incoming connections from the public IP of the destination database. You can retrieve the public IP of the Cloud SQL instance from the Cloud SQL console or using Cloud SQL APIs. No additional configuration is required. # static ip connectivity data (default, no additional details needed). + }, + "type": "A String", # Required. The migration job type. + "updateTime": "A String", # Output only. The timestamp when the migration job resource was last updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z". + "vpcPeeringConnectivity": { # The details of the VPC where the source database is located in Google Cloud. We will use this information to set up the VPC peering connection between Cloud SQL and this VPC. # The details of the VPC network that the source database is located in. + "vpc": "A String", # The name of the VPC network to peer with the Cloud SQL private network. + }, + }, + "updateMask": "A String", # Optional. Field mask is used to specify the changed fields to be verified. It will not update the migration job. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/dataplex_v1.projects.locations.lakes.environments.html b/docs/dyn/dataplex_v1.projects.locations.lakes.environments.html index 90bb59f4d51..7a2d303bf4a 100644 --- a/docs/dyn/dataplex_v1.projects.locations.lakes.environments.html +++ b/docs/dyn/dataplex_v1.projects.locations.lakes.environments.html @@ -124,7 +124,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Environment represents a user-visible compute infrastructure for analytics within a lake. LINT.IfChange +{ # Environment represents a user-visible compute infrastructure for analytics within a lake. "createTime": "A String", # Output only. Environment creation time. "description": "A String", # Optional. Description of the environment. "displayName": "A String", # Optional. User friendly display name. @@ -247,7 +247,7 @@

Method Details

Returns: An object of the form: - { # Environment represents a user-visible compute infrastructure for analytics within a lake. LINT.IfChange + { # Environment represents a user-visible compute infrastructure for analytics within a lake. "createTime": "A String", # Output only. Environment creation time. "description": "A String", # Optional. Description of the environment. "displayName": "A String", # Optional. User friendly display name. @@ -359,7 +359,7 @@

Method Details

{ # List environments response. "environments": [ # Environments under the given parent lake. - { # Environment represents a user-visible compute infrastructure for analytics within a lake. LINT.IfChange + { # Environment represents a user-visible compute infrastructure for analytics within a lake. "createTime": "A String", # Output only. Environment creation time. "description": "A String", # Optional. Description of the environment. "displayName": "A String", # Optional. User friendly display name. @@ -429,7 +429,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Environment represents a user-visible compute infrastructure for analytics within a lake. LINT.IfChange +{ # Environment represents a user-visible compute infrastructure for analytics within a lake. "createTime": "A String", # Output only. Environment creation time. "description": "A String", # Optional. Description of the environment. "displayName": "A String", # Optional. User friendly display name. diff --git a/docs/dyn/datastore_v1.projects.html b/docs/dyn/datastore_v1.projects.html index 728201a38b8..6ccb40fff5f 100644 --- a/docs/dyn/datastore_v1.projects.html +++ b/docs/dyn/datastore_v1.projects.html @@ -259,41 +259,7 @@

Method Details

], }, "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. - "a_key": { # A message that can hold any of the supported value types and associated metadata. - "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. - "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. - # Object with schema name: Value - ], - }, - "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. - "booleanValue": True or False, # A boolean value. - "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. - "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. - "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. - "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. - "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. - }, - "integerValue": "A String", # An integer value. - "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. - "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. - "databaseId": "A String", # If not empty, the ID of the database to which the entities belong. - "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. - "projectId": "A String", # The ID of the project to which the entities belong. - }, - "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. - { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. - "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. - "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - }, - ], - }, - "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. - "nullValue": "A String", # A null value. - "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. - "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. - }, + "a_key": # Object with schema name: Value }, }, "update": { # A Datastore data object. Must not exceed 1 MiB - 4 bytes. # The entity to update. The entity must already exist. Must have a complete key path. @@ -312,41 +278,7 @@

Method Details

], }, "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. - "a_key": { # A message that can hold any of the supported value types and associated metadata. - "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. - "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. - # Object with schema name: Value - ], - }, - "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. - "booleanValue": True or False, # A boolean value. - "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. - "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. - "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. - "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. - "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. - }, - "integerValue": "A String", # An integer value. - "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. - "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. - "databaseId": "A String", # If not empty, the ID of the database to which the entities belong. - "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. - "projectId": "A String", # The ID of the project to which the entities belong. - }, - "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. - { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. - "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. - "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - }, - ], - }, - "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. - "nullValue": "A String", # A null value. - "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. - "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. - }, + "a_key": # Object with schema name: Value }, }, "updateTime": "A String", # The update time of the entity that this mutation is being applied to. If this does not match the current update time on the server, the mutation conflicts. @@ -366,41 +298,7 @@

Method Details

], }, "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. - "a_key": { # A message that can hold any of the supported value types and associated metadata. - "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. - "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. - # Object with schema name: Value - ], - }, - "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. - "booleanValue": True or False, # A boolean value. - "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. - "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. - "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. - "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. - "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. - }, - "integerValue": "A String", # An integer value. - "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. - "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. - "databaseId": "A String", # If not empty, the ID of the database to which the entities belong. - "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. - "projectId": "A String", # The ID of the project to which the entities belong. - }, - "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. - { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. - "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. - "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - }, - ], - }, - "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. - "nullValue": "A String", # A null value. - "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. - "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. - }, + "a_key": # Object with schema name: Value }, }, }, @@ -645,41 +543,7 @@

Method Details

], }, "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. - "a_key": { # A message that can hold any of the supported value types and associated metadata. - "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. - "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. - # Object with schema name: Value - ], - }, - "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. - "booleanValue": True or False, # A boolean value. - "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. - "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. - "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. - "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. - "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. - }, - "integerValue": "A String", # An integer value. - "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. - "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. - "databaseId": "A String", # If not empty, the ID of the database to which the entities belong. - "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. - "projectId": "A String", # The ID of the project to which the entities belong. - }, - "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. - { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. - "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. - "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - }, - ], - }, - "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. - "nullValue": "A String", # A null value. - "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. - "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. - }, + "a_key": # Object with schema name: Value }, }, "updateTime": "A String", # The time at which the entity was last changed. This field is set for `FULL` entity results. If this entity is missing, this field will not be set. @@ -706,41 +570,7 @@

Method Details

], }, "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. - "a_key": { # A message that can hold any of the supported value types and associated metadata. - "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. - "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. - # Object with schema name: Value - ], - }, - "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. - "booleanValue": True or False, # A boolean value. - "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. - "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. - "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. - "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. - "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. - }, - "integerValue": "A String", # An integer value. - "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. - "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. - "databaseId": "A String", # If not empty, the ID of the database to which the entities belong. - "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. - "projectId": "A String", # The ID of the project to which the entities belong. - }, - "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. - { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. - "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. - "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - }, - ], - }, - "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. - "nullValue": "A String", # A null value. - "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. - "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. - }, + "a_key": # Object with schema name: Value }, }, "updateTime": "A String", # The time at which the entity was last changed. This field is set for `FULL` entity results. If this entity is missing, this field will not be set. @@ -866,7 +696,25 @@

Method Details

"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. "booleanValue": True or False, # A boolean value. "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "entityValue": { # A Datastore data object. Must not exceed 1 MiB - 4 bytes. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "databaseId": "A String", # If not empty, the ID of the database to which the entities belong. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. + "a_key": # Object with schema name: Value + }, + }, "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. @@ -934,7 +782,25 @@

Method Details

"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. "booleanValue": True or False, # A boolean value. "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "entityValue": { # A Datastore data object. Must not exceed 1 MiB - 4 bytes. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "databaseId": "A String", # If not empty, the ID of the database to which the entities belong. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. + "a_key": # Object with schema name: Value + }, + }, "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. @@ -974,7 +840,25 @@

Method Details

"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. "booleanValue": True or False, # A boolean value. "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "entityValue": { # A Datastore data object. Must not exceed 1 MiB - 4 bytes. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "databaseId": "A String", # If not empty, the ID of the database to which the entities belong. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. + "a_key": # Object with schema name: Value + }, + }, "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. @@ -1046,7 +930,25 @@

Method Details

"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. "booleanValue": True or False, # A boolean value. "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "entityValue": { # A Datastore data object. Must not exceed 1 MiB - 4 bytes. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "databaseId": "A String", # If not empty, the ID of the database to which the entities belong. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. + "a_key": # Object with schema name: Value + }, + }, "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. @@ -1115,7 +1017,25 @@

Method Details

"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. "booleanValue": True or False, # A boolean value. "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "entityValue": { # A Datastore data object. Must not exceed 1 MiB - 4 bytes. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "databaseId": "A String", # If not empty, the ID of the database to which the entities belong. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. + "a_key": # Object with schema name: Value + }, + }, "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. @@ -1197,7 +1117,25 @@

Method Details

"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. "booleanValue": True or False, # A boolean value. "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "entityValue": { # A Datastore data object. Must not exceed 1 MiB - 4 bytes. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "databaseId": "A String", # If not empty, the ID of the database to which the entities belong. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. + "a_key": # Object with schema name: Value + }, + }, "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. @@ -1237,7 +1175,25 @@

Method Details

"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. "booleanValue": True or False, # A boolean value. "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "entityValue": { # A Datastore data object. Must not exceed 1 MiB - 4 bytes. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "databaseId": "A String", # If not empty, the ID of the database to which the entities belong. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. + "a_key": # Object with schema name: Value + }, + }, "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. @@ -1300,7 +1256,25 @@

Method Details

"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. "booleanValue": True or False, # A boolean value. "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "entityValue": { # A Datastore data object. Must not exceed 1 MiB - 4 bytes. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "databaseId": "A String", # If not empty, the ID of the database to which the entities belong. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. + "a_key": # Object with schema name: Value + }, + }, "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. @@ -1399,41 +1373,7 @@

Method Details

], }, "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. - "a_key": { # A message that can hold any of the supported value types and associated metadata. - "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. - "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. - # Object with schema name: Value - ], - }, - "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. - "booleanValue": True or False, # A boolean value. - "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. - "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. - "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. - "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. - "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. - }, - "integerValue": "A String", # An integer value. - "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. - "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. - "databaseId": "A String", # If not empty, the ID of the database to which the entities belong. - "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. - "projectId": "A String", # The ID of the project to which the entities belong. - }, - "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. - { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. - "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. - "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - }, - ], - }, - "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. - "nullValue": "A String", # A null value. - "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. - "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. - }, + "a_key": # Object with schema name: Value }, }, "updateTime": "A String", # The time at which the entity was last changed. This field is set for `FULL` entity results. If this entity is missing, this field will not be set. @@ -1474,7 +1414,25 @@

Method Details

"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. "booleanValue": True or False, # A boolean value. "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "entityValue": { # A Datastore data object. Must not exceed 1 MiB - 4 bytes. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "databaseId": "A String", # If not empty, the ID of the database to which the entities belong. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. + "a_key": # Object with schema name: Value + }, + }, "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. diff --git a/docs/dyn/datastore_v1beta3.projects.html b/docs/dyn/datastore_v1beta3.projects.html index 782819c4efe..14a789165b4 100644 --- a/docs/dyn/datastore_v1beta3.projects.html +++ b/docs/dyn/datastore_v1beta3.projects.html @@ -236,40 +236,7 @@

Method Details

], }, "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. - "a_key": { # A message that can hold any of the supported value types and associated metadata. - "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. - "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. - # Object with schema name: Value - ], - }, - "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. - "booleanValue": True or False, # A boolean value. - "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. - "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. - "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. - "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. - "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. - }, - "integerValue": "A String", # An integer value. - "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. - "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. - "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. - "projectId": "A String", # The ID of the project to which the entities belong. - }, - "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. - { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. - "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. - "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - }, - ], - }, - "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. - "nullValue": "A String", # A null value. - "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. - "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. - }, + "a_key": # Object with schema name: Value }, }, "update": { # A Datastore data object. Must not exceed 1 MiB - 4 bytes. # The entity to update. The entity must already exist. Must have a complete key path. @@ -287,40 +254,7 @@

Method Details

], }, "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. - "a_key": { # A message that can hold any of the supported value types and associated metadata. - "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. - "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. - # Object with schema name: Value - ], - }, - "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. - "booleanValue": True or False, # A boolean value. - "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. - "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. - "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. - "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. - "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. - }, - "integerValue": "A String", # An integer value. - "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. - "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. - "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. - "projectId": "A String", # The ID of the project to which the entities belong. - }, - "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. - { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. - "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. - "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - }, - ], - }, - "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. - "nullValue": "A String", # A null value. - "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. - "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. - }, + "a_key": # Object with schema name: Value }, }, "updateTime": "A String", # The update time of the entity that this mutation is being applied to. If this does not match the current update time on the server, the mutation conflicts. @@ -339,40 +273,7 @@

Method Details

], }, "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. - "a_key": { # A message that can hold any of the supported value types and associated metadata. - "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. - "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. - # Object with schema name: Value - ], - }, - "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. - "booleanValue": True or False, # A boolean value. - "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. - "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. - "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. - "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. - "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. - }, - "integerValue": "A String", # An integer value. - "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. - "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. - "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. - "projectId": "A String", # The ID of the project to which the entities belong. - }, - "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. - { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. - "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. - "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - }, - ], - }, - "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. - "nullValue": "A String", # A null value. - "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. - "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. - }, + "a_key": # Object with schema name: Value }, }, }, @@ -490,40 +391,7 @@

Method Details

], }, "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. - "a_key": { # A message that can hold any of the supported value types and associated metadata. - "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. - "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. - # Object with schema name: Value - ], - }, - "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. - "booleanValue": True or False, # A boolean value. - "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. - "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. - "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. - "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. - "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. - }, - "integerValue": "A String", # An integer value. - "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. - "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. - "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. - "projectId": "A String", # The ID of the project to which the entities belong. - }, - "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. - { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. - "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. - "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - }, - ], - }, - "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. - "nullValue": "A String", # A null value. - "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. - "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. - }, + "a_key": # Object with schema name: Value }, }, "updateTime": "A String", # The time at which the entity was last changed. This field is set for `FULL` entity results. If this entity is missing, this field will not be set. @@ -549,40 +417,7 @@

Method Details

], }, "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. - "a_key": { # A message that can hold any of the supported value types and associated metadata. - "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. - "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. - # Object with schema name: Value - ], - }, - "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. - "booleanValue": True or False, # A boolean value. - "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. - "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. - "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. - "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. - "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. - }, - "integerValue": "A String", # An integer value. - "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. - "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. - "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. - "projectId": "A String", # The ID of the project to which the entities belong. - }, - "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. - { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. - "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. - "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - }, - ], - }, - "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. - "nullValue": "A String", # A null value. - "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. - "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. - }, + "a_key": # Object with schema name: Value }, }, "updateTime": "A String", # The time at which the entity was last changed. This field is set for `FULL` entity results. If this entity is missing, this field will not be set. @@ -705,7 +540,24 @@

Method Details

"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. "booleanValue": True or False, # A boolean value. "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "entityValue": { # A Datastore data object. Must not exceed 1 MiB - 4 bytes. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. + "a_key": # Object with schema name: Value + }, + }, "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. @@ -771,7 +623,24 @@

Method Details

"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. "booleanValue": True or False, # A boolean value. "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "entityValue": { # A Datastore data object. Must not exceed 1 MiB - 4 bytes. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. + "a_key": # Object with schema name: Value + }, + }, "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. @@ -810,7 +679,24 @@

Method Details

"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. "booleanValue": True or False, # A boolean value. "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "entityValue": { # A Datastore data object. Must not exceed 1 MiB - 4 bytes. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. + "a_key": # Object with schema name: Value + }, + }, "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. @@ -872,7 +758,24 @@

Method Details

"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. "booleanValue": True or False, # A boolean value. "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "entityValue": { # A Datastore data object. Must not exceed 1 MiB - 4 bytes. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. + "a_key": # Object with schema name: Value + }, + }, "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. @@ -940,7 +843,24 @@

Method Details

"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. "booleanValue": True or False, # A boolean value. "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "entityValue": { # A Datastore data object. Must not exceed 1 MiB - 4 bytes. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. + "a_key": # Object with schema name: Value + }, + }, "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. @@ -1019,7 +939,24 @@

Method Details

"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. "booleanValue": True or False, # A boolean value. "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "entityValue": { # A Datastore data object. Must not exceed 1 MiB - 4 bytes. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. + "a_key": # Object with schema name: Value + }, + }, "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. @@ -1058,7 +995,24 @@

Method Details

"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. "booleanValue": True or False, # A boolean value. "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "entityValue": { # A Datastore data object. Must not exceed 1 MiB - 4 bytes. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. + "a_key": # Object with schema name: Value + }, + }, "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. @@ -1119,7 +1073,24 @@

Method Details

"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. "booleanValue": True or False, # A boolean value. "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "entityValue": { # A Datastore data object. Must not exceed 1 MiB - 4 bytes. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. + "a_key": # Object with schema name: Value + }, + }, "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. @@ -1208,40 +1179,7 @@

Method Details

], }, "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. - "a_key": { # A message that can hold any of the supported value types and associated metadata. - "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. - "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. - # Object with schema name: Value - ], - }, - "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. - "booleanValue": True or False, # A boolean value. - "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. - "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. - "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. - "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. - "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. - }, - "integerValue": "A String", # An integer value. - "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. - "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. - "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. - "projectId": "A String", # The ID of the project to which the entities belong. - }, - "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. - { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. - "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. - "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - }, - ], - }, - "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. - "nullValue": "A String", # A null value. - "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. - "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. - }, + "a_key": # Object with schema name: Value }, }, "updateTime": "A String", # The time at which the entity was last changed. This field is set for `FULL` entity results. If this entity is missing, this field will not be set. @@ -1282,7 +1220,24 @@

Method Details

"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. "booleanValue": True or False, # A boolean value. "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "entityValue": { # A Datastore data object. Must not exceed 1 MiB - 4 bytes. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. + "a_key": # Object with schema name: Value + }, + }, "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.html b/docs/dyn/dialogflow_v3.projects.locations.agents.html index bef7b0833b0..cd7f9663246 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.html @@ -178,6 +178,17 @@

Method Details

"displayName": "A String", # Required. The human-readable name of the agent, unique within the location. "enableSpellCorrection": True or False, # Indicates if automatic spell correction is enabled in detect intent requests. "enableStackdriverLogging": True or False, # Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead. + "gitIntegrationSettings": { # Settings for connecting to Git repository for an agent. # Git integration settings for this agent. + "githubSettings": { # Settings of integration with GitHub. # GitHub settings. + "accessToken": "A String", # The access token used to authenticate the access to the GitHub repository. + "branches": [ # A list of branches configured to be used from Dialogflow. + "A String", + ], + "displayName": "A String", # The unique repository display name for the GitHub repository. + "repositoryUri": "A String", # The GitHub repository URI related to the agent. + "trackingBranch": "A String", # The branch of GitHub repository tracked for this agent. + }, + }, "locked": True or False, # Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for RestoreAgent. "name": "A String", # The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`. "securitySettings": "A String", # Name of the SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. @@ -231,6 +242,17 @@

Method Details

"displayName": "A String", # Required. The human-readable name of the agent, unique within the location. "enableSpellCorrection": True or False, # Indicates if automatic spell correction is enabled in detect intent requests. "enableStackdriverLogging": True or False, # Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead. + "gitIntegrationSettings": { # Settings for connecting to Git repository for an agent. # Git integration settings for this agent. + "githubSettings": { # Settings of integration with GitHub. # GitHub settings. + "accessToken": "A String", # The access token used to authenticate the access to the GitHub repository. + "branches": [ # A list of branches configured to be used from Dialogflow. + "A String", + ], + "displayName": "A String", # The unique repository display name for the GitHub repository. + "repositoryUri": "A String", # The GitHub repository URI related to the agent. + "trackingBranch": "A String", # The branch of GitHub repository tracked for this agent. + }, + }, "locked": True or False, # Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for RestoreAgent. "name": "A String", # The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`. "securitySettings": "A String", # Name of the SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. @@ -292,6 +314,10 @@

Method Details

"agentUri": "A String", # Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to export the agent to. The format of this URI must be `gs:///`. If left unspecified, the serialized agent is returned inline. Dialogflow performs a write operation for the Cloud Storage object on the caller's behalf, so your request authentication must have write permissions for the object. For more information, see [Dialogflow access control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage). "dataFormat": "A String", # Optional. The data format of the exported agent. If not specified, `BLOB` is assumed. "environment": "A String", # Optional. Environment name. If not set, draft environment is assumed. Format: `projects//locations//agents//environments/`. + "gitDestination": { # Settings for exporting to a git branch. # Optional. The Git branch to export the agent to. + "commitMessage": "A String", # Commit message for the git push. + "trackingBranch": "A String", # Tracking branch for the git push. + }, "includeBigqueryExportSettings": True or False, # Optional. Whether to include BigQuery Export setting. } @@ -354,6 +380,17 @@

Method Details

"displayName": "A String", # Required. The human-readable name of the agent, unique within the location. "enableSpellCorrection": True or False, # Indicates if automatic spell correction is enabled in detect intent requests. "enableStackdriverLogging": True or False, # Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead. + "gitIntegrationSettings": { # Settings for connecting to Git repository for an agent. # Git integration settings for this agent. + "githubSettings": { # Settings of integration with GitHub. # GitHub settings. + "accessToken": "A String", # The access token used to authenticate the access to the GitHub repository. + "branches": [ # A list of branches configured to be used from Dialogflow. + "A String", + ], + "displayName": "A String", # The unique repository display name for the GitHub repository. + "repositoryUri": "A String", # The GitHub repository URI related to the agent. + "trackingBranch": "A String", # The branch of GitHub repository tracked for this agent. + }, + }, "locked": True or False, # Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for RestoreAgent. "name": "A String", # The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`. "securitySettings": "A String", # Name of the SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. @@ -460,6 +497,17 @@

Method Details

"displayName": "A String", # Required. The human-readable name of the agent, unique within the location. "enableSpellCorrection": True or False, # Indicates if automatic spell correction is enabled in detect intent requests. "enableStackdriverLogging": True or False, # Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead. + "gitIntegrationSettings": { # Settings for connecting to Git repository for an agent. # Git integration settings for this agent. + "githubSettings": { # Settings of integration with GitHub. # GitHub settings. + "accessToken": "A String", # The access token used to authenticate the access to the GitHub repository. + "branches": [ # A list of branches configured to be used from Dialogflow. + "A String", + ], + "displayName": "A String", # The unique repository display name for the GitHub repository. + "repositoryUri": "A String", # The GitHub repository URI related to the agent. + "trackingBranch": "A String", # The branch of GitHub repository tracked for this agent. + }, + }, "locked": True or False, # Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for RestoreAgent. "name": "A String", # The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`. "securitySettings": "A String", # Name of the SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. @@ -532,6 +580,17 @@

Method Details

"displayName": "A String", # Required. The human-readable name of the agent, unique within the location. "enableSpellCorrection": True or False, # Indicates if automatic spell correction is enabled in detect intent requests. "enableStackdriverLogging": True or False, # Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead. + "gitIntegrationSettings": { # Settings for connecting to Git repository for an agent. # Git integration settings for this agent. + "githubSettings": { # Settings of integration with GitHub. # GitHub settings. + "accessToken": "A String", # The access token used to authenticate the access to the GitHub repository. + "branches": [ # A list of branches configured to be used from Dialogflow. + "A String", + ], + "displayName": "A String", # The unique repository display name for the GitHub repository. + "repositoryUri": "A String", # The GitHub repository URI related to the agent. + "trackingBranch": "A String", # The branch of GitHub repository tracked for this agent. + }, + }, "locked": True or False, # Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for RestoreAgent. "name": "A String", # The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`. "securitySettings": "A String", # Name of the SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. @@ -586,6 +645,17 @@

Method Details

"displayName": "A String", # Required. The human-readable name of the agent, unique within the location. "enableSpellCorrection": True or False, # Indicates if automatic spell correction is enabled in detect intent requests. "enableStackdriverLogging": True or False, # Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead. + "gitIntegrationSettings": { # Settings for connecting to Git repository for an agent. # Git integration settings for this agent. + "githubSettings": { # Settings of integration with GitHub. # GitHub settings. + "accessToken": "A String", # The access token used to authenticate the access to the GitHub repository. + "branches": [ # A list of branches configured to be used from Dialogflow. + "A String", + ], + "displayName": "A String", # The unique repository display name for the GitHub repository. + "repositoryUri": "A String", # The GitHub repository URI related to the agent. + "trackingBranch": "A String", # The branch of GitHub repository tracked for this agent. + }, + }, "locked": True or False, # Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for RestoreAgent. "name": "A String", # The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`. "securitySettings": "A String", # Name of the SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. @@ -628,6 +698,9 @@

Method Details

{ # The request message for Agents.RestoreAgent. "agentContent": "A String", # Uncompressed raw byte content for agent. "agentUri": "A String", # The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to restore agent from. The format of this URI must be `gs:///`. Dialogflow performs a read operation for the Cloud Storage object on the caller's behalf, so your request authentication must have read permissions for the object. For more information, see [Dialogflow access control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage). + "gitSource": { # Settings for restoring from a git branch # Setting for restoring from a git branch + "trackingBranch": "A String", # tracking branch for the git pull + }, "restoreOption": "A String", # Agent restore mode. If not specified, `KEEP` is assumed. } diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.html index 03efa9e3f77..1600797d78c 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.html @@ -178,6 +178,17 @@

Method Details

"displayName": "A String", # Required. The human-readable name of the agent, unique within the location. "enableSpellCorrection": True or False, # Indicates if automatic spell correction is enabled in detect intent requests. "enableStackdriverLogging": True or False, # Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead. + "gitIntegrationSettings": { # Settings for connecting to Git repository for an agent. # Git integration settings for this agent. + "githubSettings": { # Settings of integration with GitHub. # GitHub settings. + "accessToken": "A String", # The access token used to authenticate the access to the GitHub repository. + "branches": [ # A list of branches configured to be used from Dialogflow. + "A String", + ], + "displayName": "A String", # The unique repository display name for the GitHub repository. + "repositoryUri": "A String", # The GitHub repository URI related to the agent. + "trackingBranch": "A String", # The branch of GitHub repository tracked for this agent. + }, + }, "locked": True or False, # Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for RestoreAgent. "name": "A String", # The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`. "securitySettings": "A String", # Name of the SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. @@ -231,6 +242,17 @@

Method Details

"displayName": "A String", # Required. The human-readable name of the agent, unique within the location. "enableSpellCorrection": True or False, # Indicates if automatic spell correction is enabled in detect intent requests. "enableStackdriverLogging": True or False, # Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead. + "gitIntegrationSettings": { # Settings for connecting to Git repository for an agent. # Git integration settings for this agent. + "githubSettings": { # Settings of integration with GitHub. # GitHub settings. + "accessToken": "A String", # The access token used to authenticate the access to the GitHub repository. + "branches": [ # A list of branches configured to be used from Dialogflow. + "A String", + ], + "displayName": "A String", # The unique repository display name for the GitHub repository. + "repositoryUri": "A String", # The GitHub repository URI related to the agent. + "trackingBranch": "A String", # The branch of GitHub repository tracked for this agent. + }, + }, "locked": True or False, # Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for RestoreAgent. "name": "A String", # The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`. "securitySettings": "A String", # Name of the SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. @@ -292,6 +314,10 @@

Method Details

"agentUri": "A String", # Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to export the agent to. The format of this URI must be `gs:///`. If left unspecified, the serialized agent is returned inline. Dialogflow performs a write operation for the Cloud Storage object on the caller's behalf, so your request authentication must have write permissions for the object. For more information, see [Dialogflow access control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage). "dataFormat": "A String", # Optional. The data format of the exported agent. If not specified, `BLOB` is assumed. "environment": "A String", # Optional. Environment name. If not set, draft environment is assumed. Format: `projects//locations//agents//environments/`. + "gitDestination": { # Settings for exporting to a git branch. # Optional. The Git branch to export the agent to. + "commitMessage": "A String", # Commit message for the git push. + "trackingBranch": "A String", # Tracking branch for the git push. + }, "includeBigqueryExportSettings": True or False, # Optional. Whether to include BigQuery Export setting. } @@ -354,6 +380,17 @@

Method Details

"displayName": "A String", # Required. The human-readable name of the agent, unique within the location. "enableSpellCorrection": True or False, # Indicates if automatic spell correction is enabled in detect intent requests. "enableStackdriverLogging": True or False, # Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead. + "gitIntegrationSettings": { # Settings for connecting to Git repository for an agent. # Git integration settings for this agent. + "githubSettings": { # Settings of integration with GitHub. # GitHub settings. + "accessToken": "A String", # The access token used to authenticate the access to the GitHub repository. + "branches": [ # A list of branches configured to be used from Dialogflow. + "A String", + ], + "displayName": "A String", # The unique repository display name for the GitHub repository. + "repositoryUri": "A String", # The GitHub repository URI related to the agent. + "trackingBranch": "A String", # The branch of GitHub repository tracked for this agent. + }, + }, "locked": True or False, # Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for RestoreAgent. "name": "A String", # The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`. "securitySettings": "A String", # Name of the SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. @@ -460,6 +497,17 @@

Method Details

"displayName": "A String", # Required. The human-readable name of the agent, unique within the location. "enableSpellCorrection": True or False, # Indicates if automatic spell correction is enabled in detect intent requests. "enableStackdriverLogging": True or False, # Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead. + "gitIntegrationSettings": { # Settings for connecting to Git repository for an agent. # Git integration settings for this agent. + "githubSettings": { # Settings of integration with GitHub. # GitHub settings. + "accessToken": "A String", # The access token used to authenticate the access to the GitHub repository. + "branches": [ # A list of branches configured to be used from Dialogflow. + "A String", + ], + "displayName": "A String", # The unique repository display name for the GitHub repository. + "repositoryUri": "A String", # The GitHub repository URI related to the agent. + "trackingBranch": "A String", # The branch of GitHub repository tracked for this agent. + }, + }, "locked": True or False, # Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for RestoreAgent. "name": "A String", # The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`. "securitySettings": "A String", # Name of the SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. @@ -532,6 +580,17 @@

Method Details

"displayName": "A String", # Required. The human-readable name of the agent, unique within the location. "enableSpellCorrection": True or False, # Indicates if automatic spell correction is enabled in detect intent requests. "enableStackdriverLogging": True or False, # Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead. + "gitIntegrationSettings": { # Settings for connecting to Git repository for an agent. # Git integration settings for this agent. + "githubSettings": { # Settings of integration with GitHub. # GitHub settings. + "accessToken": "A String", # The access token used to authenticate the access to the GitHub repository. + "branches": [ # A list of branches configured to be used from Dialogflow. + "A String", + ], + "displayName": "A String", # The unique repository display name for the GitHub repository. + "repositoryUri": "A String", # The GitHub repository URI related to the agent. + "trackingBranch": "A String", # The branch of GitHub repository tracked for this agent. + }, + }, "locked": True or False, # Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for RestoreAgent. "name": "A String", # The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`. "securitySettings": "A String", # Name of the SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. @@ -586,6 +645,17 @@

Method Details

"displayName": "A String", # Required. The human-readable name of the agent, unique within the location. "enableSpellCorrection": True or False, # Indicates if automatic spell correction is enabled in detect intent requests. "enableStackdriverLogging": True or False, # Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead. + "gitIntegrationSettings": { # Settings for connecting to Git repository for an agent. # Git integration settings for this agent. + "githubSettings": { # Settings of integration with GitHub. # GitHub settings. + "accessToken": "A String", # The access token used to authenticate the access to the GitHub repository. + "branches": [ # A list of branches configured to be used from Dialogflow. + "A String", + ], + "displayName": "A String", # The unique repository display name for the GitHub repository. + "repositoryUri": "A String", # The GitHub repository URI related to the agent. + "trackingBranch": "A String", # The branch of GitHub repository tracked for this agent. + }, + }, "locked": True or False, # Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for RestoreAgent. "name": "A String", # The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`. "securitySettings": "A String", # Name of the SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. @@ -628,6 +698,9 @@

Method Details

{ # The request message for Agents.RestoreAgent. "agentContent": "A String", # Uncompressed raw byte content for agent. "agentUri": "A String", # The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to restore agent from. The format of this URI must be `gs:///`. Dialogflow performs a read operation for the Cloud Storage object on the caller's behalf, so your request authentication must have read permissions for the object. For more information, see [Dialogflow access control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage). + "gitSource": { # Settings for restoring from a git branch # Setting for restoring from a git branch + "trackingBranch": "A String", # tracking branch for the git pull + }, "restoreOption": "A String", # Agent restore mode. If not specified, `KEEP` is assumed. } diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.documents.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.documents.html index 372d8f0709c..bc10878f435 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.documents.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.documents.html @@ -204,7 +204,7 @@

Method Details

{ # Request message for Import methods. "autoGenerateIds": True or False, # Whether to automatically generate IDs for the documents if absent. If set to `true`, Document.ids are automatically generated based on the hash of the payload, where IDs may not be consistent during multiple imports. In which case ReconciliationMode.FULL is highly recommended to avoid duplicate contents. If unset or set to `false`, Document.ids have to be specified using id_field, otherwise, documents without IDs fail to be imported. Only set this field when using GcsSource or BigQuerySource, and when GcsSource.data_schema or BigQuerySource.data_schema is `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. "bigquerySource": { # BigQuery source import data from. # BigQuery input source. - "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. + "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by Gen App Builder. "datasetId": "A String", # Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters. "gcsStagingDir": "A String", # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory. "partitionDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.userEvents.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.userEvents.html index 24c8ed1057a..ff5b45c8614 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.userEvents.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.userEvents.html @@ -134,7 +134,7 @@

Method Details

{ # Request message for the ImportUserEvents request. "bigquerySource": { # BigQuery source import data from. # BigQuery input source. - "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. + "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by Gen App Builder. "datasetId": "A String", # Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters. "gcsStagingDir": "A String", # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory. "partitionDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.documents.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.documents.html index 3089505cf93..a56e55bcdd2 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.documents.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.documents.html @@ -204,7 +204,7 @@

Method Details

{ # Request message for Import methods. "autoGenerateIds": True or False, # Whether to automatically generate IDs for the documents if absent. If set to `true`, Document.ids are automatically generated based on the hash of the payload, where IDs may not be consistent during multiple imports. In which case ReconciliationMode.FULL is highly recommended to avoid duplicate contents. If unset or set to `false`, Document.ids have to be specified using id_field, otherwise, documents without IDs fail to be imported. Only set this field when using GcsSource or BigQuerySource, and when GcsSource.data_schema or BigQuerySource.data_schema is `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. "bigquerySource": { # BigQuery source import data from. # BigQuery input source. - "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. + "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by Gen App Builder. "datasetId": "A String", # Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters. "gcsStagingDir": "A String", # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory. "partitionDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.userEvents.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.userEvents.html index 21e8026d006..9b65fe88c17 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.userEvents.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.userEvents.html @@ -134,7 +134,7 @@

Method Details

{ # Request message for the ImportUserEvents request. "bigquerySource": { # BigQuery source import data from. # BigQuery input source. - "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. + "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by Gen App Builder. "datasetId": "A String", # Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters. "gcsStagingDir": "A String", # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory. "partitionDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.documents.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.documents.html index dce0d9fbfcc..93461d304cf 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.documents.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.documents.html @@ -204,7 +204,7 @@

Method Details

{ # Request message for Import methods. "autoGenerateIds": True or False, # Whether to automatically generate IDs for the documents if absent. If set to `true`, Document.ids are automatically generated based on the hash of the payload, where IDs may not be consistent during multiple imports. In which case ReconciliationMode.FULL is highly recommended to avoid duplicate contents. If unset or set to `false`, Document.ids have to be specified using id_field, otherwise, documents without IDs fail to be imported. Only set this field when using GcsSource or BigQuerySource, and when GcsSource.data_schema or BigQuerySource.data_schema is `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. "bigquerySource": { # BigQuery source import data from. # BigQuery input source. - "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. + "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by Gen App Builder. "datasetId": "A String", # Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters. "gcsStagingDir": "A String", # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory. "partitionDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.userEvents.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.userEvents.html index 6507c0862df..74321f47c78 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.userEvents.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.userEvents.html @@ -131,7 +131,7 @@

Method Details

{ # Request message for the ImportUserEvents request. "bigquerySource": { # BigQuery source import data from. # BigQuery input source. - "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. + "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by Gen App Builder. "datasetId": "A String", # Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters. "gcsStagingDir": "A String", # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory. "partitionDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.documents.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.documents.html index 74c5dc7ef91..32472ba3484 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.documents.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.documents.html @@ -204,7 +204,7 @@

Method Details

{ # Request message for Import methods. "autoGenerateIds": True or False, # Whether to automatically generate IDs for the documents if absent. If set to `true`, Document.ids are automatically generated based on the hash of the payload, where IDs may not be consistent during multiple imports. In which case ReconciliationMode.FULL is highly recommended to avoid duplicate contents. If unset or set to `false`, Document.ids have to be specified using id_field, otherwise, documents without IDs fail to be imported. Only set this field when using GcsSource or BigQuerySource, and when GcsSource.data_schema or BigQuerySource.data_schema is `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. "bigquerySource": { # BigQuery source import data from. # BigQuery input source. - "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. + "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by Gen App Builder. "datasetId": "A String", # Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters. "gcsStagingDir": "A String", # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory. "partitionDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.userEvents.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.userEvents.html index ee385e46be2..dfd0117d495 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.userEvents.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.userEvents.html @@ -131,7 +131,7 @@

Method Details

{ # Request message for the ImportUserEvents request. "bigquerySource": { # BigQuery source import data from. # BigQuery input source. - "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. + "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by Gen App Builder. "datasetId": "A String", # Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters. "gcsStagingDir": "A String", # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory. "partitionDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format. diff --git a/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.html b/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.html index a6448a8f07c..153af426cbe 100644 --- a/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.html +++ b/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.html @@ -152,7 +152,17 @@

Method Details

"name": "A String", # Resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. "notificationConfig": { # Specifies where to send notifications upon changes to a data store. # Notification destination for new DICOM instances. Supplied by the client. "pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data contains the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. Cloud Healthcare API service account must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). If the number of errors exceeds a certain rate, some aren't submitted. Note that not all operations trigger notifications, see [Configuring Pub/Sub notifications](https://cloud.google.com/healthcare/docs/how-tos/pubsub) for specific details. + "sendForBulkImport": True or False, # Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports. }, + "streamConfigs": [ # Optional. A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination. + { # StreamConfig specifies configuration for a streaming DICOM export. + "bigqueryDestination": { # The BigQuery table where the server writes the output. # Results are appended to this table. The server creates a new table in the given BigQuery dataset if the specified table does not exist. To enable the Cloud Healthcare API to write to your BigQuery table, you must give the Cloud Healthcare API service account the bigquery.dataEditor role. The service account is: `service-{PROJECT_NUMBER}@gcp-sa-healthcare.iam.gserviceaccount.com`. The PROJECT_NUMBER identifies the project that the DICOM store resides in. To get the project number, go to the Cloud Console Dashboard. It is recommended to not have a custom schema in the destination table which could conflict with the schema created by the Cloud Healthcare API. Instance deletions are not applied to the destination table. The destination's table schema will be automatically updated in case a new instance's data is incompatible with the current schema. The schema should not be updated manually as this can cause incompatibilies that cannot be resolved automatically. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any instance that generates more than 1 MB of BigQuery data will not be streamed. If an instance cannot be streamed to BigQuery, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). + "force": True or False, # Use `write_disposition` instead. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. + "tableUri": "A String", # BigQuery URI to a table, up to 2000 characters long, in the format `bq://projectId.bqDatasetId.tableId` + "writeDisposition": "A String", # Determines whether the existing table in the destination is to be overwritten or appended to. If a write_disposition is specified, the `force` parameter is ignored. + }, + }, + ], } dicomStoreId: string, The ID of the DICOM store that is being created. Any string value up to 256 characters in length. @@ -171,7 +181,17 @@

Method Details

"name": "A String", # Resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. "notificationConfig": { # Specifies where to send notifications upon changes to a data store. # Notification destination for new DICOM instances. Supplied by the client. "pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data contains the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. Cloud Healthcare API service account must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). If the number of errors exceeds a certain rate, some aren't submitted. Note that not all operations trigger notifications, see [Configuring Pub/Sub notifications](https://cloud.google.com/healthcare/docs/how-tos/pubsub) for specific details. + "sendForBulkImport": True or False, # Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports. }, + "streamConfigs": [ # Optional. A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination. + { # StreamConfig specifies configuration for a streaming DICOM export. + "bigqueryDestination": { # The BigQuery table where the server writes the output. # Results are appended to this table. The server creates a new table in the given BigQuery dataset if the specified table does not exist. To enable the Cloud Healthcare API to write to your BigQuery table, you must give the Cloud Healthcare API service account the bigquery.dataEditor role. The service account is: `service-{PROJECT_NUMBER}@gcp-sa-healthcare.iam.gserviceaccount.com`. The PROJECT_NUMBER identifies the project that the DICOM store resides in. To get the project number, go to the Cloud Console Dashboard. It is recommended to not have a custom schema in the destination table which could conflict with the schema created by the Cloud Healthcare API. Instance deletions are not applied to the destination table. The destination's table schema will be automatically updated in case a new instance's data is incompatible with the current schema. The schema should not be updated manually as this can cause incompatibilies that cannot be resolved automatically. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any instance that generates more than 1 MB of BigQuery data will not be streamed. If an instance cannot be streamed to BigQuery, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). + "force": True or False, # Use `write_disposition` instead. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. + "tableUri": "A String", # BigQuery URI to a table, up to 2000 characters long, in the format `bq://projectId.bqDatasetId.tableId` + "writeDisposition": "A String", # Determines whether the existing table in the destination is to be overwritten or appended to. If a write_disposition is specified, the `force` parameter is ignored. + }, + }, + ], }
@@ -402,7 +422,17 @@

Method Details

"name": "A String", # Resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. "notificationConfig": { # Specifies where to send notifications upon changes to a data store. # Notification destination for new DICOM instances. Supplied by the client. "pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data contains the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. Cloud Healthcare API service account must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). If the number of errors exceeds a certain rate, some aren't submitted. Note that not all operations trigger notifications, see [Configuring Pub/Sub notifications](https://cloud.google.com/healthcare/docs/how-tos/pubsub) for specific details. + "sendForBulkImport": True or False, # Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports. }, + "streamConfigs": [ # Optional. A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination. + { # StreamConfig specifies configuration for a streaming DICOM export. + "bigqueryDestination": { # The BigQuery table where the server writes the output. # Results are appended to this table. The server creates a new table in the given BigQuery dataset if the specified table does not exist. To enable the Cloud Healthcare API to write to your BigQuery table, you must give the Cloud Healthcare API service account the bigquery.dataEditor role. The service account is: `service-{PROJECT_NUMBER}@gcp-sa-healthcare.iam.gserviceaccount.com`. The PROJECT_NUMBER identifies the project that the DICOM store resides in. To get the project number, go to the Cloud Console Dashboard. It is recommended to not have a custom schema in the destination table which could conflict with the schema created by the Cloud Healthcare API. Instance deletions are not applied to the destination table. The destination's table schema will be automatically updated in case a new instance's data is incompatible with the current schema. The schema should not be updated manually as this can cause incompatibilies that cannot be resolved automatically. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any instance that generates more than 1 MB of BigQuery data will not be streamed. If an instance cannot be streamed to BigQuery, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). + "force": True or False, # Use `write_disposition` instead. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. + "tableUri": "A String", # BigQuery URI to a table, up to 2000 characters long, in the format `bq://projectId.bqDatasetId.tableId` + "writeDisposition": "A String", # Determines whether the existing table in the destination is to be overwritten or appended to. If a write_disposition is specified, the `force` parameter is ignored. + }, + }, + ], }
@@ -524,7 +554,17 @@

Method Details

"name": "A String", # Resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. "notificationConfig": { # Specifies where to send notifications upon changes to a data store. # Notification destination for new DICOM instances. Supplied by the client. "pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data contains the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. Cloud Healthcare API service account must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). If the number of errors exceeds a certain rate, some aren't submitted. Note that not all operations trigger notifications, see [Configuring Pub/Sub notifications](https://cloud.google.com/healthcare/docs/how-tos/pubsub) for specific details. + "sendForBulkImport": True or False, # Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports. }, + "streamConfigs": [ # Optional. A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination. + { # StreamConfig specifies configuration for a streaming DICOM export. + "bigqueryDestination": { # The BigQuery table where the server writes the output. # Results are appended to this table. The server creates a new table in the given BigQuery dataset if the specified table does not exist. To enable the Cloud Healthcare API to write to your BigQuery table, you must give the Cloud Healthcare API service account the bigquery.dataEditor role. The service account is: `service-{PROJECT_NUMBER}@gcp-sa-healthcare.iam.gserviceaccount.com`. The PROJECT_NUMBER identifies the project that the DICOM store resides in. To get the project number, go to the Cloud Console Dashboard. It is recommended to not have a custom schema in the destination table which could conflict with the schema created by the Cloud Healthcare API. Instance deletions are not applied to the destination table. The destination's table schema will be automatically updated in case a new instance's data is incompatible with the current schema. The schema should not be updated manually as this can cause incompatibilies that cannot be resolved automatically. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any instance that generates more than 1 MB of BigQuery data will not be streamed. If an instance cannot be streamed to BigQuery, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). + "force": True or False, # Use `write_disposition` instead. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. + "tableUri": "A String", # BigQuery URI to a table, up to 2000 characters long, in the format `bq://projectId.bqDatasetId.tableId` + "writeDisposition": "A String", # Determines whether the existing table in the destination is to be overwritten or appended to. If a write_disposition is specified, the `force` parameter is ignored. + }, + }, + ], }, ], "nextPageToken": "A String", # Token to retrieve the next page of results or empty if there are no more results in the list. @@ -561,7 +601,17 @@

Method Details

"name": "A String", # Resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. "notificationConfig": { # Specifies where to send notifications upon changes to a data store. # Notification destination for new DICOM instances. Supplied by the client. "pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data contains the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. Cloud Healthcare API service account must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). If the number of errors exceeds a certain rate, some aren't submitted. Note that not all operations trigger notifications, see [Configuring Pub/Sub notifications](https://cloud.google.com/healthcare/docs/how-tos/pubsub) for specific details. + "sendForBulkImport": True or False, # Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports. }, + "streamConfigs": [ # Optional. A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination. + { # StreamConfig specifies configuration for a streaming DICOM export. + "bigqueryDestination": { # The BigQuery table where the server writes the output. # Results are appended to this table. The server creates a new table in the given BigQuery dataset if the specified table does not exist. To enable the Cloud Healthcare API to write to your BigQuery table, you must give the Cloud Healthcare API service account the bigquery.dataEditor role. The service account is: `service-{PROJECT_NUMBER}@gcp-sa-healthcare.iam.gserviceaccount.com`. The PROJECT_NUMBER identifies the project that the DICOM store resides in. To get the project number, go to the Cloud Console Dashboard. It is recommended to not have a custom schema in the destination table which could conflict with the schema created by the Cloud Healthcare API. Instance deletions are not applied to the destination table. The destination's table schema will be automatically updated in case a new instance's data is incompatible with the current schema. The schema should not be updated manually as this can cause incompatibilies that cannot be resolved automatically. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any instance that generates more than 1 MB of BigQuery data will not be streamed. If an instance cannot be streamed to BigQuery, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). + "force": True or False, # Use `write_disposition` instead. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. + "tableUri": "A String", # BigQuery URI to a table, up to 2000 characters long, in the format `bq://projectId.bqDatasetId.tableId` + "writeDisposition": "A String", # Determines whether the existing table in the destination is to be overwritten or appended to. If a write_disposition is specified, the `force` parameter is ignored. + }, + }, + ], } updateMask: string, The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask @@ -580,7 +630,17 @@

Method Details

"name": "A String", # Resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. "notificationConfig": { # Specifies where to send notifications upon changes to a data store. # Notification destination for new DICOM instances. Supplied by the client. "pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data contains the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. Cloud Healthcare API service account must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). If the number of errors exceeds a certain rate, some aren't submitted. Note that not all operations trigger notifications, see [Configuring Pub/Sub notifications](https://cloud.google.com/healthcare/docs/how-tos/pubsub) for specific details. + "sendForBulkImport": True or False, # Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports. }, + "streamConfigs": [ # Optional. A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination. + { # StreamConfig specifies configuration for a streaming DICOM export. + "bigqueryDestination": { # The BigQuery table where the server writes the output. # Results are appended to this table. The server creates a new table in the given BigQuery dataset if the specified table does not exist. To enable the Cloud Healthcare API to write to your BigQuery table, you must give the Cloud Healthcare API service account the bigquery.dataEditor role. The service account is: `service-{PROJECT_NUMBER}@gcp-sa-healthcare.iam.gserviceaccount.com`. The PROJECT_NUMBER identifies the project that the DICOM store resides in. To get the project number, go to the Cloud Console Dashboard. It is recommended to not have a custom schema in the destination table which could conflict with the schema created by the Cloud Healthcare API. Instance deletions are not applied to the destination table. The destination's table schema will be automatically updated in case a new instance's data is incompatible with the current schema. The schema should not be updated manually as this can cause incompatibilies that cannot be resolved automatically. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any instance that generates more than 1 MB of BigQuery data will not be streamed. If an instance cannot be streamed to BigQuery, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). + "force": True or False, # Use `write_disposition` instead. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. + "tableUri": "A String", # BigQuery URI to a table, up to 2000 characters long, in the format `bq://projectId.bqDatasetId.tableId` + "writeDisposition": "A String", # Determines whether the existing table in the destination is to be overwritten or appended to. If a write_disposition is specified, the `force` parameter is ignored. + }, + }, + ], }
diff --git a/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.html b/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.html index 4e06c04656d..b999ff49908 100644 --- a/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.html +++ b/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.html @@ -148,6 +148,7 @@

Method Details

"name": "A String", # Output only. Resource name of the FHIR store, of the form `projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. "notificationConfig": { # Specifies where to send notifications upon changes to a data store. # Deprecated. Use `notification_configs` instead. If non-empty, publish all resource modifications of this FHIR store to this destination. The Pub/Sub message attributes contain a map with a string describing the action that has triggered the notification. For example, "action":"CreateResource". "pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data contains the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. Cloud Healthcare API service account must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). If the number of errors exceeds a certain rate, some aren't submitted. Note that not all operations trigger notifications, see [Configuring Pub/Sub notifications](https://cloud.google.com/healthcare/docs/how-tos/pubsub) for specific details. + "sendForBulkImport": True or False, # Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports. }, "notificationConfigs": [ # Specifies where and whether to send notifications upon changes to a FHIR store. { # Contains the configuration for FHIR notifications. @@ -304,6 +305,7 @@

Method Details

"name": "A String", # Output only. Resource name of the FHIR store, of the form `projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. "notificationConfig": { # Specifies where to send notifications upon changes to a data store. # Deprecated. Use `notification_configs` instead. If non-empty, publish all resource modifications of this FHIR store to this destination. The Pub/Sub message attributes contain a map with a string describing the action that has triggered the notification. For example, "action":"CreateResource". "pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data contains the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. Cloud Healthcare API service account must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). If the number of errors exceeds a certain rate, some aren't submitted. Note that not all operations trigger notifications, see [Configuring Pub/Sub notifications](https://cloud.google.com/healthcare/docs/how-tos/pubsub) for specific details. + "sendForBulkImport": True or False, # Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports. }, "notificationConfigs": [ # Specifies where and whether to send notifications upon changes to a FHIR store. { # Contains the configuration for FHIR notifications. @@ -686,6 +688,7 @@

Method Details

"name": "A String", # Output only. Resource name of the FHIR store, of the form `projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. "notificationConfig": { # Specifies where to send notifications upon changes to a data store. # Deprecated. Use `notification_configs` instead. If non-empty, publish all resource modifications of this FHIR store to this destination. The Pub/Sub message attributes contain a map with a string describing the action that has triggered the notification. For example, "action":"CreateResource". "pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data contains the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. Cloud Healthcare API service account must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). If the number of errors exceeds a certain rate, some aren't submitted. Note that not all operations trigger notifications, see [Configuring Pub/Sub notifications](https://cloud.google.com/healthcare/docs/how-tos/pubsub) for specific details. + "sendForBulkImport": True or False, # Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports. }, "notificationConfigs": [ # Specifies where and whether to send notifications upon changes to a FHIR store. { # Contains the configuration for FHIR notifications. @@ -972,6 +975,7 @@

Method Details

"name": "A String", # Output only. Resource name of the FHIR store, of the form `projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. "notificationConfig": { # Specifies where to send notifications upon changes to a data store. # Deprecated. Use `notification_configs` instead. If non-empty, publish all resource modifications of this FHIR store to this destination. The Pub/Sub message attributes contain a map with a string describing the action that has triggered the notification. For example, "action":"CreateResource". "pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data contains the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. Cloud Healthcare API service account must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). If the number of errors exceeds a certain rate, some aren't submitted. Note that not all operations trigger notifications, see [Configuring Pub/Sub notifications](https://cloud.google.com/healthcare/docs/how-tos/pubsub) for specific details. + "sendForBulkImport": True or False, # Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports. }, "notificationConfigs": [ # Specifies where and whether to send notifications upon changes to a FHIR store. { # Contains the configuration for FHIR notifications. @@ -1146,6 +1150,7 @@

Method Details

"name": "A String", # Output only. Resource name of the FHIR store, of the form `projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. "notificationConfig": { # Specifies where to send notifications upon changes to a data store. # Deprecated. Use `notification_configs` instead. If non-empty, publish all resource modifications of this FHIR store to this destination. The Pub/Sub message attributes contain a map with a string describing the action that has triggered the notification. For example, "action":"CreateResource". "pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data contains the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. Cloud Healthcare API service account must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). If the number of errors exceeds a certain rate, some aren't submitted. Note that not all operations trigger notifications, see [Configuring Pub/Sub notifications](https://cloud.google.com/healthcare/docs/how-tos/pubsub) for specific details. + "sendForBulkImport": True or False, # Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports. }, "notificationConfigs": [ # Specifies where and whether to send notifications upon changes to a FHIR store. { # Contains the configuration for FHIR notifications. @@ -1302,6 +1307,7 @@

Method Details

"name": "A String", # Output only. Resource name of the FHIR store, of the form `projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. "notificationConfig": { # Specifies where to send notifications upon changes to a data store. # Deprecated. Use `notification_configs` instead. If non-empty, publish all resource modifications of this FHIR store to this destination. The Pub/Sub message attributes contain a map with a string describing the action that has triggered the notification. For example, "action":"CreateResource". "pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data contains the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. Cloud Healthcare API service account must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). If the number of errors exceeds a certain rate, some aren't submitted. Note that not all operations trigger notifications, see [Configuring Pub/Sub notifications](https://cloud.google.com/healthcare/docs/how-tos/pubsub) for specific details. + "sendForBulkImport": True or False, # Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports. }, "notificationConfigs": [ # Specifies where and whether to send notifications upon changes to a FHIR store. { # Contains the configuration for FHIR notifications. diff --git a/docs/dyn/healthcare_v1.projects.locations.datasets.hl7V2Stores.html b/docs/dyn/healthcare_v1.projects.locations.datasets.hl7V2Stores.html index 74d31ab360b..bf975e0bf99 100644 --- a/docs/dyn/healthcare_v1.projects.locations.datasets.hl7V2Stores.html +++ b/docs/dyn/healthcare_v1.projects.locations.datasets.hl7V2Stores.html @@ -323,11 +323,15 @@

Method Details

{ # Request to schedule an export. "endTime": "A String", # The end of the range in `send_time` (MSH.7, https://www.hl7.org/documentcenter/public_temp_2E58C1F9-1C23-BA17-0C6126475344DA9D/wg/conf/HL7MSH.htm) to process. If not specified, the time when the export is scheduled is used. This value has to come after the `start_time` defined below. Only messages whose `send_time` lies in the range `start_time` (inclusive) to `end_time` (exclusive) are exported. + "filter": "A String", # Restricts messages exported to those matching a filter, only applicable to PubsubDestination and GcsDestination. The following syntax is available: * A string field value can be written as text inside quotation marks, for example `"query text"`. The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, `"Comment = great"` returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in the `yyyy-mm-dd` format. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, and is just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. The following fields and functions are available for filtering: * `message_type`, from the MSH-9.1 field. For example, `NOT message_type = "ADT"`. * `send_date` or `sendDate`, the `yyyy-mm-dd` date the message was sent in the dataset's time_zone, from the MSH-7 segment. For example, `send_date < "2017-01-02"`. * `send_time`, the timestamp when the message was sent, using the RFC3339 time format for comparisons, from the MSH-7 segment. For example, `send_time < "2017-01-02T00:00:00-05:00"`. * `create_time`, the timestamp when the message was created in the HL7v2 store. Use the RFC3339 time format for comparisons. For example, `create_time < "2017-01-02T00:00:00-05:00"`. * `send_facility`, the care center that the message came from, from the MSH-4 segment. For example, `send_facility = "ABC"`. Note: The filter will be applied to every message in the HL7v2 store whose `send_time` lies in the range defined by the `start_time` and the `end_time`. Even if the filter only matches a small set of messages, the export operation can still take a long time to finish when a lot of messages are between the specified `start_time` and `end_time` range. "gcsDestination": { # The Cloud Storage output destination. The Cloud Healthcare Service Agent requires the `roles/storage.objectAdmin` Cloud IAM roles on the Cloud Storage location. # Export to a Cloud Storage destination. "contentStructure": "A String", # The format of the exported HL7v2 message files. "messageView": "A String", # Specifies the parts of the Message resource to include in the export. If not specified, FULL is used. "uriPrefix": "A String", # URI of an existing Cloud Storage directory where the server writes result files, in the format `gs://{bucket-id}/{path/to/destination/dir}`. If there is no trailing slash, the service appends one when composing the object path. }, + "pubsubDestination": { # The Pub/Sub output destination. The Cloud Healthcare Service Agent requires the `roles/pubsub.publisher` Cloud IAM role on the Pub/Sub topic. # Export messages to a Pub/Sub topic. + "pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that Pub/Sub messages are published on. Supplied by the client. The `PubsubMessage` contains the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-PROJECT_NUMBER@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. + }, "startTime": "A String", # The start of the range in `send_time` (MSH.7, https://www.hl7.org/documentcenter/public_temp_2E58C1F9-1C23-BA17-0C6126475344DA9D/wg/conf/HL7MSH.htm) to process. If not specified, the UNIX epoch (1970-01-01T00:00:00Z) is used. This value has to come before the `end_time` defined below. Only messages whose `send_time` lies in the range `start_time` (inclusive) to `end_time` (exclusive) are exported. } diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.html index 2b552eb88f7..32f486dbcae 100644 --- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.html +++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.html @@ -154,7 +154,7 @@

Method Details

"pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data contains the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. Cloud Healthcare API service account must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). If the number of errors exceeds a certain rate, some aren't submitted. Note that not all operations trigger notifications, see [Configuring Pub/Sub notifications](https://cloud.google.com/healthcare/docs/how-tos/pubsub) for specific details. "sendForBulkImport": True or False, # Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports. }, - "streamConfigs": [ # A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination. + "streamConfigs": [ # Optional. A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination. { # StreamConfig specifies configuration for a streaming DICOM export. "bigqueryDestination": { # The BigQuery table where the server writes output. # Results are appended to this table. The server creates a new table in the given BigQuery dataset if the specified table does not exist. To enable the Cloud Healthcare API to write to your BigQuery table, you must give the Cloud Healthcare API service account the bigquery.dataEditor role. The service account is: `service-{PROJECT_NUMBER}@gcp-sa-healthcare.iam.gserviceaccount.com`. The PROJECT_NUMBER identifies the project that the DICOM store resides in. To get the project number, go to the Cloud Console Dashboard. It is recommended to not have a custom schema in the destination table which could conflict with the schema created by the Cloud Healthcare API. Instance deletions are not applied to the destination table. The destination's table schema will be automatically updated in case a new instance's data is incompatible with the current schema. The schema should not be updated manually as this can cause incompatibilies that cannot be resolved automatically. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any instance that generates more than 1 MB of BigQuery data will not be streamed. If an instance cannot be streamed to BigQuery, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). "force": True or False, # Use `write_disposition` instead. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. @@ -183,7 +183,7 @@

Method Details

"pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data contains the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. Cloud Healthcare API service account must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). If the number of errors exceeds a certain rate, some aren't submitted. Note that not all operations trigger notifications, see [Configuring Pub/Sub notifications](https://cloud.google.com/healthcare/docs/how-tos/pubsub) for specific details. "sendForBulkImport": True or False, # Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports. }, - "streamConfigs": [ # A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination. + "streamConfigs": [ # Optional. A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination. { # StreamConfig specifies configuration for a streaming DICOM export. "bigqueryDestination": { # The BigQuery table where the server writes output. # Results are appended to this table. The server creates a new table in the given BigQuery dataset if the specified table does not exist. To enable the Cloud Healthcare API to write to your BigQuery table, you must give the Cloud Healthcare API service account the bigquery.dataEditor role. The service account is: `service-{PROJECT_NUMBER}@gcp-sa-healthcare.iam.gserviceaccount.com`. The PROJECT_NUMBER identifies the project that the DICOM store resides in. To get the project number, go to the Cloud Console Dashboard. It is recommended to not have a custom schema in the destination table which could conflict with the schema created by the Cloud Healthcare API. Instance deletions are not applied to the destination table. The destination's table schema will be automatically updated in case a new instance's data is incompatible with the current schema. The schema should not be updated manually as this can cause incompatibilies that cannot be resolved automatically. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any instance that generates more than 1 MB of BigQuery data will not be streamed. If an instance cannot be streamed to BigQuery, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). "force": True or False, # Use `write_disposition` instead. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. @@ -535,7 +535,7 @@

Method Details

"pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data contains the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. Cloud Healthcare API service account must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). If the number of errors exceeds a certain rate, some aren't submitted. Note that not all operations trigger notifications, see [Configuring Pub/Sub notifications](https://cloud.google.com/healthcare/docs/how-tos/pubsub) for specific details. "sendForBulkImport": True or False, # Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports. }, - "streamConfigs": [ # A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination. + "streamConfigs": [ # Optional. A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination. { # StreamConfig specifies configuration for a streaming DICOM export. "bigqueryDestination": { # The BigQuery table where the server writes output. # Results are appended to this table. The server creates a new table in the given BigQuery dataset if the specified table does not exist. To enable the Cloud Healthcare API to write to your BigQuery table, you must give the Cloud Healthcare API service account the bigquery.dataEditor role. The service account is: `service-{PROJECT_NUMBER}@gcp-sa-healthcare.iam.gserviceaccount.com`. The PROJECT_NUMBER identifies the project that the DICOM store resides in. To get the project number, go to the Cloud Console Dashboard. It is recommended to not have a custom schema in the destination table which could conflict with the schema created by the Cloud Healthcare API. Instance deletions are not applied to the destination table. The destination's table schema will be automatically updated in case a new instance's data is incompatible with the current schema. The schema should not be updated manually as this can cause incompatibilies that cannot be resolved automatically. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any instance that generates more than 1 MB of BigQuery data will not be streamed. If an instance cannot be streamed to BigQuery, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). "force": True or False, # Use `write_disposition` instead. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. @@ -667,7 +667,7 @@

Method Details

"pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data contains the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. Cloud Healthcare API service account must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). If the number of errors exceeds a certain rate, some aren't submitted. Note that not all operations trigger notifications, see [Configuring Pub/Sub notifications](https://cloud.google.com/healthcare/docs/how-tos/pubsub) for specific details. "sendForBulkImport": True or False, # Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports. }, - "streamConfigs": [ # A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination. + "streamConfigs": [ # Optional. A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination. { # StreamConfig specifies configuration for a streaming DICOM export. "bigqueryDestination": { # The BigQuery table where the server writes output. # Results are appended to this table. The server creates a new table in the given BigQuery dataset if the specified table does not exist. To enable the Cloud Healthcare API to write to your BigQuery table, you must give the Cloud Healthcare API service account the bigquery.dataEditor role. The service account is: `service-{PROJECT_NUMBER}@gcp-sa-healthcare.iam.gserviceaccount.com`. The PROJECT_NUMBER identifies the project that the DICOM store resides in. To get the project number, go to the Cloud Console Dashboard. It is recommended to not have a custom schema in the destination table which could conflict with the schema created by the Cloud Healthcare API. Instance deletions are not applied to the destination table. The destination's table schema will be automatically updated in case a new instance's data is incompatible with the current schema. The schema should not be updated manually as this can cause incompatibilies that cannot be resolved automatically. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any instance that generates more than 1 MB of BigQuery data will not be streamed. If an instance cannot be streamed to BigQuery, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). "force": True or False, # Use `write_disposition` instead. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. @@ -714,7 +714,7 @@

Method Details

"pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data contains the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. Cloud Healthcare API service account must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). If the number of errors exceeds a certain rate, some aren't submitted. Note that not all operations trigger notifications, see [Configuring Pub/Sub notifications](https://cloud.google.com/healthcare/docs/how-tos/pubsub) for specific details. "sendForBulkImport": True or False, # Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports. }, - "streamConfigs": [ # A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination. + "streamConfigs": [ # Optional. A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination. { # StreamConfig specifies configuration for a streaming DICOM export. "bigqueryDestination": { # The BigQuery table where the server writes output. # Results are appended to this table. The server creates a new table in the given BigQuery dataset if the specified table does not exist. To enable the Cloud Healthcare API to write to your BigQuery table, you must give the Cloud Healthcare API service account the bigquery.dataEditor role. The service account is: `service-{PROJECT_NUMBER}@gcp-sa-healthcare.iam.gserviceaccount.com`. The PROJECT_NUMBER identifies the project that the DICOM store resides in. To get the project number, go to the Cloud Console Dashboard. It is recommended to not have a custom schema in the destination table which could conflict with the schema created by the Cloud Healthcare API. Instance deletions are not applied to the destination table. The destination's table schema will be automatically updated in case a new instance's data is incompatible with the current schema. The schema should not be updated manually as this can cause incompatibilies that cannot be resolved automatically. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any instance that generates more than 1 MB of BigQuery data will not be streamed. If an instance cannot be streamed to BigQuery, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). "force": True or False, # Use `write_disposition` instead. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. @@ -743,7 +743,7 @@

Method Details

"pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data contains the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. Cloud Healthcare API service account must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). If the number of errors exceeds a certain rate, some aren't submitted. Note that not all operations trigger notifications, see [Configuring Pub/Sub notifications](https://cloud.google.com/healthcare/docs/how-tos/pubsub) for specific details. "sendForBulkImport": True or False, # Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports. }, - "streamConfigs": [ # A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination. + "streamConfigs": [ # Optional. A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination. { # StreamConfig specifies configuration for a streaming DICOM export. "bigqueryDestination": { # The BigQuery table where the server writes output. # Results are appended to this table. The server creates a new table in the given BigQuery dataset if the specified table does not exist. To enable the Cloud Healthcare API to write to your BigQuery table, you must give the Cloud Healthcare API service account the bigquery.dataEditor role. The service account is: `service-{PROJECT_NUMBER}@gcp-sa-healthcare.iam.gserviceaccount.com`. The PROJECT_NUMBER identifies the project that the DICOM store resides in. To get the project number, go to the Cloud Console Dashboard. It is recommended to not have a custom schema in the destination table which could conflict with the schema created by the Cloud Healthcare API. Instance deletions are not applied to the destination table. The destination's table schema will be automatically updated in case a new instance's data is incompatible with the current schema. The schema should not be updated manually as this can cause incompatibilies that cannot be resolved automatically. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any instance that generates more than 1 MB of BigQuery data will not be streamed. If an instance cannot be streamed to BigQuery, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). "force": True or False, # Use `write_disposition` instead. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.hl7V2Stores.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.hl7V2Stores.html index 6f1c873eae4..0c85b20c2ff 100644 --- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.hl7V2Stores.html +++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.hl7V2Stores.html @@ -331,11 +331,15 @@

Method Details

{ # Request to schedule an export. "endTime": "A String", # The end of the range in `send_time` (MSH.7, https://www.hl7.org/documentcenter/public_temp_2E58C1F9-1C23-BA17-0C6126475344DA9D/wg/conf/HL7MSH.htm) to process. If not specified, the time when the export is scheduled is used. This value has to come after the `start_time` defined below. Only messages whose `send_time` lies in the range `start_time` (inclusive) to `end_time` (exclusive) are exported. + "filter": "A String", # Restricts messages exported to those matching a filter, only applicable to PubsubDestination and GcsDestination. The following syntax is available: * A string field value can be written as text inside quotation marks, for example `"query text"`. The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, `"Comment = great"` returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in the `yyyy-mm-dd` format. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, and is just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. The following fields and functions are available for filtering: * `message_type`, from the MSH-9.1 field. For example, `NOT message_type = "ADT"`. * `send_date` or `sendDate`, the YYYY-MM-DD date the message was sent in the dataset's time_zone, from the MSH-7 segment. For example, `send_date < "2017-01-02"`. * `send_time`, the timestamp when the message was sent, using the RFC3339 time format for comparisons, from the MSH-7 segment. For example, `send_time < "2017-01-02T00:00:00-05:00"`. * `create_time`, the timestamp when the message was created in the HL7v2 store. Use the RFC3339 time format for comparisons. For example, `create_time < "2017-01-02T00:00:00-05:00"`. * `send_facility`, the care center that the message came from, from the MSH-4 segment. For example, `send_facility = "ABC"`. Note: The filter will be applied to every message in the HL7v2 store whose `send_time` lies in the range defined by the `start_time` and the `end_time`. Even if the filter only matches a small set of messages, the export operation can still take a long time to finish when a lot of messages are between the specified `start_time` and `end_time` range. "gcsDestination": { # The Cloud Storage output destination. The Cloud Healthcare Service Agent requires the `roles/storage.objectAdmin` Cloud IAM roles on the Cloud Storage location. # Export to a Cloud Storage destination. "contentStructure": "A String", # The format of the exported HL7v2 message files. "messageView": "A String", # Specifies the parts of the Message resource to include in the export. If not specified, FULL is used. "uriPrefix": "A String", # URI of an existing Cloud Storage directory where the server writes result files, in the format `gs://{bucket-id}/{path/to/destination/dir}`. If there is no trailing slash, the service appends one when composing the object path. }, + "pubsubDestination": { # The Pub/Sub output destination. The Cloud Healthcare Service Agent requires the `roles/pubsub.publisher` Cloud IAM role on the Pub/Sub topic. # Export messages to a Pub/Sub topic. + "pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that Pub/Sub messages are published on. Supplied by the client. The `PubsubMessage` contains the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-PROJECT_NUMBER@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. + }, "startTime": "A String", # The start of the range in `send_time` (MSH.7, https://www.hl7.org/documentcenter/public_temp_2E58C1F9-1C23-BA17-0C6126475344DA9D/wg/conf/HL7MSH.htm) to process. If not specified, the UNIX epoch (1970-01-01T00:00:00Z) is used. This value has to come before the `end_time` defined below. Only messages whose `send_time` lies in the range `start_time` (inclusive) to `end_time` (exclusive) are exported. } diff --git a/docs/dyn/identitytoolkit_v2.v2.html b/docs/dyn/identitytoolkit_v2.v2.html index 1d82ceb844a..35f71337444 100644 --- a/docs/dyn/identitytoolkit_v2.v2.html +++ b/docs/dyn/identitytoolkit_v2.v2.html @@ -115,6 +115,8 @@

Method Details

"maxPasswordLength": 42, # Maximum password length. No default max length "minPasswordLength": 42, # Minimum password length. Range from 6 to 30 }, + "enforcementState": "A String", # Output only. Which enforcement mode to use for the password policy. + "forceUpgradeOnSignin": True or False, # Users must have a password compliant with the password policy to sign-in. "schemaVersion": 42, # Output only. schema version number for the password policy } diff --git a/docs/dyn/integrations_v1alpha.projects.locations.authConfigs.html b/docs/dyn/integrations_v1alpha.projects.locations.authConfigs.html index 6eb36fa6124..09ef6de8b39 100644 --- a/docs/dyn/integrations_v1alpha.projects.locations.authConfigs.html +++ b/docs/dyn/integrations_v1alpha.projects.locations.authConfigs.html @@ -462,7 +462,7 @@

Method Details

}, }, "description": "A String", # A description of the auth config. - "displayName": "A String", # Required. The name of the auth config. + "displayName": "A String", # The name of the auth config. "encryptedCredential": "A String", # Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key. "expiryNotificationDuration": [ # User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours. "A String", @@ -840,7 +840,7 @@

Method Details

}, }, "description": "A String", # A description of the auth config. - "displayName": "A String", # Required. The name of the auth config. + "displayName": "A String", # The name of the auth config. "encryptedCredential": "A String", # Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key. "expiryNotificationDuration": [ # User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours. "A String", @@ -1240,7 +1240,7 @@

Method Details

}, }, "description": "A String", # A description of the auth config. - "displayName": "A String", # Required. The name of the auth config. + "displayName": "A String", # The name of the auth config. "encryptedCredential": "A String", # Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key. "expiryNotificationDuration": [ # User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours. "A String", @@ -1628,7 +1628,7 @@

Method Details

}, }, "description": "A String", # A description of the auth config. - "displayName": "A String", # Required. The name of the auth config. + "displayName": "A String", # The name of the auth config. "encryptedCredential": "A String", # Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key. "expiryNotificationDuration": [ # User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours. "A String", @@ -2022,7 +2022,7 @@

Method Details

}, }, "description": "A String", # A description of the auth config. - "displayName": "A String", # Required. The name of the auth config. + "displayName": "A String", # The name of the auth config. "encryptedCredential": "A String", # Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key. "expiryNotificationDuration": [ # User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours. "A String", @@ -2401,7 +2401,7 @@

Method Details

}, }, "description": "A String", # A description of the auth config. - "displayName": "A String", # Required. The name of the auth config. + "displayName": "A String", # The name of the auth config. "encryptedCredential": "A String", # Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key. "expiryNotificationDuration": [ # User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours. "A String", diff --git a/docs/dyn/integrations_v1alpha.projects.locations.products.authConfigs.html b/docs/dyn/integrations_v1alpha.projects.locations.products.authConfigs.html index 6e17dd56496..ee5f288114e 100644 --- a/docs/dyn/integrations_v1alpha.projects.locations.products.authConfigs.html +++ b/docs/dyn/integrations_v1alpha.projects.locations.products.authConfigs.html @@ -462,7 +462,7 @@

Method Details

}, }, "description": "A String", # A description of the auth config. - "displayName": "A String", # Required. The name of the auth config. + "displayName": "A String", # The name of the auth config. "encryptedCredential": "A String", # Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key. "expiryNotificationDuration": [ # User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours. "A String", @@ -840,7 +840,7 @@

Method Details

}, }, "description": "A String", # A description of the auth config. - "displayName": "A String", # Required. The name of the auth config. + "displayName": "A String", # The name of the auth config. "encryptedCredential": "A String", # Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key. "expiryNotificationDuration": [ # User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours. "A String", @@ -1240,7 +1240,7 @@

Method Details

}, }, "description": "A String", # A description of the auth config. - "displayName": "A String", # Required. The name of the auth config. + "displayName": "A String", # The name of the auth config. "encryptedCredential": "A String", # Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key. "expiryNotificationDuration": [ # User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours. "A String", @@ -1628,7 +1628,7 @@

Method Details

}, }, "description": "A String", # A description of the auth config. - "displayName": "A String", # Required. The name of the auth config. + "displayName": "A String", # The name of the auth config. "encryptedCredential": "A String", # Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key. "expiryNotificationDuration": [ # User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours. "A String", @@ -2022,7 +2022,7 @@

Method Details

}, }, "description": "A String", # A description of the auth config. - "displayName": "A String", # Required. The name of the auth config. + "displayName": "A String", # The name of the auth config. "encryptedCredential": "A String", # Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key. "expiryNotificationDuration": [ # User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours. "A String", @@ -2401,7 +2401,7 @@

Method Details

}, }, "description": "A String", # A description of the auth config. - "displayName": "A String", # Required. The name of the auth config. + "displayName": "A String", # The name of the auth config. "encryptedCredential": "A String", # Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key. "expiryNotificationDuration": [ # User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours. "A String", diff --git a/docs/dyn/kmsinventory_v1.organizations.protectedResources.html b/docs/dyn/kmsinventory_v1.organizations.protectedResources.html index 96e2ebc915a..c79c025553a 100644 --- a/docs/dyn/kmsinventory_v1.organizations.protectedResources.html +++ b/docs/dyn/kmsinventory_v1.organizations.protectedResources.html @@ -78,7 +78,7 @@

Instance Methods

close()

Close httplib2 connections.

- search(scope, cryptoKey=None, pageSize=None, pageToken=None, x__xgafv=None)

+ search(scope, cryptoKey=None, pageSize=None, pageToken=None, resourceTypes=None, x__xgafv=None)

Returns metadata about the resources protected by the given Cloud KMS CryptoKey in the given Cloud organization.

search_next()

@@ -90,7 +90,7 @@

Method Details

- search(scope, cryptoKey=None, pageSize=None, pageToken=None, x__xgafv=None) + search(scope, cryptoKey=None, pageSize=None, pageToken=None, resourceTypes=None, x__xgafv=None)
Returns metadata about the resources protected by the given Cloud KMS CryptoKey in the given Cloud organization.
 
 Args:
@@ -98,6 +98,7 @@ 

Method Details

cryptoKey: string, Required. The resource name of the CryptoKey. pageSize: integer, The maximum number of resources to return. The service may return fewer than this value. If unspecified, at most 500 resources will be returned. The maximum value is 500; values above 500 will be coerced to 500. pageToken: string, A page token, received from a previous KeyTrackingService.SearchProtectedResources call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to KeyTrackingService.SearchProtectedResources must match the call that provided the page token. + resourceTypes: string, Optional. A list of resource types that this request searches for. If empty, it will search all the [trackable resource types](https://cloud.google.com/kms/docs/view-key-usage#tracked-resource-types). Regular expressions are also supported. For example: * `compute.googleapis.com.*` snapshots resources whose type starts with `compute.googleapis.com`. * `.*Image` snapshots resources whose type ends with `Image`. * `.*Image.*` snapshots resources whose type contains `Image`. See [RE2](https://github.com/google/re2/wiki/Syntax) for all supported regular expression syntax. If the regular expression does not match any supported resource type, an INVALID_ARGUMENT error will be returned. (repeated) x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/managedidentities_v1.projects.locations.global_.domains.html b/docs/dyn/managedidentities_v1.projects.locations.global_.domains.html index 8784f36a1ec..4ee295de8db 100644 --- a/docs/dyn/managedidentities_v1.projects.locations.global_.domains.html +++ b/docs/dyn/managedidentities_v1.projects.locations.global_.domains.html @@ -87,6 +87,9 @@

Instance Methods

attachTrust(name, body=None, x__xgafv=None)

Adds an AD trust to a domain.

+

+ checkMigrationPermission(domain, body=None, x__xgafv=None)

+

CheckMigrationPermission API gets the current state of DomainMigration

close()

Close httplib2 connections.

@@ -207,6 +210,37 @@

Method Details

}
+
+ checkMigrationPermission(domain, body=None, x__xgafv=None) +
CheckMigrationPermission API gets the current state of DomainMigration
+
+Args:
+  domain: string, Required. The domain resource name using the form: `projects/{project_id}/locations/global/domains/{domain_name}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # CheckMigrationPermissionRequest is the request message for CheckMigrationPermission method.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # CheckMigrationPermissionResponse is the response message for CheckMigrationPermission method.
+  "onpremDomains": [ # The state of SID filtering of all the domains which has trust established.
+    { # OnPremDomainDetails is the message which contains details of on-prem domain which is trusted and needs to be migrated.
+      "name": "A String", # FQDN of the on-prem domain being migrated.
+      "sidFilteringState": "A String", # Current SID filtering state.
+    },
+  ],
+  "state": "A String", # The state of DomainMigration.
+}
+
+
close()
Close httplib2 connections.
diff --git a/docs/dyn/managedidentities_v1alpha1.projects.locations.global_.domains.html b/docs/dyn/managedidentities_v1alpha1.projects.locations.global_.domains.html index 1e16e83bd79..d6bece22bbc 100644 --- a/docs/dyn/managedidentities_v1alpha1.projects.locations.global_.domains.html +++ b/docs/dyn/managedidentities_v1alpha1.projects.locations.global_.domains.html @@ -493,6 +493,7 @@

Method Details

The object takes the form of: { # EnableMigrationRequest is the request message for EnableMigration method. + "enableDuration": "A String", # Optional. Period after which the migration would be auto disabled. If unspecified, a default timeout of 48h is used. "migratingDomains": [ # Required. List of the on-prem domains to be migrated. { # OnPremDomainDetails is the message which contains details of on-prem domain which is trusted and needs to be migrated. "disableSidFiltering": True or False, # Optional. Option to disable SID filtering. diff --git a/docs/dyn/managedidentities_v1beta1.projects.locations.global_.domains.html b/docs/dyn/managedidentities_v1beta1.projects.locations.global_.domains.html index 1eb4ac31627..cc719588930 100644 --- a/docs/dyn/managedidentities_v1beta1.projects.locations.global_.domains.html +++ b/docs/dyn/managedidentities_v1beta1.projects.locations.global_.domains.html @@ -493,6 +493,7 @@

Method Details

The object takes the form of: { # EnableMigrationRequest is the request message for EnableMigration method. + "enableDuration": "A String", # Optional. Period after which the migration would be auto disabled. If unspecified, a default timeout of 48h is used. "migratingDomains": [ # Required. List of the on-prem domains to be migrated. { # OnPremDomainDetails is the message which contains details of on-prem domain which is trusted and needs to be migrated. "disableSidFiltering": True or False, # Optional. Option to disable SID filtering. diff --git a/docs/dyn/monitoring_v3.projects.alertPolicies.html b/docs/dyn/monitoring_v3.projects.alertPolicies.html index 44d45ad40ac..58ed5895d57 100644 --- a/docs/dyn/monitoring_v3.projects.alertPolicies.html +++ b/docs/dyn/monitoring_v3.projects.alertPolicies.html @@ -161,6 +161,16 @@

Method Details

"percent": 3.14, # The percentage of time series that must fail the predicate for the condition to be triggered. }, }, + "conditionPrometheusQueryLanguage": { # A condition type that allows alert policies to be defined using Prometheus Query Language (PromQL) (https://prometheus.io/docs/prometheus/latest/querying/basics/).The PrometheusQueryLanguageCondition message contains information from a Prometheus alerting rule and its associated rule group.A Prometheus alerting rule is described here (https://prometheus.io/docs/prometheus/latest/configuration/alerting_rules/). The semantics of a Prometheus alerting rule is described here (https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/#rule).A Prometheus rule group is described here (https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/). The semantics of a Prometheus rule group is described here (https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/#rule_group).Because Cloud Alerting has no representation of a Prometheus rule group resource, we must embed the information of the parent rule group inside each of the conditions that refer to it. We must also update the contents of all Prometheus alerts in case the information of their rule group changes.The PrometheusQueryLanguageCondition protocol buffer combines the information of the corresponding rule group and alerting rule. The structure of the PrometheusQueryLanguageCondition protocol buffer does NOT mimic the structure of the Prometheus rule group and alerting rule YAML declarations. The PrometheusQueryLanguageCondition protocol buffer may change in the future to support future rule group and/or alerting rule features. There are no new such features at the present time (2023-06-26). # A condition that uses the Prometheus query language to define alerts. + "alertRule": "A String", # Optional. The alerting rule name of this alert in the corresponding Prometheus configuration file.Some external tools may require this field to be populated correctly in order to refer to the original Prometheus configuration file. The rule group name and the alert name are necessary to update the relevant AlertPolicies in case the definition of the rule group changes in the future.This field is optional. If this field is not empty, then it must be a valid Prometheus label name (https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels). + "duration": "A String", # Optional. Alerts are considered firing once their PromQL expression was evaluated to be "true" for this long. Alerts whose PromQL expression was not evaluated to be "true" for long enough are considered pending. The default value is zero. Must be zero or positive. + "evaluationInterval": "A String", # Required. How often this rule should be evaluated. Must be a positive multiple of 30 seconds or missing. The default value is 30 seconds. If this PrometheusQueryLanguageCondition was generated from a Prometheus alerting rule, then this value should be taken from the enclosing rule group. + "labels": { # Optional. Labels to add to or overwrite in the PromQL query result. Label names must be valid (https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels). Label values can be templatized by using variables (https://cloud.google.com/monitoring/alerts/doc-variables). The only available variable names are the names of the labels in the PromQL result, including "__name__" and "value". "labels" may be empty. + "a_key": "A String", + }, + "query": "A String", # Required. The PromQL expression to evaluate. Every evaluation cycle this expression is evaluated at the current time, and all resultant time series become pending/firing alerts. This field must not be empty. + "ruleGroup": "A String", # Optional. The rule group name of this alert in the corresponding Prometheus configuration file.Some external tools may require this field to be populated correctly in order to refer to the original Prometheus configuration file. The rule group name and the alert name are necessary to update the relevant AlertPolicies in case the definition of the rule group changes in the future.This field is optional. If this field is not empty, then it must be a valid Prometheus label name (https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels). + }, "conditionThreshold": { # A condition type that compares a collection of time series against a threshold. # A condition that compares a time series against a threshold. "aggregations": [ # Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resources). Multiple aggregations are applied in the order specified.This field is similar to the one in the ListTimeSeries request (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list). It is advisable to use the ListTimeSeries method when debugging this field. { # Describes how to combine multiple time series to provide a different view of the data. Aggregation of time series is done in two steps. First, each time series in the set is aligned to the same time interval boundaries, then the set of time series is optionally reduced in number.Alignment consists of applying the per_series_aligner operation to each time series after its data has been divided into regular alignment_period time intervals. This process takes all of the data points in an alignment period, applies a mathematical transformation such as averaging, minimum, maximum, delta, etc., and converts them into a single data point per period.Reduction is when the aligned and transformed time series can optionally be combined, reducing the number of time series through similar mathematical transformations. Reduction involves applying a cross_series_reducer to all the time series, optionally sorting the time series into subsets with group_by_fields, and applying the reducer to each subset.The raw time series data can contain a huge amount of information from multiple sources. Alignment and reduction transforms this mass of data into a more manageable and representative collection of data, for example "the 95% latency across the average of all tasks in a cluster". This representative data can be more easily graphed and comprehended, and the individual time series data is still available for later drilldown. For more details, see Filtering and aggregation (https://cloud.google.com/monitoring/api/v3/aggregation). @@ -208,6 +218,7 @@

Method Details

"documentation": { # A content string and a MIME type that describes the content string's format. # Documentation that is included with notifications and incidents related to this policy. Best practice is for the documentation to include information to help responders understand, mitigate, escalate, and correct the underlying problems detected by the alerting policy. Notification channels that have limited capacity might not show this documentation. "content": "A String", # The body of the documentation, interpreted according to mime_type. The content may not exceed 8,192 Unicode characters and may not exceed more than 10,240 bytes when encoded in UTF-8 format, whichever is smaller. This text can be templatized by using variables (https://cloud.google.com/monitoring/alerts/doc-variables). "mimeType": "A String", # The format of the content field. Presently, only the value "text/markdown" is supported. See Markdown (https://en.wikipedia.org/wiki/Markdown) for more information. + "subject": "A String", # Optional. The subject line of the notification. The subject line may not exceed 10,240 bytes. In notifications generated by this policy, the contents of the subject line after variable expansion will be truncated to 255 bytes or shorter at the latest UTF-8 character boundary. The 255-byte limit is recommended by this thread (https://stackoverflow.com/questions/1592291/what-is-the-email-subject-length-limit). It is both the limit imposed by some third-party ticketing products and it is common to define textual fields in databases as VARCHAR(255).The contents of the subject line can be templatized by using variables (https://cloud.google.com/monitoring/alerts/doc-variables). If this field is missing or empty, a default subject line will be generated. }, "enabled": True or False, # Whether or not the policy is enabled. On write, the default interpretation if unset is that the policy is enabled. On read, clients should not make any assumption about the state if it has not been populated. The field should always be populated on List and Get operations, unless a field projection has been specified that strips it out. "mutationRecord": { # Describes a change made to a configuration. # A read-only record of the most recent change to the alerting policy. If provided in a call to create or update, this field will be ignored. @@ -291,6 +302,16 @@

Method Details

"percent": 3.14, # The percentage of time series that must fail the predicate for the condition to be triggered. }, }, + "conditionPrometheusQueryLanguage": { # A condition type that allows alert policies to be defined using Prometheus Query Language (PromQL) (https://prometheus.io/docs/prometheus/latest/querying/basics/).The PrometheusQueryLanguageCondition message contains information from a Prometheus alerting rule and its associated rule group.A Prometheus alerting rule is described here (https://prometheus.io/docs/prometheus/latest/configuration/alerting_rules/). The semantics of a Prometheus alerting rule is described here (https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/#rule).A Prometheus rule group is described here (https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/). The semantics of a Prometheus rule group is described here (https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/#rule_group).Because Cloud Alerting has no representation of a Prometheus rule group resource, we must embed the information of the parent rule group inside each of the conditions that refer to it. We must also update the contents of all Prometheus alerts in case the information of their rule group changes.The PrometheusQueryLanguageCondition protocol buffer combines the information of the corresponding rule group and alerting rule. The structure of the PrometheusQueryLanguageCondition protocol buffer does NOT mimic the structure of the Prometheus rule group and alerting rule YAML declarations. The PrometheusQueryLanguageCondition protocol buffer may change in the future to support future rule group and/or alerting rule features. There are no new such features at the present time (2023-06-26). # A condition that uses the Prometheus query language to define alerts. + "alertRule": "A String", # Optional. The alerting rule name of this alert in the corresponding Prometheus configuration file.Some external tools may require this field to be populated correctly in order to refer to the original Prometheus configuration file. The rule group name and the alert name are necessary to update the relevant AlertPolicies in case the definition of the rule group changes in the future.This field is optional. If this field is not empty, then it must be a valid Prometheus label name (https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels). + "duration": "A String", # Optional. Alerts are considered firing once their PromQL expression was evaluated to be "true" for this long. Alerts whose PromQL expression was not evaluated to be "true" for long enough are considered pending. The default value is zero. Must be zero or positive. + "evaluationInterval": "A String", # Required. How often this rule should be evaluated. Must be a positive multiple of 30 seconds or missing. The default value is 30 seconds. If this PrometheusQueryLanguageCondition was generated from a Prometheus alerting rule, then this value should be taken from the enclosing rule group. + "labels": { # Optional. Labels to add to or overwrite in the PromQL query result. Label names must be valid (https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels). Label values can be templatized by using variables (https://cloud.google.com/monitoring/alerts/doc-variables). The only available variable names are the names of the labels in the PromQL result, including "__name__" and "value". "labels" may be empty. + "a_key": "A String", + }, + "query": "A String", # Required. The PromQL expression to evaluate. Every evaluation cycle this expression is evaluated at the current time, and all resultant time series become pending/firing alerts. This field must not be empty. + "ruleGroup": "A String", # Optional. The rule group name of this alert in the corresponding Prometheus configuration file.Some external tools may require this field to be populated correctly in order to refer to the original Prometheus configuration file. The rule group name and the alert name are necessary to update the relevant AlertPolicies in case the definition of the rule group changes in the future.This field is optional. If this field is not empty, then it must be a valid Prometheus label name (https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels). + }, "conditionThreshold": { # A condition type that compares a collection of time series against a threshold. # A condition that compares a time series against a threshold. "aggregations": [ # Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resources). Multiple aggregations are applied in the order specified.This field is similar to the one in the ListTimeSeries request (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list). It is advisable to use the ListTimeSeries method when debugging this field. { # Describes how to combine multiple time series to provide a different view of the data. Aggregation of time series is done in two steps. First, each time series in the set is aligned to the same time interval boundaries, then the set of time series is optionally reduced in number.Alignment consists of applying the per_series_aligner operation to each time series after its data has been divided into regular alignment_period time intervals. This process takes all of the data points in an alignment period, applies a mathematical transformation such as averaging, minimum, maximum, delta, etc., and converts them into a single data point per period.Reduction is when the aligned and transformed time series can optionally be combined, reducing the number of time series through similar mathematical transformations. Reduction involves applying a cross_series_reducer to all the time series, optionally sorting the time series into subsets with group_by_fields, and applying the reducer to each subset.The raw time series data can contain a huge amount of information from multiple sources. Alignment and reduction transforms this mass of data into a more manageable and representative collection of data, for example "the 95% latency across the average of all tasks in a cluster". This representative data can be more easily graphed and comprehended, and the individual time series data is still available for later drilldown. For more details, see Filtering and aggregation (https://cloud.google.com/monitoring/api/v3/aggregation). @@ -338,6 +359,7 @@

Method Details

"documentation": { # A content string and a MIME type that describes the content string's format. # Documentation that is included with notifications and incidents related to this policy. Best practice is for the documentation to include information to help responders understand, mitigate, escalate, and correct the underlying problems detected by the alerting policy. Notification channels that have limited capacity might not show this documentation. "content": "A String", # The body of the documentation, interpreted according to mime_type. The content may not exceed 8,192 Unicode characters and may not exceed more than 10,240 bytes when encoded in UTF-8 format, whichever is smaller. This text can be templatized by using variables (https://cloud.google.com/monitoring/alerts/doc-variables). "mimeType": "A String", # The format of the content field. Presently, only the value "text/markdown" is supported. See Markdown (https://en.wikipedia.org/wiki/Markdown) for more information. + "subject": "A String", # Optional. The subject line of the notification. The subject line may not exceed 10,240 bytes. In notifications generated by this policy, the contents of the subject line after variable expansion will be truncated to 255 bytes or shorter at the latest UTF-8 character boundary. The 255-byte limit is recommended by this thread (https://stackoverflow.com/questions/1592291/what-is-the-email-subject-length-limit). It is both the limit imposed by some third-party ticketing products and it is common to define textual fields in databases as VARCHAR(255).The contents of the subject line can be templatized by using variables (https://cloud.google.com/monitoring/alerts/doc-variables). If this field is missing or empty, a default subject line will be generated. }, "enabled": True or False, # Whether or not the policy is enabled. On write, the default interpretation if unset is that the policy is enabled. On read, clients should not make any assumption about the state if it has not been populated. The field should always be populated on List and Get operations, unless a field projection has been specified that strips it out. "mutationRecord": { # Describes a change made to a configuration. # A read-only record of the most recent change to the alerting policy. If provided in a call to create or update, this field will be ignored. @@ -446,6 +468,16 @@

Method Details

"percent": 3.14, # The percentage of time series that must fail the predicate for the condition to be triggered. }, }, + "conditionPrometheusQueryLanguage": { # A condition type that allows alert policies to be defined using Prometheus Query Language (PromQL) (https://prometheus.io/docs/prometheus/latest/querying/basics/).The PrometheusQueryLanguageCondition message contains information from a Prometheus alerting rule and its associated rule group.A Prometheus alerting rule is described here (https://prometheus.io/docs/prometheus/latest/configuration/alerting_rules/). The semantics of a Prometheus alerting rule is described here (https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/#rule).A Prometheus rule group is described here (https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/). The semantics of a Prometheus rule group is described here (https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/#rule_group).Because Cloud Alerting has no representation of a Prometheus rule group resource, we must embed the information of the parent rule group inside each of the conditions that refer to it. We must also update the contents of all Prometheus alerts in case the information of their rule group changes.The PrometheusQueryLanguageCondition protocol buffer combines the information of the corresponding rule group and alerting rule. The structure of the PrometheusQueryLanguageCondition protocol buffer does NOT mimic the structure of the Prometheus rule group and alerting rule YAML declarations. The PrometheusQueryLanguageCondition protocol buffer may change in the future to support future rule group and/or alerting rule features. There are no new such features at the present time (2023-06-26). # A condition that uses the Prometheus query language to define alerts. + "alertRule": "A String", # Optional. The alerting rule name of this alert in the corresponding Prometheus configuration file.Some external tools may require this field to be populated correctly in order to refer to the original Prometheus configuration file. The rule group name and the alert name are necessary to update the relevant AlertPolicies in case the definition of the rule group changes in the future.This field is optional. If this field is not empty, then it must be a valid Prometheus label name (https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels). + "duration": "A String", # Optional. Alerts are considered firing once their PromQL expression was evaluated to be "true" for this long. Alerts whose PromQL expression was not evaluated to be "true" for long enough are considered pending. The default value is zero. Must be zero or positive. + "evaluationInterval": "A String", # Required. How often this rule should be evaluated. Must be a positive multiple of 30 seconds or missing. The default value is 30 seconds. If this PrometheusQueryLanguageCondition was generated from a Prometheus alerting rule, then this value should be taken from the enclosing rule group. + "labels": { # Optional. Labels to add to or overwrite in the PromQL query result. Label names must be valid (https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels). Label values can be templatized by using variables (https://cloud.google.com/monitoring/alerts/doc-variables). The only available variable names are the names of the labels in the PromQL result, including "__name__" and "value". "labels" may be empty. + "a_key": "A String", + }, + "query": "A String", # Required. The PromQL expression to evaluate. Every evaluation cycle this expression is evaluated at the current time, and all resultant time series become pending/firing alerts. This field must not be empty. + "ruleGroup": "A String", # Optional. The rule group name of this alert in the corresponding Prometheus configuration file.Some external tools may require this field to be populated correctly in order to refer to the original Prometheus configuration file. The rule group name and the alert name are necessary to update the relevant AlertPolicies in case the definition of the rule group changes in the future.This field is optional. If this field is not empty, then it must be a valid Prometheus label name (https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels). + }, "conditionThreshold": { # A condition type that compares a collection of time series against a threshold. # A condition that compares a time series against a threshold. "aggregations": [ # Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resources). Multiple aggregations are applied in the order specified.This field is similar to the one in the ListTimeSeries request (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list). It is advisable to use the ListTimeSeries method when debugging this field. { # Describes how to combine multiple time series to provide a different view of the data. Aggregation of time series is done in two steps. First, each time series in the set is aligned to the same time interval boundaries, then the set of time series is optionally reduced in number.Alignment consists of applying the per_series_aligner operation to each time series after its data has been divided into regular alignment_period time intervals. This process takes all of the data points in an alignment period, applies a mathematical transformation such as averaging, minimum, maximum, delta, etc., and converts them into a single data point per period.Reduction is when the aligned and transformed time series can optionally be combined, reducing the number of time series through similar mathematical transformations. Reduction involves applying a cross_series_reducer to all the time series, optionally sorting the time series into subsets with group_by_fields, and applying the reducer to each subset.The raw time series data can contain a huge amount of information from multiple sources. Alignment and reduction transforms this mass of data into a more manageable and representative collection of data, for example "the 95% latency across the average of all tasks in a cluster". This representative data can be more easily graphed and comprehended, and the individual time series data is still available for later drilldown. For more details, see Filtering and aggregation (https://cloud.google.com/monitoring/api/v3/aggregation). @@ -493,6 +525,7 @@

Method Details

"documentation": { # A content string and a MIME type that describes the content string's format. # Documentation that is included with notifications and incidents related to this policy. Best practice is for the documentation to include information to help responders understand, mitigate, escalate, and correct the underlying problems detected by the alerting policy. Notification channels that have limited capacity might not show this documentation. "content": "A String", # The body of the documentation, interpreted according to mime_type. The content may not exceed 8,192 Unicode characters and may not exceed more than 10,240 bytes when encoded in UTF-8 format, whichever is smaller. This text can be templatized by using variables (https://cloud.google.com/monitoring/alerts/doc-variables). "mimeType": "A String", # The format of the content field. Presently, only the value "text/markdown" is supported. See Markdown (https://en.wikipedia.org/wiki/Markdown) for more information. + "subject": "A String", # Optional. The subject line of the notification. The subject line may not exceed 10,240 bytes. In notifications generated by this policy, the contents of the subject line after variable expansion will be truncated to 255 bytes or shorter at the latest UTF-8 character boundary. The 255-byte limit is recommended by this thread (https://stackoverflow.com/questions/1592291/what-is-the-email-subject-length-limit). It is both the limit imposed by some third-party ticketing products and it is common to define textual fields in databases as VARCHAR(255).The contents of the subject line can be templatized by using variables (https://cloud.google.com/monitoring/alerts/doc-variables). If this field is missing or empty, a default subject line will be generated. }, "enabled": True or False, # Whether or not the policy is enabled. On write, the default interpretation if unset is that the policy is enabled. On read, clients should not make any assumption about the state if it has not been populated. The field should always be populated on List and Get operations, unless a field projection has been specified that strips it out. "mutationRecord": { # Describes a change made to a configuration. # A read-only record of the most recent change to the alerting policy. If provided in a call to create or update, this field will be ignored. @@ -589,6 +622,16 @@

Method Details

"percent": 3.14, # The percentage of time series that must fail the predicate for the condition to be triggered. }, }, + "conditionPrometheusQueryLanguage": { # A condition type that allows alert policies to be defined using Prometheus Query Language (PromQL) (https://prometheus.io/docs/prometheus/latest/querying/basics/).The PrometheusQueryLanguageCondition message contains information from a Prometheus alerting rule and its associated rule group.A Prometheus alerting rule is described here (https://prometheus.io/docs/prometheus/latest/configuration/alerting_rules/). The semantics of a Prometheus alerting rule is described here (https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/#rule).A Prometheus rule group is described here (https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/). The semantics of a Prometheus rule group is described here (https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/#rule_group).Because Cloud Alerting has no representation of a Prometheus rule group resource, we must embed the information of the parent rule group inside each of the conditions that refer to it. We must also update the contents of all Prometheus alerts in case the information of their rule group changes.The PrometheusQueryLanguageCondition protocol buffer combines the information of the corresponding rule group and alerting rule. The structure of the PrometheusQueryLanguageCondition protocol buffer does NOT mimic the structure of the Prometheus rule group and alerting rule YAML declarations. The PrometheusQueryLanguageCondition protocol buffer may change in the future to support future rule group and/or alerting rule features. There are no new such features at the present time (2023-06-26). # A condition that uses the Prometheus query language to define alerts. + "alertRule": "A String", # Optional. The alerting rule name of this alert in the corresponding Prometheus configuration file.Some external tools may require this field to be populated correctly in order to refer to the original Prometheus configuration file. The rule group name and the alert name are necessary to update the relevant AlertPolicies in case the definition of the rule group changes in the future.This field is optional. If this field is not empty, then it must be a valid Prometheus label name (https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels). + "duration": "A String", # Optional. Alerts are considered firing once their PromQL expression was evaluated to be "true" for this long. Alerts whose PromQL expression was not evaluated to be "true" for long enough are considered pending. The default value is zero. Must be zero or positive. + "evaluationInterval": "A String", # Required. How often this rule should be evaluated. Must be a positive multiple of 30 seconds or missing. The default value is 30 seconds. If this PrometheusQueryLanguageCondition was generated from a Prometheus alerting rule, then this value should be taken from the enclosing rule group. + "labels": { # Optional. Labels to add to or overwrite in the PromQL query result. Label names must be valid (https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels). Label values can be templatized by using variables (https://cloud.google.com/monitoring/alerts/doc-variables). The only available variable names are the names of the labels in the PromQL result, including "__name__" and "value". "labels" may be empty. + "a_key": "A String", + }, + "query": "A String", # Required. The PromQL expression to evaluate. Every evaluation cycle this expression is evaluated at the current time, and all resultant time series become pending/firing alerts. This field must not be empty. + "ruleGroup": "A String", # Optional. The rule group name of this alert in the corresponding Prometheus configuration file.Some external tools may require this field to be populated correctly in order to refer to the original Prometheus configuration file. The rule group name and the alert name are necessary to update the relevant AlertPolicies in case the definition of the rule group changes in the future.This field is optional. If this field is not empty, then it must be a valid Prometheus label name (https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels). + }, "conditionThreshold": { # A condition type that compares a collection of time series against a threshold. # A condition that compares a time series against a threshold. "aggregations": [ # Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resources). Multiple aggregations are applied in the order specified.This field is similar to the one in the ListTimeSeries request (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list). It is advisable to use the ListTimeSeries method when debugging this field. { # Describes how to combine multiple time series to provide a different view of the data. Aggregation of time series is done in two steps. First, each time series in the set is aligned to the same time interval boundaries, then the set of time series is optionally reduced in number.Alignment consists of applying the per_series_aligner operation to each time series after its data has been divided into regular alignment_period time intervals. This process takes all of the data points in an alignment period, applies a mathematical transformation such as averaging, minimum, maximum, delta, etc., and converts them into a single data point per period.Reduction is when the aligned and transformed time series can optionally be combined, reducing the number of time series through similar mathematical transformations. Reduction involves applying a cross_series_reducer to all the time series, optionally sorting the time series into subsets with group_by_fields, and applying the reducer to each subset.The raw time series data can contain a huge amount of information from multiple sources. Alignment and reduction transforms this mass of data into a more manageable and representative collection of data, for example "the 95% latency across the average of all tasks in a cluster". This representative data can be more easily graphed and comprehended, and the individual time series data is still available for later drilldown. For more details, see Filtering and aggregation (https://cloud.google.com/monitoring/api/v3/aggregation). @@ -636,6 +679,7 @@

Method Details

"documentation": { # A content string and a MIME type that describes the content string's format. # Documentation that is included with notifications and incidents related to this policy. Best practice is for the documentation to include information to help responders understand, mitigate, escalate, and correct the underlying problems detected by the alerting policy. Notification channels that have limited capacity might not show this documentation. "content": "A String", # The body of the documentation, interpreted according to mime_type. The content may not exceed 8,192 Unicode characters and may not exceed more than 10,240 bytes when encoded in UTF-8 format, whichever is smaller. This text can be templatized by using variables (https://cloud.google.com/monitoring/alerts/doc-variables). "mimeType": "A String", # The format of the content field. Presently, only the value "text/markdown" is supported. See Markdown (https://en.wikipedia.org/wiki/Markdown) for more information. + "subject": "A String", # Optional. The subject line of the notification. The subject line may not exceed 10,240 bytes. In notifications generated by this policy, the contents of the subject line after variable expansion will be truncated to 255 bytes or shorter at the latest UTF-8 character boundary. The 255-byte limit is recommended by this thread (https://stackoverflow.com/questions/1592291/what-is-the-email-subject-length-limit). It is both the limit imposed by some third-party ticketing products and it is common to define textual fields in databases as VARCHAR(255).The contents of the subject line can be templatized by using variables (https://cloud.google.com/monitoring/alerts/doc-variables). If this field is missing or empty, a default subject line will be generated. }, "enabled": True or False, # Whether or not the policy is enabled. On write, the default interpretation if unset is that the policy is enabled. On read, clients should not make any assumption about the state if it has not been populated. The field should always be populated on List and Get operations, unless a field projection has been specified that strips it out. "mutationRecord": { # Describes a change made to a configuration. # A read-only record of the most recent change to the alerting policy. If provided in a call to create or update, this field will be ignored. @@ -739,6 +783,16 @@

Method Details

"percent": 3.14, # The percentage of time series that must fail the predicate for the condition to be triggered. }, }, + "conditionPrometheusQueryLanguage": { # A condition type that allows alert policies to be defined using Prometheus Query Language (PromQL) (https://prometheus.io/docs/prometheus/latest/querying/basics/).The PrometheusQueryLanguageCondition message contains information from a Prometheus alerting rule and its associated rule group.A Prometheus alerting rule is described here (https://prometheus.io/docs/prometheus/latest/configuration/alerting_rules/). The semantics of a Prometheus alerting rule is described here (https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/#rule).A Prometheus rule group is described here (https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/). The semantics of a Prometheus rule group is described here (https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/#rule_group).Because Cloud Alerting has no representation of a Prometheus rule group resource, we must embed the information of the parent rule group inside each of the conditions that refer to it. We must also update the contents of all Prometheus alerts in case the information of their rule group changes.The PrometheusQueryLanguageCondition protocol buffer combines the information of the corresponding rule group and alerting rule. The structure of the PrometheusQueryLanguageCondition protocol buffer does NOT mimic the structure of the Prometheus rule group and alerting rule YAML declarations. The PrometheusQueryLanguageCondition protocol buffer may change in the future to support future rule group and/or alerting rule features. There are no new such features at the present time (2023-06-26). # A condition that uses the Prometheus query language to define alerts. + "alertRule": "A String", # Optional. The alerting rule name of this alert in the corresponding Prometheus configuration file.Some external tools may require this field to be populated correctly in order to refer to the original Prometheus configuration file. The rule group name and the alert name are necessary to update the relevant AlertPolicies in case the definition of the rule group changes in the future.This field is optional. If this field is not empty, then it must be a valid Prometheus label name (https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels). + "duration": "A String", # Optional. Alerts are considered firing once their PromQL expression was evaluated to be "true" for this long. Alerts whose PromQL expression was not evaluated to be "true" for long enough are considered pending. The default value is zero. Must be zero or positive. + "evaluationInterval": "A String", # Required. How often this rule should be evaluated. Must be a positive multiple of 30 seconds or missing. The default value is 30 seconds. If this PrometheusQueryLanguageCondition was generated from a Prometheus alerting rule, then this value should be taken from the enclosing rule group. + "labels": { # Optional. Labels to add to or overwrite in the PromQL query result. Label names must be valid (https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels). Label values can be templatized by using variables (https://cloud.google.com/monitoring/alerts/doc-variables). The only available variable names are the names of the labels in the PromQL result, including "__name__" and "value". "labels" may be empty. + "a_key": "A String", + }, + "query": "A String", # Required. The PromQL expression to evaluate. Every evaluation cycle this expression is evaluated at the current time, and all resultant time series become pending/firing alerts. This field must not be empty. + "ruleGroup": "A String", # Optional. The rule group name of this alert in the corresponding Prometheus configuration file.Some external tools may require this field to be populated correctly in order to refer to the original Prometheus configuration file. The rule group name and the alert name are necessary to update the relevant AlertPolicies in case the definition of the rule group changes in the future.This field is optional. If this field is not empty, then it must be a valid Prometheus label name (https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels). + }, "conditionThreshold": { # A condition type that compares a collection of time series against a threshold. # A condition that compares a time series against a threshold. "aggregations": [ # Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resources). Multiple aggregations are applied in the order specified.This field is similar to the one in the ListTimeSeries request (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list). It is advisable to use the ListTimeSeries method when debugging this field. { # Describes how to combine multiple time series to provide a different view of the data. Aggregation of time series is done in two steps. First, each time series in the set is aligned to the same time interval boundaries, then the set of time series is optionally reduced in number.Alignment consists of applying the per_series_aligner operation to each time series after its data has been divided into regular alignment_period time intervals. This process takes all of the data points in an alignment period, applies a mathematical transformation such as averaging, minimum, maximum, delta, etc., and converts them into a single data point per period.Reduction is when the aligned and transformed time series can optionally be combined, reducing the number of time series through similar mathematical transformations. Reduction involves applying a cross_series_reducer to all the time series, optionally sorting the time series into subsets with group_by_fields, and applying the reducer to each subset.The raw time series data can contain a huge amount of information from multiple sources. Alignment and reduction transforms this mass of data into a more manageable and representative collection of data, for example "the 95% latency across the average of all tasks in a cluster". This representative data can be more easily graphed and comprehended, and the individual time series data is still available for later drilldown. For more details, see Filtering and aggregation (https://cloud.google.com/monitoring/api/v3/aggregation). @@ -786,6 +840,7 @@

Method Details

"documentation": { # A content string and a MIME type that describes the content string's format. # Documentation that is included with notifications and incidents related to this policy. Best practice is for the documentation to include information to help responders understand, mitigate, escalate, and correct the underlying problems detected by the alerting policy. Notification channels that have limited capacity might not show this documentation. "content": "A String", # The body of the documentation, interpreted according to mime_type. The content may not exceed 8,192 Unicode characters and may not exceed more than 10,240 bytes when encoded in UTF-8 format, whichever is smaller. This text can be templatized by using variables (https://cloud.google.com/monitoring/alerts/doc-variables). "mimeType": "A String", # The format of the content field. Presently, only the value "text/markdown" is supported. See Markdown (https://en.wikipedia.org/wiki/Markdown) for more information. + "subject": "A String", # Optional. The subject line of the notification. The subject line may not exceed 10,240 bytes. In notifications generated by this policy, the contents of the subject line after variable expansion will be truncated to 255 bytes or shorter at the latest UTF-8 character boundary. The 255-byte limit is recommended by this thread (https://stackoverflow.com/questions/1592291/what-is-the-email-subject-length-limit). It is both the limit imposed by some third-party ticketing products and it is common to define textual fields in databases as VARCHAR(255).The contents of the subject line can be templatized by using variables (https://cloud.google.com/monitoring/alerts/doc-variables). If this field is missing or empty, a default subject line will be generated. }, "enabled": True or False, # Whether or not the policy is enabled. On write, the default interpretation if unset is that the policy is enabled. On read, clients should not make any assumption about the state if it has not been populated. The field should always be populated on List and Get operations, unless a field projection has been specified that strips it out. "mutationRecord": { # Describes a change made to a configuration. # A read-only record of the most recent change to the alerting policy. If provided in a call to create or update, this field will be ignored. @@ -870,6 +925,16 @@

Method Details

"percent": 3.14, # The percentage of time series that must fail the predicate for the condition to be triggered. }, }, + "conditionPrometheusQueryLanguage": { # A condition type that allows alert policies to be defined using Prometheus Query Language (PromQL) (https://prometheus.io/docs/prometheus/latest/querying/basics/).The PrometheusQueryLanguageCondition message contains information from a Prometheus alerting rule and its associated rule group.A Prometheus alerting rule is described here (https://prometheus.io/docs/prometheus/latest/configuration/alerting_rules/). The semantics of a Prometheus alerting rule is described here (https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/#rule).A Prometheus rule group is described here (https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/). The semantics of a Prometheus rule group is described here (https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/#rule_group).Because Cloud Alerting has no representation of a Prometheus rule group resource, we must embed the information of the parent rule group inside each of the conditions that refer to it. We must also update the contents of all Prometheus alerts in case the information of their rule group changes.The PrometheusQueryLanguageCondition protocol buffer combines the information of the corresponding rule group and alerting rule. The structure of the PrometheusQueryLanguageCondition protocol buffer does NOT mimic the structure of the Prometheus rule group and alerting rule YAML declarations. The PrometheusQueryLanguageCondition protocol buffer may change in the future to support future rule group and/or alerting rule features. There are no new such features at the present time (2023-06-26). # A condition that uses the Prometheus query language to define alerts. + "alertRule": "A String", # Optional. The alerting rule name of this alert in the corresponding Prometheus configuration file.Some external tools may require this field to be populated correctly in order to refer to the original Prometheus configuration file. The rule group name and the alert name are necessary to update the relevant AlertPolicies in case the definition of the rule group changes in the future.This field is optional. If this field is not empty, then it must be a valid Prometheus label name (https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels). + "duration": "A String", # Optional. Alerts are considered firing once their PromQL expression was evaluated to be "true" for this long. Alerts whose PromQL expression was not evaluated to be "true" for long enough are considered pending. The default value is zero. Must be zero or positive. + "evaluationInterval": "A String", # Required. How often this rule should be evaluated. Must be a positive multiple of 30 seconds or missing. The default value is 30 seconds. If this PrometheusQueryLanguageCondition was generated from a Prometheus alerting rule, then this value should be taken from the enclosing rule group. + "labels": { # Optional. Labels to add to or overwrite in the PromQL query result. Label names must be valid (https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels). Label values can be templatized by using variables (https://cloud.google.com/monitoring/alerts/doc-variables). The only available variable names are the names of the labels in the PromQL result, including "__name__" and "value". "labels" may be empty. + "a_key": "A String", + }, + "query": "A String", # Required. The PromQL expression to evaluate. Every evaluation cycle this expression is evaluated at the current time, and all resultant time series become pending/firing alerts. This field must not be empty. + "ruleGroup": "A String", # Optional. The rule group name of this alert in the corresponding Prometheus configuration file.Some external tools may require this field to be populated correctly in order to refer to the original Prometheus configuration file. The rule group name and the alert name are necessary to update the relevant AlertPolicies in case the definition of the rule group changes in the future.This field is optional. If this field is not empty, then it must be a valid Prometheus label name (https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels). + }, "conditionThreshold": { # A condition type that compares a collection of time series against a threshold. # A condition that compares a time series against a threshold. "aggregations": [ # Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resources). Multiple aggregations are applied in the order specified.This field is similar to the one in the ListTimeSeries request (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list). It is advisable to use the ListTimeSeries method when debugging this field. { # Describes how to combine multiple time series to provide a different view of the data. Aggregation of time series is done in two steps. First, each time series in the set is aligned to the same time interval boundaries, then the set of time series is optionally reduced in number.Alignment consists of applying the per_series_aligner operation to each time series after its data has been divided into regular alignment_period time intervals. This process takes all of the data points in an alignment period, applies a mathematical transformation such as averaging, minimum, maximum, delta, etc., and converts them into a single data point per period.Reduction is when the aligned and transformed time series can optionally be combined, reducing the number of time series through similar mathematical transformations. Reduction involves applying a cross_series_reducer to all the time series, optionally sorting the time series into subsets with group_by_fields, and applying the reducer to each subset.The raw time series data can contain a huge amount of information from multiple sources. Alignment and reduction transforms this mass of data into a more manageable and representative collection of data, for example "the 95% latency across the average of all tasks in a cluster". This representative data can be more easily graphed and comprehended, and the individual time series data is still available for later drilldown. For more details, see Filtering and aggregation (https://cloud.google.com/monitoring/api/v3/aggregation). @@ -917,6 +982,7 @@

Method Details

"documentation": { # A content string and a MIME type that describes the content string's format. # Documentation that is included with notifications and incidents related to this policy. Best practice is for the documentation to include information to help responders understand, mitigate, escalate, and correct the underlying problems detected by the alerting policy. Notification channels that have limited capacity might not show this documentation. "content": "A String", # The body of the documentation, interpreted according to mime_type. The content may not exceed 8,192 Unicode characters and may not exceed more than 10,240 bytes when encoded in UTF-8 format, whichever is smaller. This text can be templatized by using variables (https://cloud.google.com/monitoring/alerts/doc-variables). "mimeType": "A String", # The format of the content field. Presently, only the value "text/markdown" is supported. See Markdown (https://en.wikipedia.org/wiki/Markdown) for more information. + "subject": "A String", # Optional. The subject line of the notification. The subject line may not exceed 10,240 bytes. In notifications generated by this policy, the contents of the subject line after variable expansion will be truncated to 255 bytes or shorter at the latest UTF-8 character boundary. The 255-byte limit is recommended by this thread (https://stackoverflow.com/questions/1592291/what-is-the-email-subject-length-limit). It is both the limit imposed by some third-party ticketing products and it is common to define textual fields in databases as VARCHAR(255).The contents of the subject line can be templatized by using variables (https://cloud.google.com/monitoring/alerts/doc-variables). If this field is missing or empty, a default subject line will be generated. }, "enabled": True or False, # Whether or not the policy is enabled. On write, the default interpretation if unset is that the policy is enabled. On read, clients should not make any assumption about the state if it has not been populated. The field should always be populated on List and Get operations, unless a field projection has been specified that strips it out. "mutationRecord": { # Describes a change made to a configuration. # A read-only record of the most recent change to the alerting policy. If provided in a call to create or update, this field will be ignored. diff --git a/docs/dyn/notebooks_v1.projects.locations.runtimes.html b/docs/dyn/notebooks_v1.projects.locations.runtimes.html index dfa8111e3f6..a73f6bd273a 100644 --- a/docs/dyn/notebooks_v1.projects.locations.runtimes.html +++ b/docs/dyn/notebooks_v1.projects.locations.runtimes.html @@ -186,7 +186,7 @@

Method Details

"instanceId": "A String", # Output only. The unique identifier of the Managed Compute Engine instance. "instanceName": "A String", # Output only. The user-friendly name of the Managed Compute Engine instance. "virtualMachineConfig": { # The config settings for virtual machine. # Virtual Machine configuration settings. - "acceleratorConfig": { # Definition of the types of hardware accelerators that can be used. Definition of the types of hardware accelerators that can be used. See [Compute Engine AcceleratorTypes](https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes). Examples: * `nvidia-tesla-k80` * `nvidia-tesla-p100` * `nvidia-tesla-v100` * `nvidia-tesla-p4` * `nvidia-tesla-t4` * `nvidia-tesla-a100` # Optional. The Compute Engine accelerator configuration for this runtime. + "acceleratorConfig": { # Definition of the types of hardware accelerators that can be used. See [Compute Engine AcceleratorTypes](https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes). Examples: * `nvidia-tesla-k80` * `nvidia-tesla-p100` * `nvidia-tesla-v100` * `nvidia-tesla-p4` * `nvidia-tesla-t4` * `nvidia-tesla-a100` # Optional. The Compute Engine accelerator configuration for this runtime. "coreCount": "A String", # Count of cores of this accelerator. "type": "A String", # Accelerator model. }, @@ -429,7 +429,7 @@

Method Details

"instanceId": "A String", # Output only. The unique identifier of the Managed Compute Engine instance. "instanceName": "A String", # Output only. The user-friendly name of the Managed Compute Engine instance. "virtualMachineConfig": { # The config settings for virtual machine. # Virtual Machine configuration settings. - "acceleratorConfig": { # Definition of the types of hardware accelerators that can be used. Definition of the types of hardware accelerators that can be used. See [Compute Engine AcceleratorTypes](https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes). Examples: * `nvidia-tesla-k80` * `nvidia-tesla-p100` * `nvidia-tesla-v100` * `nvidia-tesla-p4` * `nvidia-tesla-t4` * `nvidia-tesla-a100` # Optional. The Compute Engine accelerator configuration for this runtime. + "acceleratorConfig": { # Definition of the types of hardware accelerators that can be used. See [Compute Engine AcceleratorTypes](https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes). Examples: * `nvidia-tesla-k80` * `nvidia-tesla-p100` * `nvidia-tesla-v100` * `nvidia-tesla-p4` * `nvidia-tesla-t4` * `nvidia-tesla-a100` # Optional. The Compute Engine accelerator configuration for this runtime. "coreCount": "A String", # Count of cores of this accelerator. "type": "A String", # Accelerator model. }, @@ -598,7 +598,7 @@

Method Details

"instanceId": "A String", # Output only. The unique identifier of the Managed Compute Engine instance. "instanceName": "A String", # Output only. The user-friendly name of the Managed Compute Engine instance. "virtualMachineConfig": { # The config settings for virtual machine. # Virtual Machine configuration settings. - "acceleratorConfig": { # Definition of the types of hardware accelerators that can be used. Definition of the types of hardware accelerators that can be used. See [Compute Engine AcceleratorTypes](https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes). Examples: * `nvidia-tesla-k80` * `nvidia-tesla-p100` * `nvidia-tesla-v100` * `nvidia-tesla-p4` * `nvidia-tesla-t4` * `nvidia-tesla-a100` # Optional. The Compute Engine accelerator configuration for this runtime. + "acceleratorConfig": { # Definition of the types of hardware accelerators that can be used. See [Compute Engine AcceleratorTypes](https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes). Examples: * `nvidia-tesla-k80` * `nvidia-tesla-p100` * `nvidia-tesla-v100` * `nvidia-tesla-p4` * `nvidia-tesla-t4` * `nvidia-tesla-a100` # Optional. The Compute Engine accelerator configuration for this runtime. "coreCount": "A String", # Count of cores of this accelerator. "type": "A String", # Accelerator model. }, @@ -741,7 +741,7 @@

Method Details

"instanceId": "A String", # Output only. The unique identifier of the Managed Compute Engine instance. "instanceName": "A String", # Output only. The user-friendly name of the Managed Compute Engine instance. "virtualMachineConfig": { # The config settings for virtual machine. # Virtual Machine configuration settings. - "acceleratorConfig": { # Definition of the types of hardware accelerators that can be used. Definition of the types of hardware accelerators that can be used. See [Compute Engine AcceleratorTypes](https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes). Examples: * `nvidia-tesla-k80` * `nvidia-tesla-p100` * `nvidia-tesla-v100` * `nvidia-tesla-p4` * `nvidia-tesla-t4` * `nvidia-tesla-a100` # Optional. The Compute Engine accelerator configuration for this runtime. + "acceleratorConfig": { # Definition of the types of hardware accelerators that can be used. See [Compute Engine AcceleratorTypes](https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes). Examples: * `nvidia-tesla-k80` * `nvidia-tesla-p100` * `nvidia-tesla-v100` * `nvidia-tesla-p4` * `nvidia-tesla-t4` * `nvidia-tesla-a100` # Optional. The Compute Engine accelerator configuration for this runtime. "coreCount": "A String", # Count of cores of this accelerator. "type": "A String", # Accelerator model. }, @@ -1113,7 +1113,7 @@

Method Details

The object takes the form of: { # Request for switching a Managed Notebook Runtime. - "acceleratorConfig": { # Definition of the types of hardware accelerators that can be used. Definition of the types of hardware accelerators that can be used. See [Compute Engine AcceleratorTypes](https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes). Examples: * `nvidia-tesla-k80` * `nvidia-tesla-p100` * `nvidia-tesla-v100` * `nvidia-tesla-p4` * `nvidia-tesla-t4` * `nvidia-tesla-a100` # accelerator config. + "acceleratorConfig": { # Definition of the types of hardware accelerators that can be used. See [Compute Engine AcceleratorTypes](https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes). Examples: * `nvidia-tesla-k80` * `nvidia-tesla-p100` * `nvidia-tesla-v100` * `nvidia-tesla-p4` * `nvidia-tesla-t4` * `nvidia-tesla-a100` # accelerator config. "coreCount": "A String", # Count of cores of this accelerator. "type": "A String", # Accelerator model. }, diff --git a/docs/dyn/pubsub_v1.projects.subscriptions.html b/docs/dyn/pubsub_v1.projects.subscriptions.html index ea65c15e149..ab953c419aa 100644 --- a/docs/dyn/pubsub_v1.projects.subscriptions.html +++ b/docs/dyn/pubsub_v1.projects.subscriptions.html @@ -179,7 +179,7 @@

Method Details

}, "bucket": "A String", # Required. User-provided name for the Cloud Storage bucket. The bucket must be created by the user. The bucket name must be without any prefix like "gs://". See the [bucket naming requirements] (https://cloud.google.com/storage/docs/buckets#naming). "filenamePrefix": "A String", # Optional. User-provided prefix for Cloud Storage filename. See the [object naming requirements](https://cloud.google.com/storage/docs/objects#naming). - "filenameSuffix": "A String", # Optional. User-provided suffix for Cloud Storage filename. See the [object naming requirements](https://cloud.google.com/storage/docs/objects#naming). + "filenameSuffix": "A String", # Optional. User-provided suffix for Cloud Storage filename. See the [object naming requirements](https://cloud.google.com/storage/docs/objects#naming). Must not end in "/". "maxBytes": "A String", # Optional. The maximum bytes that can be written to a Cloud Storage file before a new file is created. Min 1 KB, max 10 GiB. The max_bytes limit may be exceeded in cases where messages are larger than the limit. "maxDuration": "A String", # Optional. The maximum duration that can elapse before a new Cloud Storage file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not exceed the subscription's acknowledgement deadline. "state": "A String", # Output only. An output-only field that indicates whether or not the subscription can receive messages. @@ -250,7 +250,7 @@

Method Details

}, "bucket": "A String", # Required. User-provided name for the Cloud Storage bucket. The bucket must be created by the user. The bucket name must be without any prefix like "gs://". See the [bucket naming requirements] (https://cloud.google.com/storage/docs/buckets#naming). "filenamePrefix": "A String", # Optional. User-provided prefix for Cloud Storage filename. See the [object naming requirements](https://cloud.google.com/storage/docs/objects#naming). - "filenameSuffix": "A String", # Optional. User-provided suffix for Cloud Storage filename. See the [object naming requirements](https://cloud.google.com/storage/docs/objects#naming). + "filenameSuffix": "A String", # Optional. User-provided suffix for Cloud Storage filename. See the [object naming requirements](https://cloud.google.com/storage/docs/objects#naming). Must not end in "/". "maxBytes": "A String", # Optional. The maximum bytes that can be written to a Cloud Storage file before a new file is created. Min 1 KB, max 10 GiB. The max_bytes limit may be exceeded in cases where messages are larger than the limit. "maxDuration": "A String", # Optional. The maximum duration that can elapse before a new Cloud Storage file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not exceed the subscription's acknowledgement deadline. "state": "A String", # Output only. An output-only field that indicates whether or not the subscription can receive messages. @@ -364,7 +364,7 @@

Method Details

}, "bucket": "A String", # Required. User-provided name for the Cloud Storage bucket. The bucket must be created by the user. The bucket name must be without any prefix like "gs://". See the [bucket naming requirements] (https://cloud.google.com/storage/docs/buckets#naming). "filenamePrefix": "A String", # Optional. User-provided prefix for Cloud Storage filename. See the [object naming requirements](https://cloud.google.com/storage/docs/objects#naming). - "filenameSuffix": "A String", # Optional. User-provided suffix for Cloud Storage filename. See the [object naming requirements](https://cloud.google.com/storage/docs/objects#naming). + "filenameSuffix": "A String", # Optional. User-provided suffix for Cloud Storage filename. See the [object naming requirements](https://cloud.google.com/storage/docs/objects#naming). Must not end in "/". "maxBytes": "A String", # Optional. The maximum bytes that can be written to a Cloud Storage file before a new file is created. Min 1 KB, max 10 GiB. The max_bytes limit may be exceeded in cases where messages are larger than the limit. "maxDuration": "A String", # Optional. The maximum duration that can elapse before a new Cloud Storage file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not exceed the subscription's acknowledgement deadline. "state": "A String", # Output only. An output-only field that indicates whether or not the subscription can receive messages. @@ -482,7 +482,7 @@

Method Details

}, "bucket": "A String", # Required. User-provided name for the Cloud Storage bucket. The bucket must be created by the user. The bucket name must be without any prefix like "gs://". See the [bucket naming requirements] (https://cloud.google.com/storage/docs/buckets#naming). "filenamePrefix": "A String", # Optional. User-provided prefix for Cloud Storage filename. See the [object naming requirements](https://cloud.google.com/storage/docs/objects#naming). - "filenameSuffix": "A String", # Optional. User-provided suffix for Cloud Storage filename. See the [object naming requirements](https://cloud.google.com/storage/docs/objects#naming). + "filenameSuffix": "A String", # Optional. User-provided suffix for Cloud Storage filename. See the [object naming requirements](https://cloud.google.com/storage/docs/objects#naming). Must not end in "/". "maxBytes": "A String", # Optional. The maximum bytes that can be written to a Cloud Storage file before a new file is created. Min 1 KB, max 10 GiB. The max_bytes limit may be exceeded in cases where messages are larger than the limit. "maxDuration": "A String", # Optional. The maximum duration that can elapse before a new Cloud Storage file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not exceed the subscription's acknowledgement deadline. "state": "A String", # Output only. An output-only field that indicates whether or not the subscription can receive messages. @@ -639,7 +639,7 @@

Method Details

}, "bucket": "A String", # Required. User-provided name for the Cloud Storage bucket. The bucket must be created by the user. The bucket name must be without any prefix like "gs://". See the [bucket naming requirements] (https://cloud.google.com/storage/docs/buckets#naming). "filenamePrefix": "A String", # Optional. User-provided prefix for Cloud Storage filename. See the [object naming requirements](https://cloud.google.com/storage/docs/objects#naming). - "filenameSuffix": "A String", # Optional. User-provided suffix for Cloud Storage filename. See the [object naming requirements](https://cloud.google.com/storage/docs/objects#naming). + "filenameSuffix": "A String", # Optional. User-provided suffix for Cloud Storage filename. See the [object naming requirements](https://cloud.google.com/storage/docs/objects#naming). Must not end in "/". "maxBytes": "A String", # Optional. The maximum bytes that can be written to a Cloud Storage file before a new file is created. Min 1 KB, max 10 GiB. The max_bytes limit may be exceeded in cases where messages are larger than the limit. "maxDuration": "A String", # Optional. The maximum duration that can elapse before a new Cloud Storage file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not exceed the subscription's acknowledgement deadline. "state": "A String", # Output only. An output-only field that indicates whether or not the subscription can receive messages. @@ -712,7 +712,7 @@

Method Details

}, "bucket": "A String", # Required. User-provided name for the Cloud Storage bucket. The bucket must be created by the user. The bucket name must be without any prefix like "gs://". See the [bucket naming requirements] (https://cloud.google.com/storage/docs/buckets#naming). "filenamePrefix": "A String", # Optional. User-provided prefix for Cloud Storage filename. See the [object naming requirements](https://cloud.google.com/storage/docs/objects#naming). - "filenameSuffix": "A String", # Optional. User-provided suffix for Cloud Storage filename. See the [object naming requirements](https://cloud.google.com/storage/docs/objects#naming). + "filenameSuffix": "A String", # Optional. User-provided suffix for Cloud Storage filename. See the [object naming requirements](https://cloud.google.com/storage/docs/objects#naming). Must not end in "/". "maxBytes": "A String", # Optional. The maximum bytes that can be written to a Cloud Storage file before a new file is created. Min 1 KB, max 10 GiB. The max_bytes limit may be exceeded in cases where messages are larger than the limit. "maxDuration": "A String", # Optional. The maximum duration that can elapse before a new Cloud Storage file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not exceed the subscription's acknowledgement deadline. "state": "A String", # Output only. An output-only field that indicates whether or not the subscription can receive messages. diff --git a/docs/dyn/recommender_v1beta1.insightTypes.html b/docs/dyn/recommender_v1beta1.insightTypes.html index c831b0eef96..bce532e1ec8 100644 --- a/docs/dyn/recommender_v1beta1.insightTypes.html +++ b/docs/dyn/recommender_v1beta1.insightTypes.html @@ -106,7 +106,7 @@

Method Details

{ # Response for the `ListInsightTypes` method. Next ID: 3 "insightTypes": [ # The set of recommenders available - { # The type of insight. See google3/googledata/devsite/site-cloud/en/recommender/docs/insights/insight-types.md for more info. + { # The type of insight. "name": "A String", # The insight_type’s name in format insightTypes/{insight_type} eg: insightTypes/google.iam.policy.Insight }, ], diff --git a/docs/dyn/recommender_v1beta1.recommenders.html b/docs/dyn/recommender_v1beta1.recommenders.html index 7ff6aa1c70e..31e99dedd04 100644 --- a/docs/dyn/recommender_v1beta1.recommenders.html +++ b/docs/dyn/recommender_v1beta1.recommenders.html @@ -107,7 +107,7 @@

Method Details

{ # Response for the `ListRecommender` method. Next ID: 3 "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. "recommenders": [ # The set of recommenders available - { # The type of a recommender. See google3/googledata/devsite/site-cloud/en/recommender/docs/recommenders.md for more info. + { # The type of a recommender. "name": "A String", # The recommender's name in format RecommenderTypes/{recommender_type} eg: recommenderTypes/google.iam.policy.Recommender }, ], diff --git a/docs/dyn/retail_v2alpha.projects.html b/docs/dyn/retail_v2alpha.projects.html index 3d3edcd819e..79781e84be3 100644 --- a/docs/dyn/retail_v2alpha.projects.html +++ b/docs/dyn/retail_v2alpha.projects.html @@ -84,13 +84,113 @@

Instance Methods

Returns the operations Resource.

+

+ retailProject() +

+

Returns the retailProject Resource.

+

close()

Close httplib2 connections.

+

+ enrollSolution(project, body=None, x__xgafv=None)

+

Enrolls retail API solution for the project. Recommendation solution is enrolled by default when your project enables Retail API. You don't need to call this API for the recommendation solution.

+

+ getRetailProject(name, x__xgafv=None)

+

Gets the project. Throws NOT_FOUND if the project wasn't initialized for Retail API Service.

+

+ listEnrolledSolutions(parent, x__xgafv=None)

+

Lists all the retail API solutions the project has enrolled.

Method Details

close()
Close httplib2 connections.
+
+ enrollSolution(project, body=None, x__xgafv=None) +
Enrolls retail API solution for the project. Recommendation solution is enrolled by default when your project enables Retail API. You don't need to call this API for the recommendation solution.
+
+Args:
+  project: string, Required. Full resource name of parent. Format: `projects/{project_number_or_id}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for EnrollSolution method.
+  "searchSolutionUseCase": "A String", # Solution use case to enroll. Currently settable for Browse to enroll. It should be only set when [solution] is set as SolutionType.SOLUTION_TYPE_SEARCH or an INVALID_ARGUMENT error is thrown.
+  "solution": "A String", # Required. Solution to enroll.
+}
+
+  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.
+  },
+}
+
+ +
+ getRetailProject(name, x__xgafv=None) +
Gets the project. Throws NOT_FOUND if the project wasn't initialized for Retail API Service.
+
+Args:
+  name: string, Required. Full resource name of the project. Format: `projects/{project_number_or_id}/retailProject` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Metadata that describes a Cloud Retail Project.
+  "enrolledSolutions": [ # Output only. Retail API solutions that the project has enrolled.
+    "A String",
+  ],
+  "name": "A String", # Output only. Full resource name of the retail project, such as `projects/{project_id_or_number}/retailProject`.
+}
+
+ +
+ listEnrolledSolutions(parent, x__xgafv=None) +
Lists all the retail API solutions the project has enrolled.
+
+Args:
+  parent: string, Required. Full resource name of parent. Format: `projects/{project_number_or_id}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for ListEnrolledSolutions method.
+  "enrolledSolutions": [ # Retail API solutions that the project has enrolled.
+    "A String",
+  ],
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/retail_v2alpha.projects.retailProject.html b/docs/dyn/retail_v2alpha.projects.retailProject.html new file mode 100644 index 00000000000..1e6ceeef23b --- /dev/null +++ b/docs/dyn/retail_v2alpha.projects.retailProject.html @@ -0,0 +1,117 @@ + + + +

Retail API . projects . retailProject

+

Instance Methods

+

+ acceptTerms(project, body=None, x__xgafv=None)

+

Accepts service terms for this project. By making requests to this API, you agree to the terms of service linked below. https://cloud.google.com/retail/data-use-terms

+

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ acceptTerms(project, body=None, x__xgafv=None) +
Accepts service terms for this project. By making requests to this API, you agree to the terms of service linked below. https://cloud.google.com/retail/data-use-terms
+
+Args:
+  project: string, Required. Full resource name of the project. Format: `projects/{project_number_or_id}/retailProject` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for AcceptTerms method.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Metadata that describes a Cloud Retail Project.
+  "enrolledSolutions": [ # Output only. Retail API solutions that the project has enrolled.
+    "A String",
+  ],
+  "name": "A String", # Output only. Full resource name of the retail project, such as `projects/{project_id_or_number}/retailProject`.
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/run_v2.projects.locations.services.html b/docs/dyn/run_v2.projects.locations.services.html index 89b3960d9f4..14720b00377 100644 --- a/docs/dyn/run_v2.projects.locations.services.html +++ b/docs/dyn/run_v2.projects.locations.services.html @@ -148,7 +148,7 @@

Method Details

], "createTime": "A String", # Output only. The creation time. "creator": "A String", # Output only. Email address of the authenticated creator. - "customAudiences": [ # Custom audiences that can be used in the audience field of ID token for authenticated requests. + "customAudiences": [ # One or more custom audiences that you want this service to support. Specify each custom audience as the full URL in a string. The custom audiences are encoded in the token and used to authenticate requests. For more information, see https://cloud.google.com/run/docs/configuring/custom-audiences. "A String", ], "deleteTime": "A String", # Output only. The deletion time. @@ -447,7 +447,7 @@

Method Details

], "createTime": "A String", # Output only. The creation time. "creator": "A String", # Output only. Email address of the authenticated creator. - "customAudiences": [ # Custom audiences that can be used in the audience field of ID token for authenticated requests. + "customAudiences": [ # One or more custom audiences that you want this service to support. Specify each custom audience as the full URL in a string. The custom audiences are encoded in the token and used to authenticate requests. For more information, see https://cloud.google.com/run/docs/configuring/custom-audiences. "A String", ], "deleteTime": "A String", # Output only. The deletion time. @@ -733,7 +733,7 @@

Method Details

], "createTime": "A String", # Output only. The creation time. "creator": "A String", # Output only. Email address of the authenticated creator. - "customAudiences": [ # Custom audiences that can be used in the audience field of ID token for authenticated requests. + "customAudiences": [ # One or more custom audiences that you want this service to support. Specify each custom audience as the full URL in a string. The custom audiences are encoded in the token and used to authenticate requests. For more information, see https://cloud.google.com/run/docs/configuring/custom-audiences. "A String", ], "deleteTime": "A String", # Output only. The deletion time. @@ -976,7 +976,7 @@

Method Details

], "createTime": "A String", # Output only. The creation time. "creator": "A String", # Output only. Email address of the authenticated creator. - "customAudiences": [ # Custom audiences that can be used in the audience field of ID token for authenticated requests. + "customAudiences": [ # One or more custom audiences that you want this service to support. Specify each custom audience as the full URL in a string. The custom audiences are encoded in the token and used to authenticate requests. For more information, see https://cloud.google.com/run/docs/configuring/custom-audiences. "A String", ], "deleteTime": "A String", # Output only. The deletion time. diff --git a/docs/dyn/securitycenter_v1.folders.sources.findings.html b/docs/dyn/securitycenter_v1.folders.sources.findings.html index 6708eef3218..c5d12efe092 100644 --- a/docs/dyn/securitycenter_v1.folders.sources.findings.html +++ b/docs/dyn/securitycenter_v1.folders.sources.findings.html @@ -265,14 +265,15 @@

Method Details

}, ], "createTime": "A String", # The time at which the finding was created in Security Command Center. - "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. # Database associated with the finding. + "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. # Database associated with the finding. "displayName": "A String", # The human-readable name of the database that the user connected to. "grantees": [ # The target usernames, roles, or groups of an SQL privilege grant, which is not an IAM policy change. "A String", ], - "name": "A String", # The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. + "name": "A String", # Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. "query": "A String", # The SQL statement that is associated with the database access. "userName": "A String", # The username used to connect to the database. The username might not be an IAM principal and does not have a set format. + "version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). }, "description": "A String", # Contains more details about the finding. "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. @@ -663,14 +664,15 @@

Method Details

}, ], "createTime": "A String", # The time at which the finding was created in Security Command Center. - "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. # Database associated with the finding. + "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. # Database associated with the finding. "displayName": "A String", # The human-readable name of the database that the user connected to. "grantees": [ # The target usernames, roles, or groups of an SQL privilege grant, which is not an IAM policy change. "A String", ], - "name": "A String", # The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. + "name": "A String", # Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. "query": "A String", # The SQL statement that is associated with the database access. "userName": "A String", # The username used to connect to the database. The username might not be an IAM principal and does not have a set format. + "version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). }, "description": "A String", # Contains more details about the finding. "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. @@ -1024,14 +1026,15 @@

Method Details

}, ], "createTime": "A String", # The time at which the finding was created in Security Command Center. - "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. # Database associated with the finding. + "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. # Database associated with the finding. "displayName": "A String", # The human-readable name of the database that the user connected to. "grantees": [ # The target usernames, roles, or groups of an SQL privilege grant, which is not an IAM policy change. "A String", ], - "name": "A String", # The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. + "name": "A String", # Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. "query": "A String", # The SQL statement that is associated with the database access. "userName": "A String", # The username used to connect to the database. The username might not be an IAM principal and does not have a set format. + "version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). }, "description": "A String", # Contains more details about the finding. "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. @@ -1398,14 +1401,15 @@

Method Details

}, ], "createTime": "A String", # The time at which the finding was created in Security Command Center. - "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. # Database associated with the finding. + "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. # Database associated with the finding. "displayName": "A String", # The human-readable name of the database that the user connected to. "grantees": [ # The target usernames, roles, or groups of an SQL privilege grant, which is not an IAM policy change. "A String", ], - "name": "A String", # The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. + "name": "A String", # Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. "query": "A String", # The SQL statement that is associated with the database access. "userName": "A String", # The username used to connect to the database. The username might not be an IAM principal and does not have a set format. + "version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). }, "description": "A String", # Contains more details about the finding. "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. @@ -1773,14 +1777,15 @@

Method Details

}, ], "createTime": "A String", # The time at which the finding was created in Security Command Center. - "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. # Database associated with the finding. + "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. # Database associated with the finding. "displayName": "A String", # The human-readable name of the database that the user connected to. "grantees": [ # The target usernames, roles, or groups of an SQL privilege grant, which is not an IAM policy change. "A String", ], - "name": "A String", # The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. + "name": "A String", # Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. "query": "A String", # The SQL statement that is associated with the database access. "userName": "A String", # The username used to connect to the database. The username might not be an IAM principal and does not have a set format. + "version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). }, "description": "A String", # Contains more details about the finding. "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. diff --git a/docs/dyn/securitycenter_v1.organizations.sources.findings.html b/docs/dyn/securitycenter_v1.organizations.sources.findings.html index 5355507a287..2c2454e6430 100644 --- a/docs/dyn/securitycenter_v1.organizations.sources.findings.html +++ b/docs/dyn/securitycenter_v1.organizations.sources.findings.html @@ -198,14 +198,15 @@

Method Details

}, ], "createTime": "A String", # The time at which the finding was created in Security Command Center. - "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. # Database associated with the finding. + "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. # Database associated with the finding. "displayName": "A String", # The human-readable name of the database that the user connected to. "grantees": [ # The target usernames, roles, or groups of an SQL privilege grant, which is not an IAM policy change. "A String", ], - "name": "A String", # The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. + "name": "A String", # Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. "query": "A String", # The SQL statement that is associated with the database access. "userName": "A String", # The username used to connect to the database. The username might not be an IAM principal and does not have a set format. + "version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). }, "description": "A String", # Contains more details about the finding. "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. @@ -559,14 +560,15 @@

Method Details

}, ], "createTime": "A String", # The time at which the finding was created in Security Command Center. - "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. # Database associated with the finding. + "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. # Database associated with the finding. "displayName": "A String", # The human-readable name of the database that the user connected to. "grantees": [ # The target usernames, roles, or groups of an SQL privilege grant, which is not an IAM policy change. "A String", ], - "name": "A String", # The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. + "name": "A String", # Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. "query": "A String", # The SQL statement that is associated with the database access. "userName": "A String", # The username used to connect to the database. The username might not be an IAM principal and does not have a set format. + "version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). }, "description": "A String", # Contains more details about the finding. "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. @@ -991,14 +993,15 @@

Method Details

}, ], "createTime": "A String", # The time at which the finding was created in Security Command Center. - "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. # Database associated with the finding. + "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. # Database associated with the finding. "displayName": "A String", # The human-readable name of the database that the user connected to. "grantees": [ # The target usernames, roles, or groups of an SQL privilege grant, which is not an IAM policy change. "A String", ], - "name": "A String", # The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. + "name": "A String", # Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. "query": "A String", # The SQL statement that is associated with the database access. "userName": "A String", # The username used to connect to the database. The username might not be an IAM principal and does not have a set format. + "version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). }, "description": "A String", # Contains more details about the finding. "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. @@ -1389,14 +1392,15 @@

Method Details

}, ], "createTime": "A String", # The time at which the finding was created in Security Command Center. - "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. # Database associated with the finding. + "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. # Database associated with the finding. "displayName": "A String", # The human-readable name of the database that the user connected to. "grantees": [ # The target usernames, roles, or groups of an SQL privilege grant, which is not an IAM policy change. "A String", ], - "name": "A String", # The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. + "name": "A String", # Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. "query": "A String", # The SQL statement that is associated with the database access. "userName": "A String", # The username used to connect to the database. The username might not be an IAM principal and does not have a set format. + "version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). }, "description": "A String", # Contains more details about the finding. "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. @@ -1750,14 +1754,15 @@

Method Details

}, ], "createTime": "A String", # The time at which the finding was created in Security Command Center. - "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. # Database associated with the finding. + "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. # Database associated with the finding. "displayName": "A String", # The human-readable name of the database that the user connected to. "grantees": [ # The target usernames, roles, or groups of an SQL privilege grant, which is not an IAM policy change. "A String", ], - "name": "A String", # The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. + "name": "A String", # Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. "query": "A String", # The SQL statement that is associated with the database access. "userName": "A String", # The username used to connect to the database. The username might not be an IAM principal and does not have a set format. + "version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). }, "description": "A String", # Contains more details about the finding. "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. @@ -2124,14 +2129,15 @@

Method Details

}, ], "createTime": "A String", # The time at which the finding was created in Security Command Center. - "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. # Database associated with the finding. + "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. # Database associated with the finding. "displayName": "A String", # The human-readable name of the database that the user connected to. "grantees": [ # The target usernames, roles, or groups of an SQL privilege grant, which is not an IAM policy change. "A String", ], - "name": "A String", # The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. + "name": "A String", # Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. "query": "A String", # The SQL statement that is associated with the database access. "userName": "A String", # The username used to connect to the database. The username might not be an IAM principal and does not have a set format. + "version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). }, "description": "A String", # Contains more details about the finding. "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. @@ -2499,14 +2505,15 @@

Method Details

}, ], "createTime": "A String", # The time at which the finding was created in Security Command Center. - "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. # Database associated with the finding. + "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. # Database associated with the finding. "displayName": "A String", # The human-readable name of the database that the user connected to. "grantees": [ # The target usernames, roles, or groups of an SQL privilege grant, which is not an IAM policy change. "A String", ], - "name": "A String", # The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. + "name": "A String", # Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. "query": "A String", # The SQL statement that is associated with the database access. "userName": "A String", # The username used to connect to the database. The username might not be an IAM principal and does not have a set format. + "version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). }, "description": "A String", # Contains more details about the finding. "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. diff --git a/docs/dyn/securitycenter_v1.projects.sources.findings.html b/docs/dyn/securitycenter_v1.projects.sources.findings.html index 3dc9e38bc1b..68ffa80f36c 100644 --- a/docs/dyn/securitycenter_v1.projects.sources.findings.html +++ b/docs/dyn/securitycenter_v1.projects.sources.findings.html @@ -265,14 +265,15 @@

Method Details

}, ], "createTime": "A String", # The time at which the finding was created in Security Command Center. - "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. # Database associated with the finding. + "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. # Database associated with the finding. "displayName": "A String", # The human-readable name of the database that the user connected to. "grantees": [ # The target usernames, roles, or groups of an SQL privilege grant, which is not an IAM policy change. "A String", ], - "name": "A String", # The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. + "name": "A String", # Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. "query": "A String", # The SQL statement that is associated with the database access. "userName": "A String", # The username used to connect to the database. The username might not be an IAM principal and does not have a set format. + "version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). }, "description": "A String", # Contains more details about the finding. "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. @@ -663,14 +664,15 @@

Method Details

}, ], "createTime": "A String", # The time at which the finding was created in Security Command Center. - "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. # Database associated with the finding. + "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. # Database associated with the finding. "displayName": "A String", # The human-readable name of the database that the user connected to. "grantees": [ # The target usernames, roles, or groups of an SQL privilege grant, which is not an IAM policy change. "A String", ], - "name": "A String", # The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. + "name": "A String", # Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. "query": "A String", # The SQL statement that is associated with the database access. "userName": "A String", # The username used to connect to the database. The username might not be an IAM principal and does not have a set format. + "version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). }, "description": "A String", # Contains more details about the finding. "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. @@ -1024,14 +1026,15 @@

Method Details

}, ], "createTime": "A String", # The time at which the finding was created in Security Command Center. - "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. # Database associated with the finding. + "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. # Database associated with the finding. "displayName": "A String", # The human-readable name of the database that the user connected to. "grantees": [ # The target usernames, roles, or groups of an SQL privilege grant, which is not an IAM policy change. "A String", ], - "name": "A String", # The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. + "name": "A String", # Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. "query": "A String", # The SQL statement that is associated with the database access. "userName": "A String", # The username used to connect to the database. The username might not be an IAM principal and does not have a set format. + "version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). }, "description": "A String", # Contains more details about the finding. "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. @@ -1398,14 +1401,15 @@

Method Details

}, ], "createTime": "A String", # The time at which the finding was created in Security Command Center. - "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. # Database associated with the finding. + "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. # Database associated with the finding. "displayName": "A String", # The human-readable name of the database that the user connected to. "grantees": [ # The target usernames, roles, or groups of an SQL privilege grant, which is not an IAM policy change. "A String", ], - "name": "A String", # The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. + "name": "A String", # Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. "query": "A String", # The SQL statement that is associated with the database access. "userName": "A String", # The username used to connect to the database. The username might not be an IAM principal and does not have a set format. + "version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). }, "description": "A String", # Contains more details about the finding. "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. @@ -1773,14 +1777,15 @@

Method Details

}, ], "createTime": "A String", # The time at which the finding was created in Security Command Center. - "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. # Database associated with the finding. + "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. # Database associated with the finding. "displayName": "A String", # The human-readable name of the database that the user connected to. "grantees": [ # The target usernames, roles, or groups of an SQL privilege grant, which is not an IAM policy change. "A String", ], - "name": "A String", # The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. + "name": "A String", # Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. "query": "A String", # The SQL statement that is associated with the database access. "userName": "A String", # The username used to connect to the database. The username might not be an IAM principal and does not have a set format. + "version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). }, "description": "A String", # Contains more details about the finding. "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. diff --git a/docs/dyn/slides_v1.presentations.html b/docs/dyn/slides_v1.presentations.html index 4e37fd92c5d..25c03e41971 100644 --- a/docs/dyn/slides_v1.presentations.html +++ b/docs/dyn/slides_v1.presentations.html @@ -777,7 +777,1014 @@

Method Details

"isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. - "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. + "notesPage": { # A page in a presentation. # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. + "layoutProperties": { # The properties of Page are only relevant for pages with page_type LAYOUT. # Layout specific properties. Only set if page_type = LAYOUT. + "displayName": "A String", # The human-readable name of the layout. + "masterObjectId": "A String", # The object ID of the master that this layout is based on. + "name": "A String", # The name of the layout. + }, + "masterProperties": { # The properties of Page that are only relevant for pages with page_type MASTER. # Master specific properties. Only set if page_type = MASTER. + "displayName": "A String", # The human-readable name of the master. + }, + "notesProperties": { # The properties of Page that are only relevant for pages with page_type NOTES. # Notes specific properties. Only set if page_type = NOTES. + "speakerNotesObjectId": "A String", # The object ID of the shape on this notes page that contains the speaker notes for the corresponding slide. The actual shape may not always exist on the notes page. Inserting text using this object ID will automatically create the shape. In this case, the actual shape may have different object ID. The `GetPresentation` or `GetPage` action will always return the latest object ID. + }, + "objectId": "A String", # The object ID for this page. Object IDs used by Page and PageElement share the same namespace. + "pageElements": [ # The page elements rendered on the page. + { # A visual element rendered on a page. + "description": "A String", # The description of the page element. Combined with title to display alt text. The field is not supported for Group elements. + "elementGroup": { # A PageElement kind representing a joined collection of PageElements. # A collection of page elements joined as a single unit. + "children": [ # The collection of elements in the group. The minimum size of a group is 2. + # Object with schema name: PageElement + ], + }, + "image": { # A PageElement kind representing an image. # An image page element. + "contentUrl": "A String", # An URL to an image with a default lifetime of 30 minutes. This URL is tagged with the account of the requester. Anyone with the URL effectively accesses the image as the original requester. Access to the image may be lost if the presentation's sharing settings change. + "imageProperties": { # The properties of the Image. # The properties of the image. + "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. This property is read-only. + "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. This property is read-only. + "cropProperties": { # The crop properties of an object enclosed in a container. For example, an Image. The crop properties is represented by the offsets of four edges which define a crop rectangle. The offsets are measured in percentage from the corresponding edges of the object's original bounding rectangle towards inside, relative to the object's original dimensions. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the object's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the object's original bounding rectangle. - If the left edge of the crop rectangle is on the right side of its right edge, the object will be flipped horizontally. - If the top edge of the crop rectangle is below its bottom edge, the object will be flipped vertically. - If all offsets and rotation angle is 0, the object is not cropped. After cropping, the content in the crop rectangle will be stretched to fit its container. # The crop properties of the image. If not set, the image is not cropped. This property is read-only. + "angle": 3.14, # The rotation angle of the crop window around its center, in radians. Rotation angle is applied after the offset. + "bottomOffset": 3.14, # The offset specifies the bottom edge of the crop rectangle that is located above the original bounding rectangle bottom edge, relative to the object's original height. + "leftOffset": 3.14, # The offset specifies the left edge of the crop rectangle that is located to the right of the original bounding rectangle left edge, relative to the object's original width. + "rightOffset": 3.14, # The offset specifies the right edge of the crop rectangle that is located to the left of the original bounding rectangle right edge, relative to the object's original width. + "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located below the original bounding rectangle top edge, relative to the object's original height. + }, + "link": { # A hypertext link. # The hyperlink destination of the image. If unset, there is no link. + "pageObjectId": "A String", # If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. + "relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation, addressed by its position. + "slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. + "url": "A String", # If set, indicates this is a link to the external web page at this URL. + }, + "outline": { # The outline of a PageElement. If these fields are unset, they may be inherited from a parent placeholder if it exists. If there is no parent, the fields will default to the value used for new page elements created in the Slides editor, which may depend on the page element kind. # The outline of the image. If not set, the image has no outline. + "dashStyle": "A String", # The dash style of the outline. + "outlineFill": { # The fill of the outline. # The fill of the outline. + "solidFill": { # A solid color fill. The page or page element is filled entirely with the specified color value. If any field is unset, its value may be inherited from a parent placeholder if it exists. # Solid color fill. + "alpha": 3.14, # The fraction of this `color` that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. + "color": { # A themeable solid color value. # The color value of the solid fill. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + }, + "propertyState": "A String", # The outline property state. Updating the outline on a page element will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no outline on a page element, set this field to `NOT_RENDERED`. In this case, any other outline fields set in the same request will be ignored. + "weight": { # A magnitude in a single direction in the specified units. # The thickness of the outline. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "recolor": { # A recolor effect applied on an image. # The recolor effect of the image. If not set, the image is not recolored. This property is read-only. + "name": "A String", # The name of the recolor effect. The name is determined from the `recolor_stops` by matching the gradient against the colors in the page's current color scheme. This property is read-only. + "recolorStops": [ # The recolor effect is represented by a gradient, which is a list of color stops. The colors in the gradient will replace the corresponding colors at the same position in the color palette and apply to the image. This property is read-only. + { # A color and position in a gradient band. + "alpha": 3.14, # The alpha value of this color in the gradient band. Defaults to 1.0, fully opaque. + "color": { # A themeable solid color value. # The color of the gradient stop. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + "position": 3.14, # The relative position of the color stop in the gradient band measured in percentage. The value should be in the interval [0.0, 1.0]. + }, + ], + }, + "shadow": { # The shadow properties of a page element. If these fields are unset, they may be inherited from a parent placeholder if it exists. If there is no parent, the fields will default to the value used for new page elements created in the Slides editor, which may depend on the page element kind. # The shadow of the image. If not set, the image has no shadow. This property is read-only. + "alignment": "A String", # The alignment point of the shadow, that sets the origin for translate, scale and skew of the shadow. This property is read-only. + "alpha": 3.14, # The alpha of the shadow's color, from 0.0 to 1.0. + "blurRadius": { # A magnitude in a single direction in the specified units. # The radius of the shadow blur. The larger the radius, the more diffuse the shadow becomes. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "color": { # A themeable solid color value. # The shadow color value. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + "propertyState": "A String", # The shadow property state. Updating the shadow on a page element will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no shadow on a page element, set this field to `NOT_RENDERED`. In this case, any other shadow fields set in the same request will be ignored. + "rotateWithShape": True or False, # Whether the shadow should rotate with the shape. This property is read-only. + "transform": { # AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ] to transform source coordinates (x,y) into destination coordinates (x', y') according to: x' x = shear_y scale_y translate_y 1 [ 1 ] After transformation, x' = scale_x * x + shear_x * y + translate_x; y' = scale_y * y + shear_y * x + translate_y; This message is therefore composed of these six matrix elements. # Transform that encodes the translate, scale, and skew of the shadow, relative to the alignment position. + "scaleX": 3.14, # The X coordinate scaling element. + "scaleY": 3.14, # The Y coordinate scaling element. + "shearX": 3.14, # The X coordinate shearing element. + "shearY": 3.14, # The Y coordinate shearing element. + "translateX": 3.14, # The X coordinate translation element. + "translateY": 3.14, # The Y coordinate translation element. + "unit": "A String", # The units for translate elements. + }, + "type": "A String", # The type of the shadow. This property is read-only. + }, + "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means completely transparent. This property is read-only. + }, + "placeholder": { # The placeholder information that uniquely identifies a placeholder shape. # Placeholders are page elements that inherit from corresponding placeholders on layouts and masters. If set, the image is a placeholder image and any inherited properties can be resolved by looking at the parent placeholder identified by the Placeholder.parent_object_id field. + "index": 42, # The index of the placeholder. If the same placeholder types are present in the same page, they would have different index values. + "parentObjectId": "A String", # The object ID of this shape's parent placeholder. If unset, the parent placeholder shape does not exist, so the shape does not inherit properties from any other shape. + "type": "A String", # The type of the placeholder. + }, + "sourceUrl": "A String", # The source URL is the URL used to insert the image. The source URL can be empty. + }, + "line": { # A PageElement kind representing a non-connector line, straight connector, curved connector, or bent connector. # A line page element. + "lineCategory": "A String", # The category of the line. It matches the `category` specified in CreateLineRequest, and can be updated with UpdateLineCategoryRequest. + "lineProperties": { # The properties of the Line. When unset, these fields default to values that match the appearance of new lines created in the Slides editor. # The properties of the line. + "dashStyle": "A String", # The dash style of the line. + "endArrow": "A String", # The style of the arrow at the end of the line. + "endConnection": { # The properties for one end of a Line connection. # The connection at the end of the line. If unset, there is no connection. Only lines with a Type indicating it is a "connector" can have an `end_connection`. + "connectedObjectId": "A String", # The object ID of the connected page element. Some page elements, such as groups, tables, and lines do not have connection sites and therefore cannot be connected to a connector line. + "connectionSiteIndex": 42, # The index of the connection site on the connected page element. In most cases, it corresponds to the predefined connection site index from the ECMA-376 standard. More information on those connection sites can be found in the description of the "cnx" attribute in section 20.1.9.9 and Annex H. "Predefined DrawingML Shape and Text Geometries" of "Office Open XML File Formats-Fundamentals and Markup Language Reference", part 1 of [ECMA-376 5th edition] (http://www.ecma-international.org/publications/standards/Ecma-376.htm). The position of each connection site can also be viewed from Slides editor. + }, + "lineFill": { # The fill of the line. # The fill of the line. The default line fill matches the defaults for new lines created in the Slides editor. + "solidFill": { # A solid color fill. The page or page element is filled entirely with the specified color value. If any field is unset, its value may be inherited from a parent placeholder if it exists. # Solid color fill. + "alpha": 3.14, # The fraction of this `color` that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. + "color": { # A themeable solid color value. # The color value of the solid fill. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + }, + "link": { # A hypertext link. # The hyperlink destination of the line. If unset, there is no link. + "pageObjectId": "A String", # If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. + "relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation, addressed by its position. + "slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. + "url": "A String", # If set, indicates this is a link to the external web page at this URL. + }, + "startArrow": "A String", # The style of the arrow at the beginning of the line. + "startConnection": { # The properties for one end of a Line connection. # The connection at the beginning of the line. If unset, there is no connection. Only lines with a Type indicating it is a "connector" can have a `start_connection`. + "connectedObjectId": "A String", # The object ID of the connected page element. Some page elements, such as groups, tables, and lines do not have connection sites and therefore cannot be connected to a connector line. + "connectionSiteIndex": 42, # The index of the connection site on the connected page element. In most cases, it corresponds to the predefined connection site index from the ECMA-376 standard. More information on those connection sites can be found in the description of the "cnx" attribute in section 20.1.9.9 and Annex H. "Predefined DrawingML Shape and Text Geometries" of "Office Open XML File Formats-Fundamentals and Markup Language Reference", part 1 of [ECMA-376 5th edition] (http://www.ecma-international.org/publications/standards/Ecma-376.htm). The position of each connection site can also be viewed from Slides editor. + }, + "weight": { # A magnitude in a single direction in the specified units. # The thickness of the line. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "lineType": "A String", # The type of the line. + }, + "objectId": "A String", # The object ID for this page element. Object IDs used by google.apps.slides.v1.Page and google.apps.slides.v1.PageElement share the same namespace. + "shape": { # A PageElement kind representing a generic shape that does not have a more specific classification. # A generic shape. + "placeholder": { # The placeholder information that uniquely identifies a placeholder shape. # Placeholders are page elements that inherit from corresponding placeholders on layouts and masters. If set, the shape is a placeholder shape and any inherited properties can be resolved by looking at the parent placeholder identified by the Placeholder.parent_object_id field. + "index": 42, # The index of the placeholder. If the same placeholder types are present in the same page, they would have different index values. + "parentObjectId": "A String", # The object ID of this shape's parent placeholder. If unset, the parent placeholder shape does not exist, so the shape does not inherit properties from any other shape. + "type": "A String", # The type of the placeholder. + }, + "shapeProperties": { # The properties of a Shape. If the shape is a placeholder shape as determined by the placeholder field, then these properties may be inherited from a parent placeholder shape. Determining the rendered value of the property depends on the corresponding property_state field value. Any text autofit settings on the shape are automatically deactivated by requests that can impact how text fits in the shape. # The properties of the shape. + "autofit": { # The autofit properties of a Shape. # The autofit properties of the shape. This property is only set for shapes that allow text. + "autofitType": "A String", # The autofit type of the shape. If the autofit type is AUTOFIT_TYPE_UNSPECIFIED, the autofit type is inherited from a parent placeholder if it exists. The field is automatically set to NONE if a request is made that might affect text fitting within its bounding text box. In this case the font_scale is applied to the font_size and the line_spacing_reduction is applied to the line_spacing. Both properties are also reset to default values. + "fontScale": 3.14, # The font scale applied to the shape. For shapes with autofit_type NONE or SHAPE_AUTOFIT, this value is the default value of 1. For TEXT_AUTOFIT, this value multiplied by the font_size gives the font size that is rendered in the editor. This property is read-only. + "lineSpacingReduction": 3.14, # The line spacing reduction applied to the shape. For shapes with autofit_type NONE or SHAPE_AUTOFIT, this value is the default value of 0. For TEXT_AUTOFIT, this value subtracted from the line_spacing gives the line spacing that is rendered in the editor. This property is read-only. + }, + "contentAlignment": "A String", # The alignment of the content in the shape. If unspecified, the alignment is inherited from a parent placeholder if it exists. If the shape has no parent, the default alignment matches the alignment for new shapes created in the Slides editor. + "link": { # A hypertext link. # The hyperlink destination of the shape. If unset, there is no link. Links are not inherited from parent placeholders. + "pageObjectId": "A String", # If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. + "relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation, addressed by its position. + "slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. + "url": "A String", # If set, indicates this is a link to the external web page at this URL. + }, + "outline": { # The outline of a PageElement. If these fields are unset, they may be inherited from a parent placeholder if it exists. If there is no parent, the fields will default to the value used for new page elements created in the Slides editor, which may depend on the page element kind. # The outline of the shape. If unset, the outline is inherited from a parent placeholder if it exists. If the shape has no parent, then the default outline depends on the shape type, matching the defaults for new shapes created in the Slides editor. + "dashStyle": "A String", # The dash style of the outline. + "outlineFill": { # The fill of the outline. # The fill of the outline. + "solidFill": { # A solid color fill. The page or page element is filled entirely with the specified color value. If any field is unset, its value may be inherited from a parent placeholder if it exists. # Solid color fill. + "alpha": 3.14, # The fraction of this `color` that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. + "color": { # A themeable solid color value. # The color value of the solid fill. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + }, + "propertyState": "A String", # The outline property state. Updating the outline on a page element will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no outline on a page element, set this field to `NOT_RENDERED`. In this case, any other outline fields set in the same request will be ignored. + "weight": { # A magnitude in a single direction in the specified units. # The thickness of the outline. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "shadow": { # The shadow properties of a page element. If these fields are unset, they may be inherited from a parent placeholder if it exists. If there is no parent, the fields will default to the value used for new page elements created in the Slides editor, which may depend on the page element kind. # The shadow properties of the shape. If unset, the shadow is inherited from a parent placeholder if it exists. If the shape has no parent, then the default shadow matches the defaults for new shapes created in the Slides editor. This property is read-only. + "alignment": "A String", # The alignment point of the shadow, that sets the origin for translate, scale and skew of the shadow. This property is read-only. + "alpha": 3.14, # The alpha of the shadow's color, from 0.0 to 1.0. + "blurRadius": { # A magnitude in a single direction in the specified units. # The radius of the shadow blur. The larger the radius, the more diffuse the shadow becomes. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "color": { # A themeable solid color value. # The shadow color value. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + "propertyState": "A String", # The shadow property state. Updating the shadow on a page element will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no shadow on a page element, set this field to `NOT_RENDERED`. In this case, any other shadow fields set in the same request will be ignored. + "rotateWithShape": True or False, # Whether the shadow should rotate with the shape. This property is read-only. + "transform": { # AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ] to transform source coordinates (x,y) into destination coordinates (x', y') according to: x' x = shear_y scale_y translate_y 1 [ 1 ] After transformation, x' = scale_x * x + shear_x * y + translate_x; y' = scale_y * y + shear_y * x + translate_y; This message is therefore composed of these six matrix elements. # Transform that encodes the translate, scale, and skew of the shadow, relative to the alignment position. + "scaleX": 3.14, # The X coordinate scaling element. + "scaleY": 3.14, # The Y coordinate scaling element. + "shearX": 3.14, # The X coordinate shearing element. + "shearY": 3.14, # The Y coordinate shearing element. + "translateX": 3.14, # The X coordinate translation element. + "translateY": 3.14, # The Y coordinate translation element. + "unit": "A String", # The units for translate elements. + }, + "type": "A String", # The type of the shadow. This property is read-only. + }, + "shapeBackgroundFill": { # The shape background fill. # The background fill of the shape. If unset, the background fill is inherited from a parent placeholder if it exists. If the shape has no parent, then the default background fill depends on the shape type, matching the defaults for new shapes created in the Slides editor. + "propertyState": "A String", # The background fill property state. Updating the fill on a shape will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no fill on a shape, set this field to `NOT_RENDERED`. In this case, any other fill fields set in the same request will be ignored. + "solidFill": { # A solid color fill. The page or page element is filled entirely with the specified color value. If any field is unset, its value may be inherited from a parent placeholder if it exists. # Solid color fill. + "alpha": 3.14, # The fraction of this `color` that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. + "color": { # A themeable solid color value. # The color value of the solid fill. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + }, + }, + "shapeType": "A String", # The type of the shape. + "text": { # The general text content. The text must reside in a compatible shape (e.g. text box or rectangle) or a table cell in a page. # The text content of the shape. + "lists": { # The bulleted lists contained in this text, keyed by list ID. + "a_key": { # A List describes the look and feel of bullets belonging to paragraphs associated with a list. A paragraph that is part of a list has an implicit reference to that list's ID. + "listId": "A String", # The ID of the list. + "nestingLevel": { # A map of nesting levels to the properties of bullets at the associated level. A list has at most nine levels of nesting, so the possible values for the keys of this map are 0 through 8, inclusive. + "a_key": { # Contains properties describing the look and feel of a list bullet at a given level of nesting. + "bulletStyle": { # Represents the styling that can be applied to a TextRun. If this text is contained in a shape with a parent placeholder, then these text styles may be inherited from the parent. Which text styles are inherited depend on the nesting level of lists: * A text run in a paragraph that is not in a list will inherit its text style from the the newline character in the paragraph at the 0 nesting level of the list inside the parent placeholder. * A text run in a paragraph that is in a list will inherit its text style from the newline character in the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited text styles are represented as unset fields in this message. If text is contained in a shape without a parent placeholder, unsetting these fields will revert the style to a value matching the defaults in the Slides editor. # The style of a bullet at this level of nesting. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. + "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. The `font_size` itself is not affected by changes in this field. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. Some fonts can affect the weight of the text. If an update request specifies values for both `font_family` and `bold`, the explicitly-set `bold` value is used. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in points. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The color of the text itself. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. + "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be set to ThemeColorType.HYPERLINK and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "pageObjectId": "A String", # If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. + "relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation, addressed by its position. + "slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. + "url": "A String", # If set, indicates this is a link to the external web page at this URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This field is an extension of `font_family` meant to support explicit font weights without breaking backwards compatibility. As such, when reading the style of a range of text, the value of `weighted_font_family#font_family` will always be equal to that of `font_family`. However, when writing, if both fields are included in the field mask (either explicitly or through the wildcard `"*"`), their values are reconciled as follows: * If `font_family` is set and `weighted_font_family` is not, the value of `font_family` is applied with weight `400` ("normal"). * If both fields are set, the value of `font_family` must match that of `weighted_font_family#font_family`. If so, the font family and weight of `weighted_font_family` is applied. Otherwise, a 400 bad request error is returned. * If `weighted_font_family` is set and `font_family` is not, the font family and weight of `weighted_font_family` is applied. * If neither field is set, the font family and weight of the text inherit from the parent. Note that these properties cannot inherit separately from each other. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The rendered weight of the text. This field can have any value that is a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. Weights greater than or equal to `700` are considered bold, and weights less than `700`are not bold. The default value is `400` ("normal"). + }, + }, + }, + }, + }, + }, + "textElements": [ # The text contents broken down into its component parts, including styling information. This property is read-only. + { # A TextElement describes the content of a range of indices in the text content of a Shape or TableCell. + "autoText": { # A TextElement kind that represents auto text. # A TextElement representing a spot in the text that is dynamically replaced with content that can change over time. + "content": "A String", # The rendered content of this auto text, if available. + "style": { # Represents the styling that can be applied to a TextRun. If this text is contained in a shape with a parent placeholder, then these text styles may be inherited from the parent. Which text styles are inherited depend on the nesting level of lists: * A text run in a paragraph that is not in a list will inherit its text style from the the newline character in the paragraph at the 0 nesting level of the list inside the parent placeholder. * A text run in a paragraph that is in a list will inherit its text style from the newline character in the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited text styles are represented as unset fields in this message. If text is contained in a shape without a parent placeholder, unsetting these fields will revert the style to a value matching the defaults in the Slides editor. # The styling applied to this auto text. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. + "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. The `font_size` itself is not affected by changes in this field. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. Some fonts can affect the weight of the text. If an update request specifies values for both `font_family` and `bold`, the explicitly-set `bold` value is used. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in points. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The color of the text itself. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. + "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be set to ThemeColorType.HYPERLINK and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "pageObjectId": "A String", # If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. + "relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation, addressed by its position. + "slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. + "url": "A String", # If set, indicates this is a link to the external web page at this URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This field is an extension of `font_family` meant to support explicit font weights without breaking backwards compatibility. As such, when reading the style of a range of text, the value of `weighted_font_family#font_family` will always be equal to that of `font_family`. However, when writing, if both fields are included in the field mask (either explicitly or through the wildcard `"*"`), their values are reconciled as follows: * If `font_family` is set and `weighted_font_family` is not, the value of `font_family` is applied with weight `400` ("normal"). * If both fields are set, the value of `font_family` must match that of `weighted_font_family#font_family`. If so, the font family and weight of `weighted_font_family` is applied. Otherwise, a 400 bad request error is returned. * If `weighted_font_family` is set and `font_family` is not, the font family and weight of `weighted_font_family` is applied. * If neither field is set, the font family and weight of the text inherit from the parent. Note that these properties cannot inherit separately from each other. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The rendered weight of the text. This field can have any value that is a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. Weights greater than or equal to `700` are considered bold, and weights less than `700`are not bold. The default value is `400` ("normal"). + }, + }, + "type": "A String", # The type of this auto text. + }, + "endIndex": 42, # The zero-based end index of this text element, exclusive, in Unicode code units. + "paragraphMarker": { # A TextElement kind that represents the beginning of a new paragraph. # A marker representing the beginning of a new paragraph. The `start_index` and `end_index` of this TextElement represent the range of the paragraph. Other TextElements with an index range contained inside this paragraph's range are considered to be part of this paragraph. The range of indices of two separate paragraphs will never overlap. + "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list. + "bulletStyle": { # Represents the styling that can be applied to a TextRun. If this text is contained in a shape with a parent placeholder, then these text styles may be inherited from the parent. Which text styles are inherited depend on the nesting level of lists: * A text run in a paragraph that is not in a list will inherit its text style from the the newline character in the paragraph at the 0 nesting level of the list inside the parent placeholder. * A text run in a paragraph that is in a list will inherit its text style from the newline character in the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited text styles are represented as unset fields in this message. If text is contained in a shape without a parent placeholder, unsetting these fields will revert the style to a value matching the defaults in the Slides editor. # The paragraph specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. + "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. The `font_size` itself is not affected by changes in this field. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. Some fonts can affect the weight of the text. If an update request specifies values for both `font_family` and `bold`, the explicitly-set `bold` value is used. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in points. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The color of the text itself. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. + "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be set to ThemeColorType.HYPERLINK and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "pageObjectId": "A String", # If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. + "relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation, addressed by its position. + "slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. + "url": "A String", # If set, indicates this is a link to the external web page at this URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This field is an extension of `font_family` meant to support explicit font weights without breaking backwards compatibility. As such, when reading the style of a range of text, the value of `weighted_font_family#font_family` will always be equal to that of `font_family`. However, when writing, if both fields are included in the field mask (either explicitly or through the wildcard `"*"`), their values are reconciled as follows: * If `font_family` is set and `weighted_font_family` is not, the value of `font_family` is applied with weight `400` ("normal"). * If both fields are set, the value of `font_family` must match that of `weighted_font_family#font_family`. If so, the font family and weight of `weighted_font_family` is applied. Otherwise, a 400 bad request error is returned. * If `weighted_font_family` is set and `font_family` is not, the font family and weight of `weighted_font_family` is applied. * If neither field is set, the font family and weight of the text inherit from the parent. Note that these properties cannot inherit separately from each other. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The rendered weight of the text. This field can have any value that is a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. Weights greater than or equal to `700` are considered bold, and weights less than `700`are not bold. The default value is `400` ("normal"). + }, + }, + "glyph": "A String", # The rendered bullet glyph for this paragraph. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + }, + "style": { # Styles that apply to a whole paragraph. If this text is contained in a shape with a parent placeholder, then these paragraph styles may be inherited from the parent. Which paragraph styles are inherited depend on the nesting level of lists: * A paragraph not in a list will inherit its paragraph style from the paragraph at the 0 nesting level of the list inside the parent placeholder. * A paragraph in a list will inherit its paragraph style from the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited paragraph styles are represented as unset fields in this message. # The paragraph's style + "alignment": "A String", # The text alignment for this paragraph. + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since text direction is not inherited. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount indentation for the paragraph on the side that corresponds to the end of the text, based on the current text direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the start of the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount indentation for the paragraph on the side that corresponds to the start of the text, based on the current text direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + }, + }, + "startIndex": 42, # The zero-based start index of this text element, in Unicode code units. + "textRun": { # A TextElement kind that represents a run of text that all has the same styling. # A TextElement representing a run of text where all of the characters in the run have the same TextStyle. The `start_index` and `end_index` of TextRuns will always be fully contained in the index range of a single `paragraph_marker` TextElement. In other words, a TextRun will never span multiple paragraphs. + "content": "A String", # The text of this run. + "style": { # Represents the styling that can be applied to a TextRun. If this text is contained in a shape with a parent placeholder, then these text styles may be inherited from the parent. Which text styles are inherited depend on the nesting level of lists: * A text run in a paragraph that is not in a list will inherit its text style from the the newline character in the paragraph at the 0 nesting level of the list inside the parent placeholder. * A text run in a paragraph that is in a list will inherit its text style from the newline character in the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited text styles are represented as unset fields in this message. If text is contained in a shape without a parent placeholder, unsetting these fields will revert the style to a value matching the defaults in the Slides editor. # The styling applied to this run. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. + "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. The `font_size` itself is not affected by changes in this field. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. Some fonts can affect the weight of the text. If an update request specifies values for both `font_family` and `bold`, the explicitly-set `bold` value is used. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in points. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The color of the text itself. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. + "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be set to ThemeColorType.HYPERLINK and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "pageObjectId": "A String", # If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. + "relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation, addressed by its position. + "slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. + "url": "A String", # If set, indicates this is a link to the external web page at this URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This field is an extension of `font_family` meant to support explicit font weights without breaking backwards compatibility. As such, when reading the style of a range of text, the value of `weighted_font_family#font_family` will always be equal to that of `font_family`. However, when writing, if both fields are included in the field mask (either explicitly or through the wildcard `"*"`), their values are reconciled as follows: * If `font_family` is set and `weighted_font_family` is not, the value of `font_family` is applied with weight `400` ("normal"). * If both fields are set, the value of `font_family` must match that of `weighted_font_family#font_family`. If so, the font family and weight of `weighted_font_family` is applied. Otherwise, a 400 bad request error is returned. * If `weighted_font_family` is set and `font_family` is not, the font family and weight of `weighted_font_family` is applied. * If neither field is set, the font family and weight of the text inherit from the parent. Note that these properties cannot inherit separately from each other. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The rendered weight of the text. This field can have any value that is a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. Weights greater than or equal to `700` are considered bold, and weights less than `700`are not bold. The default value is `400` ("normal"). + }, + }, + }, + }, + ], + }, + }, + "sheetsChart": { # A PageElement kind representing a linked chart embedded from Google Sheets. # A linked chart embedded from Google Sheets. Unlinked charts are represented as images. + "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that is embedded. + "contentUrl": "A String", # The URL of an image of the embedded chart, with a default lifetime of 30 minutes. This URL is tagged with the account of the requester. Anyone with the URL effectively accesses the image as the original requester. Access to the image may be lost if the presentation's sharing settings change. + "sheetsChartProperties": { # The properties of the SheetsChart. # The properties of the Sheets chart. + "chartImageProperties": { # The properties of the Image. # The properties of the embedded chart image. + "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. This property is read-only. + "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. This property is read-only. + "cropProperties": { # The crop properties of an object enclosed in a container. For example, an Image. The crop properties is represented by the offsets of four edges which define a crop rectangle. The offsets are measured in percentage from the corresponding edges of the object's original bounding rectangle towards inside, relative to the object's original dimensions. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the object's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the object's original bounding rectangle. - If the left edge of the crop rectangle is on the right side of its right edge, the object will be flipped horizontally. - If the top edge of the crop rectangle is below its bottom edge, the object will be flipped vertically. - If all offsets and rotation angle is 0, the object is not cropped. After cropping, the content in the crop rectangle will be stretched to fit its container. # The crop properties of the image. If not set, the image is not cropped. This property is read-only. + "angle": 3.14, # The rotation angle of the crop window around its center, in radians. Rotation angle is applied after the offset. + "bottomOffset": 3.14, # The offset specifies the bottom edge of the crop rectangle that is located above the original bounding rectangle bottom edge, relative to the object's original height. + "leftOffset": 3.14, # The offset specifies the left edge of the crop rectangle that is located to the right of the original bounding rectangle left edge, relative to the object's original width. + "rightOffset": 3.14, # The offset specifies the right edge of the crop rectangle that is located to the left of the original bounding rectangle right edge, relative to the object's original width. + "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located below the original bounding rectangle top edge, relative to the object's original height. + }, + "link": { # A hypertext link. # The hyperlink destination of the image. If unset, there is no link. + "pageObjectId": "A String", # If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. + "relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation, addressed by its position. + "slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. + "url": "A String", # If set, indicates this is a link to the external web page at this URL. + }, + "outline": { # The outline of a PageElement. If these fields are unset, they may be inherited from a parent placeholder if it exists. If there is no parent, the fields will default to the value used for new page elements created in the Slides editor, which may depend on the page element kind. # The outline of the image. If not set, the image has no outline. + "dashStyle": "A String", # The dash style of the outline. + "outlineFill": { # The fill of the outline. # The fill of the outline. + "solidFill": { # A solid color fill. The page or page element is filled entirely with the specified color value. If any field is unset, its value may be inherited from a parent placeholder if it exists. # Solid color fill. + "alpha": 3.14, # The fraction of this `color` that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. + "color": { # A themeable solid color value. # The color value of the solid fill. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + }, + "propertyState": "A String", # The outline property state. Updating the outline on a page element will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no outline on a page element, set this field to `NOT_RENDERED`. In this case, any other outline fields set in the same request will be ignored. + "weight": { # A magnitude in a single direction in the specified units. # The thickness of the outline. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "recolor": { # A recolor effect applied on an image. # The recolor effect of the image. If not set, the image is not recolored. This property is read-only. + "name": "A String", # The name of the recolor effect. The name is determined from the `recolor_stops` by matching the gradient against the colors in the page's current color scheme. This property is read-only. + "recolorStops": [ # The recolor effect is represented by a gradient, which is a list of color stops. The colors in the gradient will replace the corresponding colors at the same position in the color palette and apply to the image. This property is read-only. + { # A color and position in a gradient band. + "alpha": 3.14, # The alpha value of this color in the gradient band. Defaults to 1.0, fully opaque. + "color": { # A themeable solid color value. # The color of the gradient stop. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + "position": 3.14, # The relative position of the color stop in the gradient band measured in percentage. The value should be in the interval [0.0, 1.0]. + }, + ], + }, + "shadow": { # The shadow properties of a page element. If these fields are unset, they may be inherited from a parent placeholder if it exists. If there is no parent, the fields will default to the value used for new page elements created in the Slides editor, which may depend on the page element kind. # The shadow of the image. If not set, the image has no shadow. This property is read-only. + "alignment": "A String", # The alignment point of the shadow, that sets the origin for translate, scale and skew of the shadow. This property is read-only. + "alpha": 3.14, # The alpha of the shadow's color, from 0.0 to 1.0. + "blurRadius": { # A magnitude in a single direction in the specified units. # The radius of the shadow blur. The larger the radius, the more diffuse the shadow becomes. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "color": { # A themeable solid color value. # The shadow color value. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + "propertyState": "A String", # The shadow property state. Updating the shadow on a page element will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no shadow on a page element, set this field to `NOT_RENDERED`. In this case, any other shadow fields set in the same request will be ignored. + "rotateWithShape": True or False, # Whether the shadow should rotate with the shape. This property is read-only. + "transform": { # AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ] to transform source coordinates (x,y) into destination coordinates (x', y') according to: x' x = shear_y scale_y translate_y 1 [ 1 ] After transformation, x' = scale_x * x + shear_x * y + translate_x; y' = scale_y * y + shear_y * x + translate_y; This message is therefore composed of these six matrix elements. # Transform that encodes the translate, scale, and skew of the shadow, relative to the alignment position. + "scaleX": 3.14, # The X coordinate scaling element. + "scaleY": 3.14, # The Y coordinate scaling element. + "shearX": 3.14, # The X coordinate shearing element. + "shearY": 3.14, # The Y coordinate shearing element. + "translateX": 3.14, # The X coordinate translation element. + "translateY": 3.14, # The Y coordinate translation element. + "unit": "A String", # The units for translate elements. + }, + "type": "A String", # The type of the shadow. This property is read-only. + }, + "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means completely transparent. This property is read-only. + }, + }, + "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart. + }, + "size": { # A width and height. # The size of the page element. + "height": { # A magnitude in a single direction in the specified units. # The height of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "table": { # A PageElement kind representing a table. # A table page element. + "columns": 42, # Number of columns in the table. + "horizontalBorderRows": [ # Properties of horizontal cell borders. A table's horizontal cell borders are represented as a grid. The grid has one more row than the number of rows in the table and the same number of columns as the table. For example, if the table is 3 x 3, its horizontal borders will be represented as a grid with 4 rows and 3 columns. + { # Contents of each border row in a table. + "tableBorderCells": [ # Properties of each border cell. When a border's adjacent table cells are merged, it is not included in the response. + { # The properties of each border cell. + "location": { # A location of a single table cell within a table. # The location of the border within the border table. + "columnIndex": 42, # The 0-based column index. + "rowIndex": 42, # The 0-based row index. + }, + "tableBorderProperties": { # The border styling properties of the TableBorderCell. # The border properties. + "dashStyle": "A String", # The dash style of the border. + "tableBorderFill": { # The fill of the border. # The fill of the table border. + "solidFill": { # A solid color fill. The page or page element is filled entirely with the specified color value. If any field is unset, its value may be inherited from a parent placeholder if it exists. # Solid fill. + "alpha": 3.14, # The fraction of this `color` that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. + "color": { # A themeable solid color value. # The color value of the solid fill. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + }, + "weight": { # A magnitude in a single direction in the specified units. # The thickness of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + }, + ], + }, + ], + "rows": 42, # Number of rows in the table. + "tableColumns": [ # Properties of each column. + { # Properties of each column in a table. + "columnWidth": { # A magnitude in a single direction in the specified units. # Width of a column. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], + "tableRows": [ # Properties and contents of each row. Cells that span multiple rows are contained in only one of these rows and have a row_span greater than 1. + { # Properties and contents of each row in a table. + "rowHeight": { # A magnitude in a single direction in the specified units. # Height of a row. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "tableCells": [ # Properties and contents of each cell. Cells that span multiple columns are represented only once with a column_span greater than 1. As a result, the length of this collection does not always match the number of columns of the entire table. + { # Properties and contents of each table cell. + "columnSpan": 42, # Column span of the cell. + "location": { # A location of a single table cell within a table. # The location of the cell within the table. + "columnIndex": 42, # The 0-based column index. + "rowIndex": 42, # The 0-based row index. + }, + "rowSpan": 42, # Row span of the cell. + "tableCellProperties": { # The properties of the TableCell. # The properties of the table cell. + "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Slides editor. + "tableCellBackgroundFill": { # The table cell background fill. # The background fill of the table cell. The default fill matches the fill for newly created table cells in the Slides editor. + "propertyState": "A String", # The background fill property state. Updating the fill on a table cell will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no fill on a table cell, set this field to `NOT_RENDERED`. In this case, any other fill fields set in the same request will be ignored. + "solidFill": { # A solid color fill. The page or page element is filled entirely with the specified color value. If any field is unset, its value may be inherited from a parent placeholder if it exists. # Solid color fill. + "alpha": 3.14, # The fraction of this `color` that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. + "color": { # A themeable solid color value. # The color value of the solid fill. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + }, + }, + "text": { # The general text content. The text must reside in a compatible shape (e.g. text box or rectangle) or a table cell in a page. # The text content of the cell. + "lists": { # The bulleted lists contained in this text, keyed by list ID. + "a_key": { # A List describes the look and feel of bullets belonging to paragraphs associated with a list. A paragraph that is part of a list has an implicit reference to that list's ID. + "listId": "A String", # The ID of the list. + "nestingLevel": { # A map of nesting levels to the properties of bullets at the associated level. A list has at most nine levels of nesting, so the possible values for the keys of this map are 0 through 8, inclusive. + "a_key": { # Contains properties describing the look and feel of a list bullet at a given level of nesting. + "bulletStyle": { # Represents the styling that can be applied to a TextRun. If this text is contained in a shape with a parent placeholder, then these text styles may be inherited from the parent. Which text styles are inherited depend on the nesting level of lists: * A text run in a paragraph that is not in a list will inherit its text style from the the newline character in the paragraph at the 0 nesting level of the list inside the parent placeholder. * A text run in a paragraph that is in a list will inherit its text style from the newline character in the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited text styles are represented as unset fields in this message. If text is contained in a shape without a parent placeholder, unsetting these fields will revert the style to a value matching the defaults in the Slides editor. # The style of a bullet at this level of nesting. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. + "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. The `font_size` itself is not affected by changes in this field. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. Some fonts can affect the weight of the text. If an update request specifies values for both `font_family` and `bold`, the explicitly-set `bold` value is used. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in points. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The color of the text itself. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. + "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be set to ThemeColorType.HYPERLINK and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "pageObjectId": "A String", # If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. + "relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation, addressed by its position. + "slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. + "url": "A String", # If set, indicates this is a link to the external web page at this URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This field is an extension of `font_family` meant to support explicit font weights without breaking backwards compatibility. As such, when reading the style of a range of text, the value of `weighted_font_family#font_family` will always be equal to that of `font_family`. However, when writing, if both fields are included in the field mask (either explicitly or through the wildcard `"*"`), their values are reconciled as follows: * If `font_family` is set and `weighted_font_family` is not, the value of `font_family` is applied with weight `400` ("normal"). * If both fields are set, the value of `font_family` must match that of `weighted_font_family#font_family`. If so, the font family and weight of `weighted_font_family` is applied. Otherwise, a 400 bad request error is returned. * If `weighted_font_family` is set and `font_family` is not, the font family and weight of `weighted_font_family` is applied. * If neither field is set, the font family and weight of the text inherit from the parent. Note that these properties cannot inherit separately from each other. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The rendered weight of the text. This field can have any value that is a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. Weights greater than or equal to `700` are considered bold, and weights less than `700`are not bold. The default value is `400` ("normal"). + }, + }, + }, + }, + }, + }, + "textElements": [ # The text contents broken down into its component parts, including styling information. This property is read-only. + { # A TextElement describes the content of a range of indices in the text content of a Shape or TableCell. + "autoText": { # A TextElement kind that represents auto text. # A TextElement representing a spot in the text that is dynamically replaced with content that can change over time. + "content": "A String", # The rendered content of this auto text, if available. + "style": { # Represents the styling that can be applied to a TextRun. If this text is contained in a shape with a parent placeholder, then these text styles may be inherited from the parent. Which text styles are inherited depend on the nesting level of lists: * A text run in a paragraph that is not in a list will inherit its text style from the the newline character in the paragraph at the 0 nesting level of the list inside the parent placeholder. * A text run in a paragraph that is in a list will inherit its text style from the newline character in the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited text styles are represented as unset fields in this message. If text is contained in a shape without a parent placeholder, unsetting these fields will revert the style to a value matching the defaults in the Slides editor. # The styling applied to this auto text. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. + "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. The `font_size` itself is not affected by changes in this field. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. Some fonts can affect the weight of the text. If an update request specifies values for both `font_family` and `bold`, the explicitly-set `bold` value is used. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in points. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The color of the text itself. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. + "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be set to ThemeColorType.HYPERLINK and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "pageObjectId": "A String", # If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. + "relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation, addressed by its position. + "slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. + "url": "A String", # If set, indicates this is a link to the external web page at this URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This field is an extension of `font_family` meant to support explicit font weights without breaking backwards compatibility. As such, when reading the style of a range of text, the value of `weighted_font_family#font_family` will always be equal to that of `font_family`. However, when writing, if both fields are included in the field mask (either explicitly or through the wildcard `"*"`), their values are reconciled as follows: * If `font_family` is set and `weighted_font_family` is not, the value of `font_family` is applied with weight `400` ("normal"). * If both fields are set, the value of `font_family` must match that of `weighted_font_family#font_family`. If so, the font family and weight of `weighted_font_family` is applied. Otherwise, a 400 bad request error is returned. * If `weighted_font_family` is set and `font_family` is not, the font family and weight of `weighted_font_family` is applied. * If neither field is set, the font family and weight of the text inherit from the parent. Note that these properties cannot inherit separately from each other. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The rendered weight of the text. This field can have any value that is a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. Weights greater than or equal to `700` are considered bold, and weights less than `700`are not bold. The default value is `400` ("normal"). + }, + }, + "type": "A String", # The type of this auto text. + }, + "endIndex": 42, # The zero-based end index of this text element, exclusive, in Unicode code units. + "paragraphMarker": { # A TextElement kind that represents the beginning of a new paragraph. # A marker representing the beginning of a new paragraph. The `start_index` and `end_index` of this TextElement represent the range of the paragraph. Other TextElements with an index range contained inside this paragraph's range are considered to be part of this paragraph. The range of indices of two separate paragraphs will never overlap. + "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list. + "bulletStyle": { # Represents the styling that can be applied to a TextRun. If this text is contained in a shape with a parent placeholder, then these text styles may be inherited from the parent. Which text styles are inherited depend on the nesting level of lists: * A text run in a paragraph that is not in a list will inherit its text style from the the newline character in the paragraph at the 0 nesting level of the list inside the parent placeholder. * A text run in a paragraph that is in a list will inherit its text style from the newline character in the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited text styles are represented as unset fields in this message. If text is contained in a shape without a parent placeholder, unsetting these fields will revert the style to a value matching the defaults in the Slides editor. # The paragraph specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. + "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. The `font_size` itself is not affected by changes in this field. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. Some fonts can affect the weight of the text. If an update request specifies values for both `font_family` and `bold`, the explicitly-set `bold` value is used. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in points. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The color of the text itself. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. + "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be set to ThemeColorType.HYPERLINK and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "pageObjectId": "A String", # If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. + "relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation, addressed by its position. + "slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. + "url": "A String", # If set, indicates this is a link to the external web page at this URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This field is an extension of `font_family` meant to support explicit font weights without breaking backwards compatibility. As such, when reading the style of a range of text, the value of `weighted_font_family#font_family` will always be equal to that of `font_family`. However, when writing, if both fields are included in the field mask (either explicitly or through the wildcard `"*"`), their values are reconciled as follows: * If `font_family` is set and `weighted_font_family` is not, the value of `font_family` is applied with weight `400` ("normal"). * If both fields are set, the value of `font_family` must match that of `weighted_font_family#font_family`. If so, the font family and weight of `weighted_font_family` is applied. Otherwise, a 400 bad request error is returned. * If `weighted_font_family` is set and `font_family` is not, the font family and weight of `weighted_font_family` is applied. * If neither field is set, the font family and weight of the text inherit from the parent. Note that these properties cannot inherit separately from each other. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The rendered weight of the text. This field can have any value that is a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. Weights greater than or equal to `700` are considered bold, and weights less than `700`are not bold. The default value is `400` ("normal"). + }, + }, + "glyph": "A String", # The rendered bullet glyph for this paragraph. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + }, + "style": { # Styles that apply to a whole paragraph. If this text is contained in a shape with a parent placeholder, then these paragraph styles may be inherited from the parent. Which paragraph styles are inherited depend on the nesting level of lists: * A paragraph not in a list will inherit its paragraph style from the paragraph at the 0 nesting level of the list inside the parent placeholder. * A paragraph in a list will inherit its paragraph style from the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited paragraph styles are represented as unset fields in this message. # The paragraph's style + "alignment": "A String", # The text alignment for this paragraph. + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since text direction is not inherited. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount indentation for the paragraph on the side that corresponds to the end of the text, based on the current text direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the start of the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount indentation for the paragraph on the side that corresponds to the start of the text, based on the current text direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + }, + }, + "startIndex": 42, # The zero-based start index of this text element, in Unicode code units. + "textRun": { # A TextElement kind that represents a run of text that all has the same styling. # A TextElement representing a run of text where all of the characters in the run have the same TextStyle. The `start_index` and `end_index` of TextRuns will always be fully contained in the index range of a single `paragraph_marker` TextElement. In other words, a TextRun will never span multiple paragraphs. + "content": "A String", # The text of this run. + "style": { # Represents the styling that can be applied to a TextRun. If this text is contained in a shape with a parent placeholder, then these text styles may be inherited from the parent. Which text styles are inherited depend on the nesting level of lists: * A text run in a paragraph that is not in a list will inherit its text style from the the newline character in the paragraph at the 0 nesting level of the list inside the parent placeholder. * A text run in a paragraph that is in a list will inherit its text style from the newline character in the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited text styles are represented as unset fields in this message. If text is contained in a shape without a parent placeholder, unsetting these fields will revert the style to a value matching the defaults in the Slides editor. # The styling applied to this run. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. + "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. The `font_size` itself is not affected by changes in this field. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. Some fonts can affect the weight of the text. If an update request specifies values for both `font_family` and `bold`, the explicitly-set `bold` value is used. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in points. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The color of the text itself. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. + "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be set to ThemeColorType.HYPERLINK and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "pageObjectId": "A String", # If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. + "relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation, addressed by its position. + "slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. + "url": "A String", # If set, indicates this is a link to the external web page at this URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This field is an extension of `font_family` meant to support explicit font weights without breaking backwards compatibility. As such, when reading the style of a range of text, the value of `weighted_font_family#font_family` will always be equal to that of `font_family`. However, when writing, if both fields are included in the field mask (either explicitly or through the wildcard `"*"`), their values are reconciled as follows: * If `font_family` is set and `weighted_font_family` is not, the value of `font_family` is applied with weight `400` ("normal"). * If both fields are set, the value of `font_family` must match that of `weighted_font_family#font_family`. If so, the font family and weight of `weighted_font_family` is applied. Otherwise, a 400 bad request error is returned. * If `weighted_font_family` is set and `font_family` is not, the font family and weight of `weighted_font_family` is applied. * If neither field is set, the font family and weight of the text inherit from the parent. Note that these properties cannot inherit separately from each other. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The rendered weight of the text. This field can have any value that is a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. Weights greater than or equal to `700` are considered bold, and weights less than `700`are not bold. The default value is `400` ("normal"). + }, + }, + }, + }, + ], + }, + }, + ], + "tableRowProperties": { # Properties of each row in a table. # Properties of the row. + "minRowHeight": { # A magnitude in a single direction in the specified units. # Minimum height of the row. The row will be rendered in the Slides editor at a height equal to or greater than this value in order to show all the text in the row's cell(s). + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + }, + ], + "verticalBorderRows": [ # Properties of vertical cell borders. A table's vertical cell borders are represented as a grid. The grid has the same number of rows as the table and one more column than the number of columns in the table. For example, if the table is 3 x 3, its vertical borders will be represented as a grid with 3 rows and 4 columns. + { # Contents of each border row in a table. + "tableBorderCells": [ # Properties of each border cell. When a border's adjacent table cells are merged, it is not included in the response. + { # The properties of each border cell. + "location": { # A location of a single table cell within a table. # The location of the border within the border table. + "columnIndex": 42, # The 0-based column index. + "rowIndex": 42, # The 0-based row index. + }, + "tableBorderProperties": { # The border styling properties of the TableBorderCell. # The border properties. + "dashStyle": "A String", # The dash style of the border. + "tableBorderFill": { # The fill of the border. # The fill of the table border. + "solidFill": { # A solid color fill. The page or page element is filled entirely with the specified color value. If any field is unset, its value may be inherited from a parent placeholder if it exists. # Solid fill. + "alpha": 3.14, # The fraction of this `color` that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. + "color": { # A themeable solid color value. # The color value of the solid fill. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + }, + "weight": { # A magnitude in a single direction in the specified units. # The thickness of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + }, + ], + }, + ], + }, + "title": "A String", # The title of the page element. Combined with description to display alt text. The field is not supported for Group elements. + "transform": { # AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ] to transform source coordinates (x,y) into destination coordinates (x', y') according to: x' x = shear_y scale_y translate_y 1 [ 1 ] After transformation, x' = scale_x * x + shear_x * y + translate_x; y' = scale_y * y + shear_y * x + translate_y; This message is therefore composed of these six matrix elements. # The transform of the page element. The visual appearance of the page element is determined by its absolute transform. To compute the absolute transform, preconcatenate a page element's transform with the transforms of all of its parent groups. If the page element is not in a group, its absolute transform is the same as the value in this field. The initial transform for the newly created Group is always the identity transform. + "scaleX": 3.14, # The X coordinate scaling element. + "scaleY": 3.14, # The Y coordinate scaling element. + "shearX": 3.14, # The X coordinate shearing element. + "shearY": 3.14, # The Y coordinate shearing element. + "translateX": 3.14, # The X coordinate translation element. + "translateY": 3.14, # The Y coordinate translation element. + "unit": "A String", # The units for translate elements. + }, + "video": { # A PageElement kind representing a video. # A video page element. + "id": "A String", # The video source's unique identifier for this video. + "source": "A String", # The video source. + "url": "A String", # An URL to a video. The URL is valid as long as the source video exists and sharing settings do not change. + "videoProperties": { # The properties of the Video. # The properties of the video. + "autoPlay": True or False, # Whether to enable video autoplay when the page is displayed in present mode. Defaults to false. + "end": 42, # The time at which to end playback, measured in seconds from the beginning of the video. If set, the end time should be after the start time. If not set or if you set this to a value that exceeds the video's length, the video will be played until its end. + "mute": True or False, # Whether to mute the audio during video playback. Defaults to false. + "outline": { # The outline of a PageElement. If these fields are unset, they may be inherited from a parent placeholder if it exists. If there is no parent, the fields will default to the value used for new page elements created in the Slides editor, which may depend on the page element kind. # The outline of the video. The default outline matches the defaults for new videos created in the Slides editor. + "dashStyle": "A String", # The dash style of the outline. + "outlineFill": { # The fill of the outline. # The fill of the outline. + "solidFill": { # A solid color fill. The page or page element is filled entirely with the specified color value. If any field is unset, its value may be inherited from a parent placeholder if it exists. # Solid color fill. + "alpha": 3.14, # The fraction of this `color` that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. + "color": { # A themeable solid color value. # The color value of the solid fill. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + }, + "propertyState": "A String", # The outline property state. Updating the outline on a page element will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no outline on a page element, set this field to `NOT_RENDERED`. In this case, any other outline fields set in the same request will be ignored. + "weight": { # A magnitude in a single direction in the specified units. # The thickness of the outline. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "start": 42, # The time at which to start playback, measured in seconds from the beginning of the video. If set, the start time should be before the end time. If you set this to a value that exceeds the video's length in seconds, the video will be played from the last second. If not set, the video will be played from the beginning. + }, + }, + "wordArt": { # A PageElement kind representing word art. # A word art page element. + "renderedText": "A String", # The text rendered as word art. + }, + }, + ], + "pageProperties": { # The properties of the Page. The page will inherit properties from the parent page. Depending on the page type the hierarchy is defined in either SlideProperties or LayoutProperties. # The properties of the page. + "colorScheme": { # The palette of predefined colors for a page. # The color scheme of the page. If unset, the color scheme is inherited from a parent page. If the page has no parent, the color scheme uses a default Slides color scheme, matching the defaults in the Slides editor. Only the concrete colors of the first 12 ThemeColorTypes are editable. In addition, only the color scheme on `Master` pages can be updated. To update the field, a color scheme containing mappings from all the first 12 ThemeColorTypes to their concrete colors must be provided. Colors for the remaining ThemeColorTypes will be ignored. + "colors": [ # The ThemeColorType and corresponding concrete color pairs. + { # A pair mapping a theme color type to the concrete color it represents. + "color": { # An RGB color. # The concrete color corresponding to the theme color type above. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "type": "A String", # The type of the theme color. + }, + ], + }, + "pageBackgroundFill": { # The page background fill. # The background fill of the page. If unset, the background fill is inherited from a parent page if it exists. If the page has no parent, then the background fill defaults to the corresponding fill in the Slides editor. + "propertyState": "A String", # The background fill property state. Updating the fill on a page will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no fill on a page, set this field to `NOT_RENDERED`. In this case, any other fill fields set in the same request will be ignored. + "solidFill": { # A solid color fill. The page or page element is filled entirely with the specified color value. If any field is unset, its value may be inherited from a parent placeholder if it exists. # Solid color fill. + "alpha": 3.14, # The fraction of this `color` that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. + "color": { # A themeable solid color value. # The color value of the solid fill. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "stretchedPictureFill": { # The stretched picture fill. The page or page element is filled entirely with the specified picture. The picture is stretched to fit its container. # Stretched picture fill. + "contentUrl": "A String", # Reading the content_url: An URL to a picture with a default lifetime of 30 minutes. This URL is tagged with the account of the requester. Anyone with the URL effectively accesses the picture as the original requester. Access to the picture may be lost if the presentation's sharing settings change. Writing the content_url: The picture is fetched once at insertion time and a copy is stored for display inside the presentation. Pictures must be less than 50MB in size, cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF format. The provided URL can be at most 2 kB in length. + "size": { # A width and height. # The original size of the picture fill. This field is read-only. + "height": { # A magnitude in a single direction in the specified units. # The height of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + }, + }, + }, + "pageType": "A String", # The type of the page. + "revisionId": "A String", # Output only. The revision ID of the presentation. Can be used in update requests to assert the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated. However, a changed ID can also be due to internal factors such as ID format changes. + "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. + }, }, }, "updateSlidesPosition": { # Updates the position of slides in the presentation. # Updates the position of a set of slides in the presentation. @@ -2045,12 +3052,7 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # Output only. The revision ID of the presentation. Can be used in update requests to assert the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated. However, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. - "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. - "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. - "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. - "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. - }, + "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. }, ], "locale": "A String", # The locale of the presentation, as an IETF BCP 47 language tag. @@ -3061,12 +4063,7 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # Output only. The revision ID of the presentation. Can be used in update requests to assert the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated. However, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. - "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. - "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. - "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. - "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. - }, + "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. }, ], "notesMaster": { # A page in a presentation. # The notes master in the presentation. It serves three purposes: - Placeholder shapes on a notes master contain the default text styles and shape properties of all placeholder shapes on notes pages. Specifically, a `SLIDE_IMAGE` placeholder shape contains the slide thumbnail, and a `BODY` placeholder shape contains the speaker notes. - The notes master page properties define the common page properties inherited by all notes pages. - Any other shapes on the notes master appear on all notes pages. The notes master is read-only. @@ -4075,12 +5072,7 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # Output only. The revision ID of the presentation. Can be used in update requests to assert the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated. However, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. - "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. - "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. - "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. - "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. - }, + "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. }, "pageSize": { # A width and height. # The size of pages in the presentation. "height": { # A magnitude in a single direction in the specified units. # The height of the object. @@ -5101,12 +6093,7 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # Output only. The revision ID of the presentation. Can be used in update requests to assert the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated. However, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. - "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. - "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. - "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. - "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. - }, + "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. }, ], "title": "A String", # The title of the presentation. @@ -6128,12 +7115,7 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # Output only. The revision ID of the presentation. Can be used in update requests to assert the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated. However, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. - "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. - "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. - "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. - "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. - }, + "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. }, ], "locale": "A String", # The locale of the presentation, as an IETF BCP 47 language tag. @@ -7144,12 +8126,7 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # Output only. The revision ID of the presentation. Can be used in update requests to assert the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated. However, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. - "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. - "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. - "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. - "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. - }, + "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. }, ], "notesMaster": { # A page in a presentation. # The notes master in the presentation. It serves three purposes: - Placeholder shapes on a notes master contain the default text styles and shape properties of all placeholder shapes on notes pages. Specifically, a `SLIDE_IMAGE` placeholder shape contains the slide thumbnail, and a `BODY` placeholder shape contains the speaker notes. - The notes master page properties define the common page properties inherited by all notes pages. - Any other shapes on the notes master appear on all notes pages. The notes master is read-only. @@ -8158,12 +9135,7 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # Output only. The revision ID of the presentation. Can be used in update requests to assert the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated. However, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. - "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. - "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. - "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. - "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. - }, + "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. }, "pageSize": { # A width and height. # The size of pages in the presentation. "height": { # A magnitude in a single direction in the specified units. # The height of the object. @@ -9184,12 +10156,7 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # Output only. The revision ID of the presentation. Can be used in update requests to assert the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated. However, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. - "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. - "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. - "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. - "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. - }, + "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. }, ], "title": "A String", # The title of the presentation. @@ -10218,12 +11185,7 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # Output only. The revision ID of the presentation. Can be used in update requests to assert the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated. However, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. - "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. - "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. - "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. - "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. - }, + "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. }, ], "locale": "A String", # The locale of the presentation, as an IETF BCP 47 language tag. @@ -11234,12 +12196,7 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # Output only. The revision ID of the presentation. Can be used in update requests to assert the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated. However, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. - "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. - "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. - "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. - "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. - }, + "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. }, ], "notesMaster": { # A page in a presentation. # The notes master in the presentation. It serves three purposes: - Placeholder shapes on a notes master contain the default text styles and shape properties of all placeholder shapes on notes pages. Specifically, a `SLIDE_IMAGE` placeholder shape contains the slide thumbnail, and a `BODY` placeholder shape contains the speaker notes. - The notes master page properties define the common page properties inherited by all notes pages. - Any other shapes on the notes master appear on all notes pages. The notes master is read-only. @@ -12248,12 +13205,7 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # Output only. The revision ID of the presentation. Can be used in update requests to assert the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated. However, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. - "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. - "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. - "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. - "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. - }, + "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. }, "pageSize": { # A width and height. # The size of pages in the presentation. "height": { # A magnitude in a single direction in the specified units. # The height of the object. @@ -13274,12 +14226,7 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # Output only. The revision ID of the presentation. Can be used in update requests to assert the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated. However, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. - "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. - "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. - "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. - "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. - }, + "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. }, ], "title": "A String", # The title of the presentation. diff --git a/docs/dyn/slides_v1.presentations.pages.html b/docs/dyn/slides_v1.presentations.pages.html index 7671a5028bb..d6c583bb80b 100644 --- a/docs/dyn/slides_v1.presentations.pages.html +++ b/docs/dyn/slides_v1.presentations.pages.html @@ -1110,12 +1110,7 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # Output only. The revision ID of the presentation. Can be used in update requests to assert the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated. However, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. - "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. - "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. - "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. - "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. - }, + "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. }
diff --git a/docs/dyn/toolresults_v1beta3.projects.histories.executions.html b/docs/dyn/toolresults_v1beta3.projects.histories.executions.html index 59646bcbae7..7e072aaed37 100644 --- a/docs/dyn/toolresults_v1beta3.projects.histories.executions.html +++ b/docs/dyn/toolresults_v1beta3.projects.histories.executions.html @@ -123,7 +123,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # An Execution represents a collection of Steps. For instance, it could represent: - a mobile test executed across a range of device configurations - a jenkins job with a build step followed by a test step The maximum size of an execution message is 1 MiB. An Execution can be updated until its state is set to COMPLETE at which point it becomes immutable. Next tag: 17 +{ # An Execution represents a collection of Steps. For instance, it could represent: - a mobile test executed across a range of device configurations - a jenkins job with a build step followed by a test step The maximum size of an execution message is 1 MiB. An Execution can be updated until its state is set to COMPLETE at which point it becomes immutable. "completionTime": { # A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # The time when the Execution status transitioned to COMPLETE. This value will be set automatically when state transitions to COMPLETE. - In response: set if the execution state is COMPLETE. - In create/update request: never set "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive. @@ -224,7 +224,7 @@

Method Details

Returns: An object of the form: - { # An Execution represents a collection of Steps. For instance, it could represent: - a mobile test executed across a range of device configurations - a jenkins job with a build step followed by a test step The maximum size of an execution message is 1 MiB. An Execution can be updated until its state is set to COMPLETE at which point it becomes immutable. Next tag: 17 + { # An Execution represents a collection of Steps. For instance, it could represent: - a mobile test executed across a range of device configurations - a jenkins job with a build step followed by a test step The maximum size of an execution message is 1 MiB. An Execution can be updated until its state is set to COMPLETE at which point it becomes immutable. "completionTime": { # A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # The time when the Execution status transitioned to COMPLETE. This value will be set automatically when state transitions to COMPLETE. - In response: set if the execution state is COMPLETE. - In create/update request: never set "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive. @@ -333,7 +333,7 @@

Method Details

Returns: An object of the form: - { # An Execution represents a collection of Steps. For instance, it could represent: - a mobile test executed across a range of device configurations - a jenkins job with a build step followed by a test step The maximum size of an execution message is 1 MiB. An Execution can be updated until its state is set to COMPLETE at which point it becomes immutable. Next tag: 17 + { # An Execution represents a collection of Steps. For instance, it could represent: - a mobile test executed across a range of device configurations - a jenkins job with a build step followed by a test step The maximum size of an execution message is 1 MiB. An Execution can be updated until its state is set to COMPLETE at which point it becomes immutable. "completionTime": { # A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # The time when the Execution status transitioned to COMPLETE. This value will be set automatically when state transitions to COMPLETE. - In response: set if the execution state is COMPLETE. - In create/update request: never set "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive. @@ -445,7 +445,7 @@

Method Details

{ "executions": [ # Executions. Always set. - { # An Execution represents a collection of Steps. For instance, it could represent: - a mobile test executed across a range of device configurations - a jenkins job with a build step followed by a test step The maximum size of an execution message is 1 MiB. An Execution can be updated until its state is set to COMPLETE at which point it becomes immutable. Next tag: 17 + { # An Execution represents a collection of Steps. For instance, it could represent: - a mobile test executed across a range of device configurations - a jenkins job with a build step followed by a test step The maximum size of an execution message is 1 MiB. An Execution can be updated until its state is set to COMPLETE at which point it becomes immutable. "completionTime": { # A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # The time when the Execution status transitioned to COMPLETE. This value will be set automatically when state transitions to COMPLETE. - In response: set if the execution state is COMPLETE. - In create/update request: never set "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive. @@ -566,7 +566,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # An Execution represents a collection of Steps. For instance, it could represent: - a mobile test executed across a range of device configurations - a jenkins job with a build step followed by a test step The maximum size of an execution message is 1 MiB. An Execution can be updated until its state is set to COMPLETE at which point it becomes immutable. Next tag: 17 +{ # An Execution represents a collection of Steps. For instance, it could represent: - a mobile test executed across a range of device configurations - a jenkins job with a build step followed by a test step The maximum size of an execution message is 1 MiB. An Execution can be updated until its state is set to COMPLETE at which point it becomes immutable. "completionTime": { # A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # The time when the Execution status transitioned to COMPLETE. This value will be set automatically when state transitions to COMPLETE. - In response: set if the execution state is COMPLETE. - In create/update request: never set "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive. @@ -667,7 +667,7 @@

Method Details

Returns: An object of the form: - { # An Execution represents a collection of Steps. For instance, it could represent: - a mobile test executed across a range of device configurations - a jenkins job with a build step followed by a test step The maximum size of an execution message is 1 MiB. An Execution can be updated until its state is set to COMPLETE at which point it becomes immutable. Next tag: 17 + { # An Execution represents a collection of Steps. For instance, it could represent: - a mobile test executed across a range of device configurations - a jenkins job with a build step followed by a test step The maximum size of an execution message is 1 MiB. An Execution can be updated until its state is set to COMPLETE at which point it becomes immutable. "completionTime": { # A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # The time when the Execution status transitioned to COMPLETE. This value will be set automatically when state transitions to COMPLETE. - In response: set if the execution state is COMPLETE. - In create/update request: never set "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive. diff --git a/docs/dyn/toolresults_v1beta3.projects.histories.executions.steps.html b/docs/dyn/toolresults_v1beta3.projects.histories.executions.steps.html index 215c8333306..b4789f42b4e 100644 --- a/docs/dyn/toolresults_v1beta3.projects.histories.executions.steps.html +++ b/docs/dyn/toolresults_v1beta3.projects.histories.executions.steps.html @@ -186,7 +186,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # A Step represents a single operation performed as part of Execution. A step can be used to represent the execution of a tool ( for example a test runner execution or an execution of a compiler). Steps can overlap (for instance two steps might have the same start time if some operations are done in parallel). Here is an example, let's consider that we have a continuous build is executing a test runner for each iteration. The workflow would look like: - user creates a Execution with id 1 - user creates a TestExecutionStep with id 100 for Execution 1 - user update TestExecutionStep with id 100 to add a raw xml log + the service parses the xml logs and returns a TestExecutionStep with updated TestResult(s). - user update the status of TestExecutionStep with id 100 to COMPLETE A Step can be updated until its state is set to COMPLETE at which points it becomes immutable. Next tag: 27 +{ # A Step represents a single operation performed as part of Execution. A step can be used to represent the execution of a tool ( for example a test runner execution or an execution of a compiler). Steps can overlap (for instance two steps might have the same start time if some operations are done in parallel). Here is an example, let's consider that we have a continuous build is executing a test runner for each iteration. The workflow would look like: - user creates a Execution with id 1 - user creates a TestExecutionStep with id 100 for Execution 1 - user update TestExecutionStep with id 100 to add a raw xml log + the service parses the xml logs and returns a TestExecutionStep with updated TestResult(s). - user update the status of TestExecutionStep with id 100 to COMPLETE A Step can be updated until its state is set to COMPLETE at which points it becomes immutable. "completionTime": { # A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # The time when the step status was set to complete. This value will be set automatically when state transitions to COMPLETE. - In response: set if the execution state is COMPLETE. - In create/update request: never set "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive. @@ -374,7 +374,7 @@

Method Details

Returns: An object of the form: - { # A Step represents a single operation performed as part of Execution. A step can be used to represent the execution of a tool ( for example a test runner execution or an execution of a compiler). Steps can overlap (for instance two steps might have the same start time if some operations are done in parallel). Here is an example, let's consider that we have a continuous build is executing a test runner for each iteration. The workflow would look like: - user creates a Execution with id 1 - user creates a TestExecutionStep with id 100 for Execution 1 - user update TestExecutionStep with id 100 to add a raw xml log + the service parses the xml logs and returns a TestExecutionStep with updated TestResult(s). - user update the status of TestExecutionStep with id 100 to COMPLETE A Step can be updated until its state is set to COMPLETE at which points it becomes immutable. Next tag: 27 + { # A Step represents a single operation performed as part of Execution. A step can be used to represent the execution of a tool ( for example a test runner execution or an execution of a compiler). Steps can overlap (for instance two steps might have the same start time if some operations are done in parallel). Here is an example, let's consider that we have a continuous build is executing a test runner for each iteration. The workflow would look like: - user creates a Execution with id 1 - user creates a TestExecutionStep with id 100 for Execution 1 - user update TestExecutionStep with id 100 to add a raw xml log + the service parses the xml logs and returns a TestExecutionStep with updated TestResult(s). - user update the status of TestExecutionStep with id 100 to COMPLETE A Step can be updated until its state is set to COMPLETE at which points it becomes immutable. "completionTime": { # A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # The time when the step status was set to complete. This value will be set automatically when state transitions to COMPLETE. - In response: set if the execution state is COMPLETE. - In create/update request: never set "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive. @@ -571,7 +571,7 @@

Method Details

Returns: An object of the form: - { # A Step represents a single operation performed as part of Execution. A step can be used to represent the execution of a tool ( for example a test runner execution or an execution of a compiler). Steps can overlap (for instance two steps might have the same start time if some operations are done in parallel). Here is an example, let's consider that we have a continuous build is executing a test runner for each iteration. The workflow would look like: - user creates a Execution with id 1 - user creates a TestExecutionStep with id 100 for Execution 1 - user update TestExecutionStep with id 100 to add a raw xml log + the service parses the xml logs and returns a TestExecutionStep with updated TestResult(s). - user update the status of TestExecutionStep with id 100 to COMPLETE A Step can be updated until its state is set to COMPLETE at which points it becomes immutable. Next tag: 27 + { # A Step represents a single operation performed as part of Execution. A step can be used to represent the execution of a tool ( for example a test runner execution or an execution of a compiler). Steps can overlap (for instance two steps might have the same start time if some operations are done in parallel). Here is an example, let's consider that we have a continuous build is executing a test runner for each iteration. The workflow would look like: - user creates a Execution with id 1 - user creates a TestExecutionStep with id 100 for Execution 1 - user update TestExecutionStep with id 100 to add a raw xml log + the service parses the xml logs and returns a TestExecutionStep with updated TestResult(s). - user update the status of TestExecutionStep with id 100 to COMPLETE A Step can be updated until its state is set to COMPLETE at which points it becomes immutable. "completionTime": { # A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # The time when the step status was set to complete. This value will be set automatically when state transitions to COMPLETE. - In response: set if the execution state is COMPLETE. - In create/update request: never set "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive. @@ -840,7 +840,7 @@

Method Details

{ # Response message for StepService.List. "nextPageToken": "A String", # A continuation token to resume the query at the next item. If set, indicates that there are more steps to read, by calling list again with this value in the page_token field. "steps": [ # Steps. - { # A Step represents a single operation performed as part of Execution. A step can be used to represent the execution of a tool ( for example a test runner execution or an execution of a compiler). Steps can overlap (for instance two steps might have the same start time if some operations are done in parallel). Here is an example, let's consider that we have a continuous build is executing a test runner for each iteration. The workflow would look like: - user creates a Execution with id 1 - user creates a TestExecutionStep with id 100 for Execution 1 - user update TestExecutionStep with id 100 to add a raw xml log + the service parses the xml logs and returns a TestExecutionStep with updated TestResult(s). - user update the status of TestExecutionStep with id 100 to COMPLETE A Step can be updated until its state is set to COMPLETE at which points it becomes immutable. Next tag: 27 + { # A Step represents a single operation performed as part of Execution. A step can be used to represent the execution of a tool ( for example a test runner execution or an execution of a compiler). Steps can overlap (for instance two steps might have the same start time if some operations are done in parallel). Here is an example, let's consider that we have a continuous build is executing a test runner for each iteration. The workflow would look like: - user creates a Execution with id 1 - user creates a TestExecutionStep with id 100 for Execution 1 - user update TestExecutionStep with id 100 to add a raw xml log + the service parses the xml logs and returns a TestExecutionStep with updated TestResult(s). - user update the status of TestExecutionStep with id 100 to COMPLETE A Step can be updated until its state is set to COMPLETE at which points it becomes immutable. "completionTime": { # A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # The time when the step status was set to complete. This value will be set automatically when state transitions to COMPLETE. - In response: set if the execution state is COMPLETE. - In create/update request: never set "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive. @@ -1048,7 +1048,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # A Step represents a single operation performed as part of Execution. A step can be used to represent the execution of a tool ( for example a test runner execution or an execution of a compiler). Steps can overlap (for instance two steps might have the same start time if some operations are done in parallel). Here is an example, let's consider that we have a continuous build is executing a test runner for each iteration. The workflow would look like: - user creates a Execution with id 1 - user creates a TestExecutionStep with id 100 for Execution 1 - user update TestExecutionStep with id 100 to add a raw xml log + the service parses the xml logs and returns a TestExecutionStep with updated TestResult(s). - user update the status of TestExecutionStep with id 100 to COMPLETE A Step can be updated until its state is set to COMPLETE at which points it becomes immutable. Next tag: 27 +{ # A Step represents a single operation performed as part of Execution. A step can be used to represent the execution of a tool ( for example a test runner execution or an execution of a compiler). Steps can overlap (for instance two steps might have the same start time if some operations are done in parallel). Here is an example, let's consider that we have a continuous build is executing a test runner for each iteration. The workflow would look like: - user creates a Execution with id 1 - user creates a TestExecutionStep with id 100 for Execution 1 - user update TestExecutionStep with id 100 to add a raw xml log + the service parses the xml logs and returns a TestExecutionStep with updated TestResult(s). - user update the status of TestExecutionStep with id 100 to COMPLETE A Step can be updated until its state is set to COMPLETE at which points it becomes immutable. "completionTime": { # A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # The time when the step status was set to complete. This value will be set automatically when state transitions to COMPLETE. - In response: set if the execution state is COMPLETE. - In create/update request: never set "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive. @@ -1236,7 +1236,7 @@

Method Details

Returns: An object of the form: - { # A Step represents a single operation performed as part of Execution. A step can be used to represent the execution of a tool ( for example a test runner execution or an execution of a compiler). Steps can overlap (for instance two steps might have the same start time if some operations are done in parallel). Here is an example, let's consider that we have a continuous build is executing a test runner for each iteration. The workflow would look like: - user creates a Execution with id 1 - user creates a TestExecutionStep with id 100 for Execution 1 - user update TestExecutionStep with id 100 to add a raw xml log + the service parses the xml logs and returns a TestExecutionStep with updated TestResult(s). - user update the status of TestExecutionStep with id 100 to COMPLETE A Step can be updated until its state is set to COMPLETE at which points it becomes immutable. Next tag: 27 + { # A Step represents a single operation performed as part of Execution. A step can be used to represent the execution of a tool ( for example a test runner execution or an execution of a compiler). Steps can overlap (for instance two steps might have the same start time if some operations are done in parallel). Here is an example, let's consider that we have a continuous build is executing a test runner for each iteration. The workflow would look like: - user creates a Execution with id 1 - user creates a TestExecutionStep with id 100 for Execution 1 - user update TestExecutionStep with id 100 to add a raw xml log + the service parses the xml logs and returns a TestExecutionStep with updated TestResult(s). - user update the status of TestExecutionStep with id 100 to COMPLETE A Step can be updated until its state is set to COMPLETE at which points it becomes immutable. "completionTime": { # A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # The time when the step status was set to complete. This value will be set automatically when state transitions to COMPLETE. - In response: set if the execution state is COMPLETE. - In create/update request: never set "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive. @@ -1444,7 +1444,7 @@

Method Details

Returns: An object of the form: - { # A Step represents a single operation performed as part of Execution. A step can be used to represent the execution of a tool ( for example a test runner execution or an execution of a compiler). Steps can overlap (for instance two steps might have the same start time if some operations are done in parallel). Here is an example, let's consider that we have a continuous build is executing a test runner for each iteration. The workflow would look like: - user creates a Execution with id 1 - user creates a TestExecutionStep with id 100 for Execution 1 - user update TestExecutionStep with id 100 to add a raw xml log + the service parses the xml logs and returns a TestExecutionStep with updated TestResult(s). - user update the status of TestExecutionStep with id 100 to COMPLETE A Step can be updated until its state is set to COMPLETE at which points it becomes immutable. Next tag: 27 + { # A Step represents a single operation performed as part of Execution. A step can be used to represent the execution of a tool ( for example a test runner execution or an execution of a compiler). Steps can overlap (for instance two steps might have the same start time if some operations are done in parallel). Here is an example, let's consider that we have a continuous build is executing a test runner for each iteration. The workflow would look like: - user creates a Execution with id 1 - user creates a TestExecutionStep with id 100 for Execution 1 - user update TestExecutionStep with id 100 to add a raw xml log + the service parses the xml logs and returns a TestExecutionStep with updated TestResult(s). - user update the status of TestExecutionStep with id 100 to COMPLETE A Step can be updated until its state is set to COMPLETE at which points it becomes immutable. "completionTime": { # A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # The time when the step status was set to complete. This value will be set automatically when state transitions to COMPLETE. - In response: set if the execution state is COMPLETE. - In create/update request: never set "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive. diff --git a/docs/dyn/workloadmanager_v1.projects.locations.insights.html b/docs/dyn/workloadmanager_v1.projects.locations.insights.html index f441ee59a24..9332b5987be 100644 --- a/docs/dyn/workloadmanager_v1.projects.locations.insights.html +++ b/docs/dyn/workloadmanager_v1.projects.locations.insights.html @@ -108,8 +108,8 @@

Method Details

"relatedResources": [ # A list of resource URIs related to this resource. "A String", ], - "resourceKind": "A String", # ComputeInstance, ComputeDisk, VPC, Bare Metal server, etc. - "resourceType": "A String", # The type of this resource. + "resourceKind": "A String", # Required. ComputeInstance, ComputeDisk, VPC, Bare Metal server, etc. + "resourceType": "A String", # Required. The type of this resource. "resourceUri": "A String", # URI of the resource, includes project, location, and name. "updateTime": "A String", # Unix timestamp of when this resource last had its discovery data updated. }, @@ -125,8 +125,8 @@

Method Details

"relatedResources": [ # A list of resource URIs related to this resource. "A String", ], - "resourceKind": "A String", # ComputeInstance, ComputeDisk, VPC, Bare Metal server, etc. - "resourceType": "A String", # The type of this resource. + "resourceKind": "A String", # Required. ComputeInstance, ComputeDisk, VPC, Bare Metal server, etc. + "resourceType": "A String", # Required. The type of this resource. "resourceUri": "A String", # URI of the resource, includes project, location, and name. "updateTime": "A String", # Unix timestamp of when this resource last had its discovery data updated. }, @@ -155,6 +155,8 @@

Method Details

"sentTime": "A String", # Output only. [Output only] Create time stamp "sqlserverValidation": { # A presentation of SQLServer workload insight. The schema of SqlServer workloads validation related data. # The insights data for the sqlserver workload validation. "agentVersion": "A String", # The agent version collected this data point + "instance": "A String", # Required. The instance_name of the instance that the Insight data comes from. According to https://linter.aip.dev/122/name-suffix: field names should not use the _name suffix unless the field would be ambiguous without it. + "projectId": "A String", # Required. The project_id of the cloud project that the Insight data comes from. "validationDetails": [ # A list of SqlServer validation metrics data. { # Message describing the Sqlserver validation metrics. "details": [ # Required. Details wraps map that represents collected data names and values. diff --git a/googleapiclient/discovery_cache/documents/acceleratedmobilepageurl.v1.json b/googleapiclient/discovery_cache/documents/acceleratedmobilepageurl.v1.json index 71d5571ee25..4a50e3c8c49 100644 --- a/googleapiclient/discovery_cache/documents/acceleratedmobilepageurl.v1.json +++ b/googleapiclient/discovery_cache/documents/acceleratedmobilepageurl.v1.json @@ -115,7 +115,7 @@ } } }, - "revision": "20230703", + "revision": "20230708", "rootUrl": "https://acceleratedmobilepageurl.googleapis.com/", "schemas": { "AmpUrl": { diff --git a/googleapiclient/discovery_cache/documents/acmedns.v1.json b/googleapiclient/discovery_cache/documents/acmedns.v1.json index fcd3c798638..32cd2899a5d 100644 --- a/googleapiclient/discovery_cache/documents/acmedns.v1.json +++ b/googleapiclient/discovery_cache/documents/acmedns.v1.json @@ -146,7 +146,7 @@ } } }, - "revision": "20230703", + "revision": "20230708", "rootUrl": "https://acmedns.googleapis.com/", "schemas": { "AcmeChallengeSet": { diff --git a/googleapiclient/discovery_cache/documents/adexchangebuyer2.v2beta1.json b/googleapiclient/discovery_cache/documents/adexchangebuyer2.v2beta1.json index a9641cd541f..9b3e784ce4f 100644 --- a/googleapiclient/discovery_cache/documents/adexchangebuyer2.v2beta1.json +++ b/googleapiclient/discovery_cache/documents/adexchangebuyer2.v2beta1.json @@ -2568,7 +2568,7 @@ } } }, - "revision": "20230628", + "revision": "20230710", "rootUrl": "https://adexchangebuyer.googleapis.com/", "schemas": { "AbsoluteDateRange": { @@ -3163,6 +3163,7 @@ "type": "array" }, "corrections": { + "deprecated": true, "description": "Output only. Shows any corrections that were applied to this creative.", "items": { "$ref": "Correction" @@ -4234,6 +4235,7 @@ "type": "string" }, "formats": { + "deprecated": true, "description": "Creative formats bidded on or allowed to bid on, can be empty. Although this field is a list, it can only be populated with a single item. A HTTP 400 bad request error will be returned in the response if you specify multiple items.", "items": { "enum": [ @@ -4349,6 +4351,7 @@ "type": "string" }, "detailId": { + "deprecated": true, "description": "Note: this field will be deprecated, use \"detail\" field instead. When \"detail\" field represents an integer value, this field is populated as the same integer value \"detail\" field represents, otherwise this field will be 0. The ID of the detail. The associated value can be looked up in the dictionary file corresponding to the DetailType in the response message.", "format": "int32", "type": "integer" @@ -5079,6 +5082,7 @@ "type": "number" }, "storeUrl": { + "deprecated": true, "description": "The URL to the app store to purchase/download the promoted app.", "type": "string" }, @@ -5471,6 +5475,7 @@ "type": "boolean" }, "isSetupComplete": { + "deprecated": true, "description": "Output only. True, if the buyside inventory setup is complete for this proposal.", "readOnly": true, "type": "boolean" @@ -5785,6 +5790,7 @@ "type": "object" }, "SecurityContext": { + "deprecated": true, "description": "Output only. A security context.", "id": "SecurityContext", "properties": { @@ -5854,6 +5860,7 @@ }, "securityType": { "$ref": "SecurityContext", + "deprecated": true, "description": "Matches impressions for a particular security type." } }, @@ -5875,6 +5882,7 @@ "description": "Disapproval bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method." }, "disapprovalReasons": { + "deprecated": true, "description": "Any disapprovals bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. Deprecated; use disapproval field instead.", "items": { "$ref": "Disapproval" diff --git a/googleapiclient/discovery_cache/documents/admin.directory_v1.json b/googleapiclient/discovery_cache/documents/admin.directory_v1.json index 1f172e5dbf9..c85b1c529f0 100644 --- a/googleapiclient/discovery_cache/documents/admin.directory_v1.json +++ b/googleapiclient/discovery_cache/documents/admin.directory_v1.json @@ -4635,7 +4635,7 @@ } } }, - "revision": "20230626", + "revision": "20230704", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Alias": { diff --git a/googleapiclient/discovery_cache/documents/admob.v1.json b/googleapiclient/discovery_cache/documents/admob.v1.json index 4aae01d9a4b..c395b99cb85 100644 --- a/googleapiclient/discovery_cache/documents/admob.v1.json +++ b/googleapiclient/discovery_cache/documents/admob.v1.json @@ -321,7 +321,7 @@ } } }, - "revision": "20230629", + "revision": "20230710", "rootUrl": "https://admob.googleapis.com/", "schemas": { "AdUnit": { diff --git a/googleapiclient/discovery_cache/documents/admob.v1beta.json b/googleapiclient/discovery_cache/documents/admob.v1beta.json index f8e12e1ff16..1b9e30e9a5d 100644 --- a/googleapiclient/discovery_cache/documents/admob.v1beta.json +++ b/googleapiclient/discovery_cache/documents/admob.v1beta.json @@ -359,7 +359,7 @@ } } }, - "revision": "20230629", + "revision": "20230710", "rootUrl": "https://admob.googleapis.com/", "schemas": { "AdSource": { diff --git a/googleapiclient/discovery_cache/documents/adsense.v2.json b/googleapiclient/discovery_cache/documents/adsense.v2.json index a29577bfdb2..62e28c5cdca 100644 --- a/googleapiclient/discovery_cache/documents/adsense.v2.json +++ b/googleapiclient/discovery_cache/documents/adsense.v2.json @@ -1844,7 +1844,7 @@ } } }, - "revision": "20230704", + "revision": "20230708", "rootUrl": "https://adsense.googleapis.com/", "schemas": { "Account": { diff --git a/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json b/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json index 7448d53f9e4..7beeccaefd4 100644 --- a/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json @@ -21,7 +21,7 @@ "baseUrl": "https://analyticsadmin.googleapis.com/", "batchPath": "batch", "canonicalName": "Google Analytics Admin", - "description": "", + "description": "Manage properties in Google Analytics. Warning: Creating multiple Customer Applications, Accounts, or Projects to simulate or act as a single Customer Application, Account, or Project (respectively) or to circumvent Service-specific usage limits or quotas is a direct violation of Google Cloud Platform Terms of Service as well as Google APIs Terms of Service. These actions can result in immediate termination of your GCP project(s) without any warning.", "discoveryVersion": "v1", "documentationLink": "http://code.google.com/apis/analytics/docs/mgmt/home.html", "fullyEncodeReservedExpansion": true, @@ -4322,7 +4322,7 @@ } } }, - "revision": "20230629", + "revision": "20230708", "rootUrl": "https://analyticsadmin.googleapis.com/", "schemas": { "GoogleAnalyticsAdminV1alphaAccessBetweenFilter": { diff --git a/googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json b/googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json index 8327bc26264..c5601f9ada8 100644 --- a/googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json +++ b/googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json @@ -15,7 +15,7 @@ "baseUrl": "https://analyticsadmin.googleapis.com/", "batchPath": "batch", "canonicalName": "Google Analytics Admin", - "description": "", + "description": "Manage properties in Google Analytics. Warning: Creating multiple Customer Applications, Accounts, or Projects to simulate or act as a single Customer Application, Account, or Project (respectively) or to circumvent Service-specific usage limits or quotas is a direct violation of Google Cloud Platform Terms of Service as well as Google APIs Terms of Service. These actions can result in immediate termination of your GCP project(s) without any warning.", "discoveryVersion": "v1", "documentationLink": "http://code.google.com/apis/analytics/docs/mgmt/home.html", "fullyEncodeReservedExpansion": true, @@ -1594,7 +1594,7 @@ } } }, - "revision": "20230629", + "revision": "20230708", "rootUrl": "https://analyticsadmin.googleapis.com/", "schemas": { "GoogleAnalyticsAdminV1betaAccessBetweenFilter": { diff --git a/googleapiclient/discovery_cache/documents/analyticsdata.v1beta.json b/googleapiclient/discovery_cache/documents/analyticsdata.v1beta.json index 0611a5e420c..a872e3237b5 100644 --- a/googleapiclient/discovery_cache/documents/analyticsdata.v1beta.json +++ b/googleapiclient/discovery_cache/documents/analyticsdata.v1beta.json @@ -313,7 +313,7 @@ } } }, - "revision": "20230627", + "revision": "20230708", "rootUrl": "https://analyticsdata.googleapis.com/", "schemas": { "ActiveMetricRestriction": { diff --git a/googleapiclient/discovery_cache/documents/analyticshub.v1beta1.json b/googleapiclient/discovery_cache/documents/analyticshub.v1beta1.json index 89a4110b133..ecea78277e7 100644 --- a/googleapiclient/discovery_cache/documents/analyticshub.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/analyticshub.v1beta1.json @@ -695,7 +695,7 @@ } } }, - "revision": "20230626", + "revision": "20230703", "rootUrl": "https://analyticshub.googleapis.com/", "schemas": { "AuditConfig": { @@ -1081,6 +1081,10 @@ "description": "Optional. Email or URL of the request access of the listing. Subscribers can use this reference to request access. Max Length: 1000 bytes.", "type": "string" }, + "restrictedExportConfig": { + "$ref": "RestrictedExportConfig", + "description": "Optional. If set, restricted export configuration will be propagated and enforced on the linked dataset." + }, "state": { "description": "Output only. Current state of the listing.", "enum": [ @@ -1187,6 +1191,26 @@ }, "type": "object" }, + "RestrictedExportConfig": { + "description": "Restricted export config, used to configure restricted export on linked dataset.", + "id": "RestrictedExportConfig", + "properties": { + "enabled": { + "description": "Optional. If true, enable restricted export.", + "type": "boolean" + }, + "restrictDirectTableAccess": { + "description": "Output only. If true, restrict direct table access(read api/tabledata.list) on linked table.", + "readOnly": true, + "type": "boolean" + }, + "restrictQueryResult": { + "description": "Optional. If true, restrict export of query result derived from restricted linked dataset table.", + "type": "boolean" + } + }, + "type": "object" + }, "SetIamPolicyRequest": { "description": "Request message for `SetIamPolicy` method.", "id": "SetIamPolicyRequest", diff --git a/googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json b/googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json index 635232218f2..df6eb34632e 100644 --- a/googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json +++ b/googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json @@ -825,7 +825,7 @@ } } }, - "revision": "20230704", + "revision": "20230710", "rootUrl": "https://androiddeviceprovisioning.googleapis.com/", "schemas": { "ClaimDeviceRequest": { diff --git a/googleapiclient/discovery_cache/documents/androidenterprise.v1.json b/googleapiclient/discovery_cache/documents/androidenterprise.v1.json index 69a7e967d24..269187e6d94 100644 --- a/googleapiclient/discovery_cache/documents/androidenterprise.v1.json +++ b/googleapiclient/discovery_cache/documents/androidenterprise.v1.json @@ -2649,7 +2649,7 @@ } } }, - "revision": "20230703", + "revision": "20230708", "rootUrl": "https://androidenterprise.googleapis.com/", "schemas": { "Administrator": { diff --git a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json index 709b0b0ee71..052725496d6 100644 --- a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json @@ -1035,6 +1035,35 @@ } } }, + "provisioningInfo": { + "methods": { + "get": { + "description": "Get the device provisioning info by the identifier provided via the sign-in url.", + "flatPath": "v1/provisioningInfo/{provisioningInfoId}", + "httpMethod": "GET", + "id": "androidmanagement.provisioningInfo.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The identifier that Android Device Policy passes to the 3P sign-in page in the form of provisioningInfo/{provisioning_info}.", + "location": "path", + "pattern": "^provisioningInfo/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "ProvisioningInfo" + }, + "scopes": [ + "https://www.googleapis.com/auth/androidmanagement" + ] + } + } + }, "signupUrls": { "methods": { "create": { @@ -1066,7 +1095,7 @@ } } }, - "revision": "20230628", + "revision": "20230705", "rootUrl": "https://androidmanagement.googleapis.com/", "schemas": { "AdbShellCommandEvent": { @@ -1174,6 +1203,7 @@ "type": "object" }, "ApiLevelCondition": { + "deprecated": true, "description": "A compliance rule condition which is satisfied if the Android Framework API level on the device doesn't meet a minimum requirement. There can only be one rule with this type of condition per policy.", "id": "ApiLevelCondition", "properties": { @@ -1634,6 +1664,7 @@ "type": "string" }, "lockTaskAllowed": { + "deprecated": true, "description": "Whether the app is allowed to lock itself in full-screen mode. DEPRECATED. Use InstallType KIOSK or kioskCustomLauncherEnabled to configure a dedicated device.", "type": "boolean" }, @@ -2059,6 +2090,7 @@ "type": "object" }, "ComplianceRule": { + "deprecated": true, "description": "A rule declaring which mitigating actions to take when a device is not compliant with its policy. For every rule, there is always an implicit mitigating action to set policy_compliant to false for the Device resource, and display a message on the device indicating that the device is not compliant with its policy. Other mitigating actions may optionally be taken as well, depending on the field values in the rule.", "id": "ComplianceRule", "properties": { @@ -2353,6 +2385,7 @@ "type": "array" }, "lastPolicyComplianceReportTime": { + "deprecated": true, "description": "Deprecated.", "format": "google-datetime", "type": "string" @@ -2783,6 +2816,7 @@ "id": "Enterprise", "properties": { "appAutoApprovalEnabled": { + "deprecated": true, "description": "Deprecated and unused.", "type": "boolean" }, @@ -2801,6 +2835,14 @@ "COMMAND", "USAGE_LOGS" ], + "enumDeprecated": [ + false, + false, + true, + false, + false, + false + ], "enumDescriptions": [ "This value is ignored.", "A notification sent when a device enrolls.", @@ -3644,6 +3686,7 @@ "type": "string" }, "networkOperatorName": { + "deprecated": true, "description": "Alphabetic name of current registered operator. For example, Vodafone.", "type": "string" }, @@ -3773,6 +3816,7 @@ "type": "object" }, "NonComplianceDetailCondition": { + "deprecated": true, "description": "A compliance rule condition which is satisfied if there exists any matching NonComplianceDetail for the device. A NonComplianceDetail matches a NonComplianceDetailCondition if all the fields which are set within the NonComplianceDetailCondition match the corresponding NonComplianceDetail fields.", "id": "NonComplianceDetailCondition", "properties": { @@ -4229,6 +4273,12 @@ "BLOCKLIST", "ALLOWLIST" ], + "enumDeprecated": [ + false, + true, + false, + false + ], "enumDescriptions": [ "Unspecified. Defaults to BLOCKLIST.", "All Play Store apps are available for installation in the personal profile, except those whose installType is BLOCKED in personalApplications.", @@ -4328,10 +4378,12 @@ "type": "string" }, "autoTimeRequired": { + "deprecated": true, "description": "Whether auto time is required, which prevents the user from manually setting the date and time. If autoDateAndTimeZone is set, this field is ignored.", "type": "boolean" }, "blockApplicationsEnabled": { + "deprecated": true, "description": "Whether applications other than the ones configured in applications are blocked from being installed. When set, applications that were installed under a previous policy but no longer appear in the policy are automatically uninstalled.", "type": "boolean" }, @@ -4364,6 +4416,7 @@ "type": "string" }, "cameraDisabled": { + "deprecated": true, "description": "If camera_access is set to any value other than CAMERA_ACCESS_UNSPECIFIED, this has no effect. Otherwise this field controls whether cameras are disabled: If true, all cameras are disabled, otherwise they are available. For fully managed devices this field applies for all apps on the device. For work profiles, this field applies only to apps in the work profile, and the camera access of apps outside the work profile is unaffected.", "type": "boolean" }, @@ -4379,6 +4432,7 @@ "type": "array" }, "complianceRules": { + "deprecated": true, "description": "Rules declaring which mitigating actions to take when a device is not compliant with its policy. When the conditions for multiple rules are satisfied, all of the mitigating actions for the rules are taken. There is a maximum limit of 100 rules. Use policy enforcement rules instead.", "items": { "$ref": "ComplianceRule" @@ -4402,6 +4456,7 @@ "type": "boolean" }, "debuggingFeaturesAllowed": { + "deprecated": true, "description": "Whether the user is allowed to enable debugging features.", "type": "boolean" }, @@ -4448,6 +4503,7 @@ "type": "string" }, "ensureVerifyAppsEnabled": { + "deprecated": true, "description": "Whether app verification is force-enabled.", "type": "boolean" }, @@ -4471,6 +4527,7 @@ "type": "boolean" }, "installUnknownSourcesAllowed": { + "deprecated": true, "description": "This field has no effect.", "type": "boolean" }, @@ -4531,6 +4588,16 @@ "LOCATION_ENFORCED", "LOCATION_DISABLED" ], + "enumDeprecated": [ + false, + true, + true, + true, + true, + false, + false, + false + ], "enumDescriptions": [ "Defaults to LOCATION_USER_CHOICE.", "On Android 8 and below, all location detection methods are enabled, including GPS, networks, and other sensors. On Android 9 and above, this is equivalent to LOCATION_ENFORCED.", @@ -4629,6 +4696,7 @@ }, "passwordRequirements": { "$ref": "PasswordRequirements", + "deprecated": true, "description": "Password requirements. The field password_requirements.require_password_unlock must not be set. DEPRECATED - Use passwordPolicies.Note:Complexity-based values of PasswordQuality, that is, COMPLEXITY_LOW, COMPLEXITY_MEDIUM, and COMPLEXITY_HIGH, cannot be used here. unified_lock_settings cannot be used here." }, "permissionGrants": { @@ -4705,6 +4773,7 @@ "type": "boolean" }, "safeBootDisabled": { + "deprecated": true, "description": "Whether rebooting the device into safe boot is disabled.", "type": "boolean" }, @@ -4744,6 +4813,7 @@ "type": "boolean" }, "statusBarDisabled": { + "deprecated": true, "description": "Whether the status bar is disabled. This disables notifications, quick settings, and other screen overlays that allow escape from full-screen mode. DEPRECATED. To disable the status bar on a kiosk device, use InstallType KIOSK or kioskCustomLauncherEnabled.", "type": "boolean" }, @@ -4775,6 +4845,7 @@ "description": "The system update policy, which controls how OS updates are applied. If the update type is WINDOWED, the update window will automatically apply to Play app updates as well." }, "tetheringConfigDisabled": { + "deprecated": true, "description": "Whether configuring tethering and portable hotspots is disabled. If tetheringSettings is set to anything other than TETHERING_SETTINGS_UNSPECIFIED, this setting is ignored.", "type": "boolean" }, @@ -4783,6 +4854,7 @@ "type": "boolean" }, "unmuteMicrophoneDisabled": { + "deprecated": true, "description": "If microphone_access is set to any value other than MICROPHONE_ACCESS_UNSPECIFIED, this has no effect. Otherwise this field controls whether microphones are disabled: If true, all microphones are disabled, otherwise they are available. This is available only on fully managed devices.", "type": "boolean" }, @@ -4791,10 +4863,12 @@ "description": "Configuration of device activity logging." }, "usbFileTransferDisabled": { + "deprecated": true, "description": "Whether transferring files over USB is disabled. This is supported only on company-owned devices.", "type": "boolean" }, "usbMassStorageEnabled": { + "deprecated": true, "description": "Whether USB storage is enabled. Deprecated.", "type": "boolean" }, @@ -4808,10 +4882,12 @@ "type": "boolean" }, "wifiConfigDisabled": { + "deprecated": true, "description": "Whether configuring Wi-Fi networks is disabled. Supported on fully managed devices and work profiles on company-owned devices. For fully managed devices, setting this to true removes all configured networks and retains only the networks configured using openNetworkConfiguration. For work profiles on company-owned devices, existing configured networks are not affected and the user is not allowed to add, remove, or modify Wi-Fi networks. If configureWifi is set to anything other than CONFIGURE_WIFI_UNSPECIFIED, this setting is ignored. Note: If a network connection can't be made at boot time and configuring Wi-Fi is disabled then network escape hatch will be shown in order to refresh the device policy (see networkEscapeHatchEnabled).", "type": "boolean" }, "wifiConfigsLockdownEnabled": { + "deprecated": true, "description": "DEPRECATED - Use wifi_config_disabled.", "type": "boolean" } @@ -4908,6 +4984,66 @@ }, "type": "object" }, + "ProvisioningInfo": { + "description": "Information about a device that is available during setup.", + "id": "ProvisioningInfo", + "properties": { + "apiLevel": { + "description": "The API level of the Android platform version running on the device.", + "format": "int32", + "type": "integer" + }, + "authenticatedUserEmail": { + "description": "The email address of the authenticated user (only present for Google Account provisioning method).", + "type": "string" + }, + "brand": { + "description": "Brand of the device. For example, Google.", + "type": "string" + }, + "enterprise": { + "description": "The name of the enterprise in the form enterprises/{enterprise}.", + "type": "string" + }, + "managementMode": { + "description": "The management mode of the device or profile.", + "enum": [ + "MANAGEMENT_MODE_UNSPECIFIED", + "DEVICE_OWNER", + "PROFILE_OWNER" + ], + "enumDescriptions": [ + "This value is disallowed.", + "Device owner. Android Device Policy has full control over the device.", + "Profile owner. Android Device Policy has control over a managed profile on the device." + ], + "type": "string" + }, + "model": { + "description": "The model of the device. For example, Asus Nexus 7.", + "type": "string" + }, + "name": { + "description": "The name of this resource in the form provisioningInfo/{provisioning_info}.", + "type": "string" + }, + "ownership": { + "description": "Ownership of the managed device.", + "enum": [ + "OWNERSHIP_UNSPECIFIED", + "COMPANY_OWNED", + "PERSONALLY_OWNED" + ], + "enumDescriptions": [ + "Ownership is unspecified.", + "Device is company-owned.", + "Device is personally-owned." + ], + "type": "string" + } + }, + "type": "object" + }, "ProxyInfo": { "description": "Configuration info for an HTTP proxy. For a direct proxy, set the host, port, and excluded_hosts fields. For a PAC script proxy, set the pac_uri field.", "id": "ProxyInfo", @@ -5654,6 +5790,7 @@ "type": "string" }, "permissions": { + "deprecated": true, "description": "Permissions available to an admin in the embedded UI. An admin must have all of these permissions in order to view the UI. This field is deprecated.", "items": { "enum": [ diff --git a/googleapiclient/discovery_cache/documents/androidpublisher.v3.json b/googleapiclient/discovery_cache/documents/androidpublisher.v3.json index 9c6a20c152d..7c3f7875a89 100644 --- a/googleapiclient/discovery_cache/documents/androidpublisher.v3.json +++ b/googleapiclient/discovery_cache/documents/androidpublisher.v3.json @@ -4047,7 +4047,7 @@ } } }, - "revision": "20230704", + "revision": "20230711", "rootUrl": "https://androidpublisher.googleapis.com/", "schemas": { "Abi": { diff --git a/googleapiclient/discovery_cache/documents/apigee.v1.json b/googleapiclient/discovery_cache/documents/apigee.v1.json index 440294ef642..340cef39122 100644 --- a/googleapiclient/discovery_cache/documents/apigee.v1.json +++ b/googleapiclient/discovery_cache/documents/apigee.v1.json @@ -9242,7 +9242,7 @@ } } }, - "revision": "20230627", + "revision": "20230707", "rootUrl": "https://apigee.googleapis.com/", "schemas": { "EdgeConfigstoreBundleBadBundle": { @@ -13737,6 +13737,10 @@ "description": "Description of the Apigee organization.", "type": "string" }, + "disableVpcPeering": { + "description": "Optional. Flag that specifies whether the VPC Peering through Private Google Access should be disabled between the consumer network and Apigee. Valid only when RuntimeType is set to CLOUD. Required if an authorizedNetwork on the consumer project is not provided, in which case the flag should be set to true. The value must be set before the creation of any Apigee runtime instance and can be updated only when there are no runtime instances. **Note:** Apigee will be deprecating the vpc peering model that requires you to provide 'authorizedNetwork', by making the non-peering model as the default way of provisioning Apigee organization in future. So, this will be a temporary flag to enable the transition. Not supported for Apigee hybrid.", + "type": "boolean" + }, "displayName": { "description": "Display name for the Apigee organization. Unused, but reserved for future use.", "type": "string" @@ -13982,6 +13986,10 @@ "description": "Compute Engine network used for Service Networking to be peered with Apigee runtime instances. See [Getting started with the Service Networking API](https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started). Apigee also supports shared VPC (that is, the host network project is not the same as the one that is peering with Apigee). See [Shared VPC overview](https://cloud.google.com/vpc/docs/shared-vpc). To use a shared VPC network, use the following format: `projects/{host-project-id}/{region}/networks/{network-name}`. For example: `projects/my-sharedvpc-host/global/networks/mynetwork`", "type": "string" }, + "disableVpcPeering": { + "description": "Optional. Flag that specifies whether the VPC Peering through Private Google Access should be disabled between the consumer network and Apigee. Required if an authorizedNetwork on the consumer project is not provided, in which case the flag should be set to true. The value must be set before the creation of any Apigee runtime instance and can be updated only when there are no runtime instances. **Note:** Apigee will be deprecating the vpc peering model that requires you to provide 'authorizedNetwork', by making the non-peering model as the default way of provisioning Apigee organization in future. So, this will be a temporary flag to enable the transition. Not supported for Apigee hybrid.", + "type": "boolean" + }, "runtimeLocation": { "description": "Cloud Platform location for the runtime instance. Defaults to zone `us-west1-a`. If a region is provided, `EVAL` organizations will use the region for automatically selecting a zone for the runtime instance.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/apikeys.v2.json b/googleapiclient/discovery_cache/documents/apikeys.v2.json index 40e0daf2576..dbe48618c71 100644 --- a/googleapiclient/discovery_cache/documents/apikeys.v2.json +++ b/googleapiclient/discovery_cache/documents/apikeys.v2.json @@ -396,7 +396,7 @@ } } }, - "revision": "20230627", + "revision": "20230708", "rootUrl": "https://apikeys.googleapis.com/", "schemas": { "Operation": { diff --git a/googleapiclient/discovery_cache/documents/area120tables.v1alpha1.json b/googleapiclient/discovery_cache/documents/area120tables.v1alpha1.json index a6c1eda42d7..43417e15ee3 100644 --- a/googleapiclient/discovery_cache/documents/area120tables.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/area120tables.v1alpha1.json @@ -586,7 +586,7 @@ } } }, - "revision": "20230703", + "revision": "20230708", "rootUrl": "https://area120tables.googleapis.com/", "schemas": { "BatchCreateRowsRequest": { diff --git a/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json b/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json index 27723246f6a..76b526682e6 100644 --- a/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json +++ b/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json @@ -519,7 +519,7 @@ } } }, - "revision": "20230623", + "revision": "20230630", "rootUrl": "https://assuredworkloads.googleapis.com/", "schemas": { "GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest": { @@ -798,14 +798,16 @@ "REMEDIATION_BOOLEAN_ORG_POLICY_VIOLATION", "REMEDIATION_LIST_ALLOWED_VALUES_ORG_POLICY_VIOLATION", "REMEDIATION_LIST_DENIED_VALUES_ORG_POLICY_VIOLATION", - "REMEDIATION_RESTRICT_CMEK_CRYPTO_KEY_PROJECTS_ORG_POLICY_VIOLATION" + "REMEDIATION_RESTRICT_CMEK_CRYPTO_KEY_PROJECTS_ORG_POLICY_VIOLATION", + "REMEDIATION_RESOURCE_VIOLATION" ], "enumDescriptions": [ "Unspecified remediation type", "Remediation type for boolean org policy", "Remediation type for list org policy which have allowed values in the monitoring rule", "Remediation type for list org policy which have denied values in the monitoring rule", - "Remediation type for gcp.restrictCmekCryptoKeyProjects" + "Remediation type for gcp.restrictCmekCryptoKeyProjects", + "Remediation type for resource violation." ], "readOnly": true, "type": "string" diff --git a/googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json b/googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json index 493bdc3d9b3..97898f4002c 100644 --- a/googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json @@ -595,7 +595,7 @@ } } }, - "revision": "20230623", + "revision": "20230630", "rootUrl": "https://assuredworkloads.googleapis.com/", "schemas": { "GoogleCloudAssuredworkloadsV1beta1AcknowledgeViolationRequest": { @@ -875,14 +875,16 @@ "REMEDIATION_BOOLEAN_ORG_POLICY_VIOLATION", "REMEDIATION_LIST_ALLOWED_VALUES_ORG_POLICY_VIOLATION", "REMEDIATION_LIST_DENIED_VALUES_ORG_POLICY_VIOLATION", - "REMEDIATION_RESTRICT_CMEK_CRYPTO_KEY_PROJECTS_ORG_POLICY_VIOLATION" + "REMEDIATION_RESTRICT_CMEK_CRYPTO_KEY_PROJECTS_ORG_POLICY_VIOLATION", + "REMEDIATION_RESOURCE_VIOLATION" ], "enumDescriptions": [ "Unspecified remediation type", "Remediation type for boolean org policy", "Remediation type for list org policy which have allowed values in the monitoring rule", "Remediation type for list org policy which have denied values in the monitoring rule", - "Remediation type for gcp.restrictCmekCryptoKeyProjects" + "Remediation type for gcp.restrictCmekCryptoKeyProjects", + "Remediation type for resource violation." ], "readOnly": true, "type": "string" diff --git a/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json b/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json index 87e144feec7..e1bf899524f 100644 --- a/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json +++ b/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json @@ -1307,7 +1307,7 @@ } } }, - "revision": "20230628", + "revision": "20230710", "rootUrl": "https://authorizedbuyersmarketplace.googleapis.com/", "schemas": { "AcceptProposalRequest": { diff --git a/googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json b/googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json index 306c79bba26..596b7db73a9 100644 --- a/googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json +++ b/googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json @@ -1342,7 +1342,7 @@ } } }, - "revision": "20230625", + "revision": "20230701", "rootUrl": "https://bigquerydatatransfer.googleapis.com/", "schemas": { "CheckValidCredsRequest": { @@ -1458,10 +1458,12 @@ "type": "boolean" }, "supportsMultipleTransfers": { + "deprecated": true, "description": "Deprecated. This field has no effect.", "type": "boolean" }, "transferType": { + "deprecated": true, "description": "Deprecated. This field has no effect.", "enum": [ "TRANSFER_TYPE_UNSPECIFIED", diff --git a/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json b/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json index 84ebb2dcd57..aa6149de9b8 100644 --- a/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json +++ b/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json @@ -824,7 +824,7 @@ } } }, - "revision": "20230701", + "revision": "20230706", "rootUrl": "https://bigqueryreservation.googleapis.com/", "schemas": { "Assignment": { diff --git a/googleapiclient/discovery_cache/documents/billingbudgets.v1.json b/googleapiclient/discovery_cache/documents/billingbudgets.v1.json index a5c060f1012..0457375b92c 100644 --- a/googleapiclient/discovery_cache/documents/billingbudgets.v1.json +++ b/googleapiclient/discovery_cache/documents/billingbudgets.v1.json @@ -270,7 +270,7 @@ } } }, - "revision": "20230624", + "revision": "20230704", "rootUrl": "https://billingbudgets.googleapis.com/", "schemas": { "GoogleCloudBillingBudgetsV1Budget": { diff --git a/googleapiclient/discovery_cache/documents/billingbudgets.v1beta1.json b/googleapiclient/discovery_cache/documents/billingbudgets.v1beta1.json index a178e3e1acd..c4a8f369063 100644 --- a/googleapiclient/discovery_cache/documents/billingbudgets.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/billingbudgets.v1beta1.json @@ -264,7 +264,7 @@ } } }, - "revision": "20230624", + "revision": "20230704", "rootUrl": "https://billingbudgets.googleapis.com/", "schemas": { "GoogleCloudBillingBudgetsV1beta1AllUpdatesRule": { diff --git a/googleapiclient/discovery_cache/documents/binaryauthorization.v1.json b/googleapiclient/discovery_cache/documents/binaryauthorization.v1.json index 63770b04eb1..1a036628b1e 100644 --- a/googleapiclient/discovery_cache/documents/binaryauthorization.v1.json +++ b/googleapiclient/discovery_cache/documents/binaryauthorization.v1.json @@ -551,7 +551,7 @@ } } }, - "revision": "20230620", + "revision": "20230630", "rootUrl": "https://binaryauthorization.googleapis.com/", "schemas": { "AdmissionRule": { diff --git a/googleapiclient/discovery_cache/documents/binaryauthorization.v1beta1.json b/googleapiclient/discovery_cache/documents/binaryauthorization.v1beta1.json index 713d940197c..7eb0693c3c5 100644 --- a/googleapiclient/discovery_cache/documents/binaryauthorization.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/binaryauthorization.v1beta1.json @@ -551,7 +551,7 @@ } } }, - "revision": "20230620", + "revision": "20230630", "rootUrl": "https://binaryauthorization.googleapis.com/", "schemas": { "AdmissionRule": { diff --git a/googleapiclient/discovery_cache/documents/blockchainnodeengine.v1.json b/googleapiclient/discovery_cache/documents/blockchainnodeengine.v1.json index a7166892eb2..0df60780dcd 100644 --- a/googleapiclient/discovery_cache/documents/blockchainnodeengine.v1.json +++ b/googleapiclient/discovery_cache/documents/blockchainnodeengine.v1.json @@ -487,7 +487,7 @@ } } }, - "revision": "20230621", + "revision": "20230705", "rootUrl": "https://blockchainnodeengine.googleapis.com/", "schemas": { "BlockchainNode": { diff --git a/googleapiclient/discovery_cache/documents/blogger.v2.json b/googleapiclient/discovery_cache/documents/blogger.v2.json index 8452f14c786..d2f016f7219 100644 --- a/googleapiclient/discovery_cache/documents/blogger.v2.json +++ b/googleapiclient/discovery_cache/documents/blogger.v2.json @@ -401,7 +401,7 @@ } } }, - "revision": "20230704", + "revision": "20230708", "rootUrl": "https://blogger.googleapis.com/", "schemas": { "Blog": { diff --git a/googleapiclient/discovery_cache/documents/blogger.v3.json b/googleapiclient/discovery_cache/documents/blogger.v3.json index 6b5d717247f..329318541b8 100644 --- a/googleapiclient/discovery_cache/documents/blogger.v3.json +++ b/googleapiclient/discovery_cache/documents/blogger.v3.json @@ -1710,7 +1710,7 @@ } } }, - "revision": "20230704", + "revision": "20230708", "rootUrl": "https://blogger.googleapis.com/", "schemas": { "Blog": { diff --git a/googleapiclient/discovery_cache/documents/books.v1.json b/googleapiclient/discovery_cache/documents/books.v1.json index db94d7f1423..ba366570df4 100644 --- a/googleapiclient/discovery_cache/documents/books.v1.json +++ b/googleapiclient/discovery_cache/documents/books.v1.json @@ -2672,7 +2672,7 @@ } } }, - "revision": "20230622", + "revision": "20230629", "rootUrl": "https://books.googleapis.com/", "schemas": { "Annotation": { diff --git a/googleapiclient/discovery_cache/documents/businessprofileperformance.v1.json b/googleapiclient/discovery_cache/documents/businessprofileperformance.v1.json index 5a66e9e0a43..c908eb2693a 100644 --- a/googleapiclient/discovery_cache/documents/businessprofileperformance.v1.json +++ b/googleapiclient/discovery_cache/documents/businessprofileperformance.v1.json @@ -417,7 +417,7 @@ } } }, - "revision": "20230703", + "revision": "20230708", "rootUrl": "https://businessprofileperformance.googleapis.com/", "schemas": { "DailyMetricTimeSeries": { diff --git a/googleapiclient/discovery_cache/documents/calendar.v3.json b/googleapiclient/discovery_cache/documents/calendar.v3.json index 0c084378a4b..73b02525153 100644 --- a/googleapiclient/discovery_cache/documents/calendar.v3.json +++ b/googleapiclient/discovery_cache/documents/calendar.v3.json @@ -1735,7 +1735,7 @@ } } }, - "revision": "20230623", + "revision": "20230630", "rootUrl": "https://www.googleapis.com/", "schemas": { "Acl": { diff --git a/googleapiclient/discovery_cache/documents/certificatemanager.v1.json b/googleapiclient/discovery_cache/documents/certificatemanager.v1.json index 84ae90b217b..64bd4f42e46 100644 --- a/googleapiclient/discovery_cache/documents/certificatemanager.v1.json +++ b/googleapiclient/discovery_cache/documents/certificatemanager.v1.json @@ -1280,7 +1280,7 @@ } } }, - "revision": "20230619", + "revision": "20230628", "rootUrl": "https://certificatemanager.googleapis.com/", "schemas": { "AuthorizationAttemptInfo": { diff --git a/googleapiclient/discovery_cache/documents/chat.v1.json b/googleapiclient/discovery_cache/documents/chat.v1.json index 482bfd2b5f2..3455b9b7494 100644 --- a/googleapiclient/discovery_cache/documents/chat.v1.json +++ b/googleapiclient/discovery_cache/documents/chat.v1.json @@ -954,7 +954,7 @@ } } }, - "revision": "20230627", + "revision": "20230706", "rootUrl": "https://chat.googleapis.com/", "schemas": { "ActionParameter": { @@ -2041,6 +2041,7 @@ }, "icon": { "$ref": "GoogleAppsCardV1Icon", + "deprecated": true, "description": "Deprecated in favor of `startIcon`." }, "onClick": { @@ -3029,6 +3030,7 @@ "type": "array" }, "cards": { + "deprecated": true, "description": "Deprecated: Use `cards_v2` instead. Rich, formatted, and interactive cards that you can use to display UI elements such as: formatted texts, buttons, and clickable images. Cards are normally displayed below the plain-text body of the message. `cards` and `cards_v2` can have a maximum size of 32 KB.", "items": { "$ref": "Card" @@ -3089,6 +3091,11 @@ "description": "Resource name in the form `spaces/*/messages/*`. Example: `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`", "type": "string" }, + "quotedMessageMetadata": { + "$ref": "QuotedMessageMetadata", + "description": "Output only. Information about a message that's quoted by a Google Chat user in a space. Google Chat users can quote a message to reply to it.", + "readOnly": true + }, "sender": { "$ref": "User", "description": "Output only. The user who created the message. If your Chat app [authenticates as a user](https://developers.google.com/chat/api/guides/auth/users), the output populates the [user](https://developers.google.com/chat/api/reference/rest/v1/User) `name` and `type`.", @@ -3145,6 +3152,24 @@ }, "type": "object" }, + "QuotedMessageMetadata": { + "description": "Information about a quoted message.", + "id": "QuotedMessageMetadata", + "properties": { + "lastUpdateTime": { + "description": "Output only. The timestamp when the quoted message was created or when the quoted message was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. Resource name of the quoted message. Format: `spaces/{space}/messages/{message}`", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "Reaction": { "description": "A reaction to a message.", "id": "Reaction", @@ -3327,11 +3352,13 @@ "type": "string" }, "threaded": { + "deprecated": true, "description": "Output only. Deprecated: Use `spaceThreadingState` instead. Whether messages are threaded in this space.", "readOnly": true, "type": "boolean" }, "type": { + "deprecated": true, "description": "Output only. Deprecated: Use `space_type` instead. The type of a space.", "enum": [ "TYPE_UNSPECIFIED", diff --git a/googleapiclient/discovery_cache/documents/checks.v1alpha.json b/googleapiclient/discovery_cache/documents/checks.v1alpha.json index df77af190a2..5a467bf134b 100644 --- a/googleapiclient/discovery_cache/documents/checks.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/checks.v1alpha.json @@ -162,7 +162,7 @@ } } }, - "revision": "20230703", + "revision": "20230708", "rootUrl": "https://checks.googleapis.com/", "schemas": { "AnalyzePrivacyPolicyRequest": { diff --git a/googleapiclient/discovery_cache/documents/chromemanagement.v1.json b/googleapiclient/discovery_cache/documents/chromemanagement.v1.json index 0e4949c248a..37d38b6ae15 100644 --- a/googleapiclient/discovery_cache/documents/chromemanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/chromemanagement.v1.json @@ -794,7 +794,7 @@ } } }, - "revision": "20230629", + "revision": "20230708", "rootUrl": "https://chromemanagement.googleapis.com/", "schemas": { "GoogleChromeManagementV1AndroidAppInfo": { diff --git a/googleapiclient/discovery_cache/documents/chromepolicy.v1.json b/googleapiclient/discovery_cache/documents/chromepolicy.v1.json index e3980ee14da..fe0f0c3c0b6 100644 --- a/googleapiclient/discovery_cache/documents/chromepolicy.v1.json +++ b/googleapiclient/discovery_cache/documents/chromepolicy.v1.json @@ -557,7 +557,7 @@ } } }, - "revision": "20230629", + "revision": "20230709", "rootUrl": "https://chromepolicy.googleapis.com/", "schemas": { "ChromeCrosDpanelAutosettingsProtoPolicyApiLifecycle": { @@ -1142,6 +1142,7 @@ "type": "any" }, "description": { + "deprecated": true, "description": "Deprecated. Use name and field_description instead. The description for the field.", "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/chromeuxreport.v1.json b/googleapiclient/discovery_cache/documents/chromeuxreport.v1.json index d7241e801f6..420af8b4403 100644 --- a/googleapiclient/discovery_cache/documents/chromeuxreport.v1.json +++ b/googleapiclient/discovery_cache/documents/chromeuxreport.v1.json @@ -131,7 +131,7 @@ } } }, - "revision": "20230629", + "revision": "20230705", "rootUrl": "https://chromeuxreport.googleapis.com/", "schemas": { "Bin": { diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json index 4512f2a882b..8329f463a87 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json @@ -167,7 +167,7 @@ } } }, - "revision": "20230626", + "revision": "20230630", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { diff --git a/googleapiclient/discovery_cache/documents/cloudchannel.v1.json b/googleapiclient/discovery_cache/documents/cloudchannel.v1.json index b14112c6a2c..7da1e381344 100644 --- a/googleapiclient/discovery_cache/documents/cloudchannel.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudchannel.v1.json @@ -2178,7 +2178,7 @@ } } }, - "revision": "20230628", + "revision": "20230708", "rootUrl": "https://cloudchannel.googleapis.com/", "schemas": { "GoogleCloudChannelV1ActivateEntitlementRequest": { @@ -4155,7 +4155,7 @@ "type": "string" }, "provisioningId": { - "description": "Output only. Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud, this is the Billing Account ID of the billing subaccount.\"", + "description": "Output only. Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud, this is the Billing Account ID of the billing subaccount.", "readOnly": true, "type": "string" }, @@ -4985,6 +4985,7 @@ "id": "GoogleCloudChannelV1alpha1Entitlement", "properties": { "assignedUnits": { + "deprecated": true, "description": "The current number of users that are assigned a license for the product defined in provisioned_service.skuId. Read-only. Deprecated: Use `parameters` instead.", "format": "int32", "type": "integer" @@ -4998,6 +4999,7 @@ "type": "string" }, "channelPartnerId": { + "deprecated": true, "description": "Cloud Identity ID of a channel partner who will be the direct reseller for the customer's order. This field is generally used in 2-tier ordering, where the order is placed by a top-level distributor on behalf of their channel partner or reseller. Required for distributors. Deprecated: `channel_partner_id` has been moved to the Customer.", "type": "string" }, @@ -5012,6 +5014,7 @@ "type": "string" }, "maxUnits": { + "deprecated": true, "description": "Maximum number of units for a non commitment-based Offer, such as Flexible, Trial or Free entitlements. For commitment-based entitlements, this is a read-only field, which only the internal support team can update. Deprecated: Use `parameters` instead.", "format": "int32", "type": "integer" @@ -5022,6 +5025,7 @@ "type": "string" }, "numUnits": { + "deprecated": true, "description": "Number of units for a commitment-based Offer. For example, for seat-based Offers, this would be the number of seats; for license-based Offers, this would be the number of licenses. Required for creating commitment-based Offers. Deprecated: Use `parameters` instead.", "format": "int32", "type": "integer" @@ -5052,6 +5056,14 @@ "PENDING", "SUSPENDED" ], + "enumDeprecated": [ + false, + false, + true, + true, + true, + false + ], "enumDescriptions": [ "Not used.", "The entitlement is currently active.", @@ -5253,7 +5265,7 @@ "type": "string" }, "provisioningId": { - "description": "Output only. Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud, this is the Billing Account ID of the billing subaccount.\"", + "description": "Output only. Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud, this is the Billing Account ID of the billing subaccount.", "readOnly": true, "type": "string" }, @@ -5270,6 +5282,7 @@ "id": "GoogleCloudChannelV1alpha1RenewalSettings", "properties": { "disableCommitment": { + "deprecated": true, "description": "If true, disables commitment-based offer on renewal and switches to flexible or pay as you go. Deprecated: Use `payment_plan` instead.", "type": "boolean" }, @@ -5282,6 +5295,7 @@ "description": "Describes how frequently the reseller will be billed, such as once per month." }, "paymentOption": { + "deprecated": true, "description": "Set if enable_renewal=true. Deprecated: Use `payment_cycle` instead.", "enum": [ "PAYMENT_OPTION_UNSPECIFIED", diff --git a/googleapiclient/discovery_cache/documents/clouddebugger.v2.json b/googleapiclient/discovery_cache/documents/clouddebugger.v2.json index efe60172c34..8b7d29cd72f 100644 --- a/googleapiclient/discovery_cache/documents/clouddebugger.v2.json +++ b/googleapiclient/discovery_cache/documents/clouddebugger.v2.json @@ -449,7 +449,7 @@ } } }, - "revision": "20230623", + "revision": "20230629", "rootUrl": "https://clouddebugger.googleapis.com/", "schemas": { "AliasContext": { diff --git a/googleapiclient/discovery_cache/documents/cloudfunctions.v1.json b/googleapiclient/discovery_cache/documents/cloudfunctions.v1.json index ef30a3b83ac..39174cd71ea 100644 --- a/googleapiclient/discovery_cache/documents/cloudfunctions.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudfunctions.v1.json @@ -546,7 +546,7 @@ } } }, - "revision": "20230622", + "revision": "20230629", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/cloudfunctions.v2.json b/googleapiclient/discovery_cache/documents/cloudfunctions.v2.json index ca08b229ed3..e977d740c71 100644 --- a/googleapiclient/discovery_cache/documents/cloudfunctions.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudfunctions.v2.json @@ -571,7 +571,7 @@ } } }, - "revision": "20230622", + "revision": "20230629", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/cloudfunctions.v2alpha.json b/googleapiclient/discovery_cache/documents/cloudfunctions.v2alpha.json index 6e37cdec60b..5501019d8ac 100644 --- a/googleapiclient/discovery_cache/documents/cloudfunctions.v2alpha.json +++ b/googleapiclient/discovery_cache/documents/cloudfunctions.v2alpha.json @@ -571,7 +571,7 @@ } } }, - "revision": "20230622", + "revision": "20230629", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/cloudidentity.v1.json b/googleapiclient/discovery_cache/documents/cloudidentity.v1.json index 34499750eef..6c34fbc4962 100644 --- a/googleapiclient/discovery_cache/documents/cloudidentity.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudidentity.v1.json @@ -1990,7 +1990,7 @@ } } }, - "revision": "20230627", + "revision": "20230703", "rootUrl": "https://cloudidentity.googleapis.com/", "schemas": { "AddIdpCredentialOperationMetadata": { @@ -2641,6 +2641,10 @@ "readOnly": true, "type": "string" }, + "hostname": { + "description": "Host name of the device.", + "type": "string" + }, "imei": { "description": "Output only. IMEI number of device if GSM device; empty otherwise.", "readOnly": true, diff --git a/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json b/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json index 53119ba3a56..9f6a6a84db3 100644 --- a/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json @@ -2015,7 +2015,7 @@ } } }, - "revision": "20230627", + "revision": "20230703", "rootUrl": "https://cloudidentity.googleapis.com/", "schemas": { "AddIdpCredentialOperationMetadata": { @@ -3320,6 +3320,10 @@ "readOnly": true, "type": "string" }, + "hostname": { + "description": "Host name of the device.", + "type": "string" + }, "imei": { "description": "Output only. IMEI number of device if GSM device; empty otherwise.", "readOnly": true, diff --git a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1.json b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1.json index 80a03ac1612..c194a5fa3e5 100644 --- a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1.json @@ -1171,7 +1171,7 @@ } } }, - "revision": "20230625", + "revision": "20230709", "rootUrl": "https://cloudresourcemanager.googleapis.com/", "schemas": { "Ancestor": { diff --git a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1beta1.json b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1beta1.json index 8b4da31438b..cde4e815dda 100644 --- a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1beta1.json @@ -568,7 +568,7 @@ } } }, - "revision": "20230625", + "revision": "20230709", "rootUrl": "https://cloudresourcemanager.googleapis.com/", "schemas": { "Ancestor": { diff --git a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2.json b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2.json index 63c00c8f1c0..6918bdd5a0c 100644 --- a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2.json @@ -450,7 +450,7 @@ } } }, - "revision": "20230625", + "revision": "20230709", "rootUrl": "https://cloudresourcemanager.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2beta1.json b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2beta1.json index db7773f1e34..7be23cbc07a 100644 --- a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2beta1.json @@ -450,7 +450,7 @@ } } }, - "revision": "20230625", + "revision": "20230709", "rootUrl": "https://cloudresourcemanager.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v3.json b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v3.json index 344dafd3bba..0cd48dafd13 100644 --- a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v3.json +++ b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v3.json @@ -1582,7 +1582,7 @@ "type": "string" }, "parent": { - "description": "Required.", + "description": "Required. Resource name for the parent of the TagValues to be listed, in the format `tagKeys/123` or `tagValues/123`.", "location": "query", "type": "string" } @@ -1805,7 +1805,7 @@ } } }, - "revision": "20230625", + "revision": "20230709", "rootUrl": "https://cloudresourcemanager.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/cloudscheduler.v1.json b/googleapiclient/discovery_cache/documents/cloudscheduler.v1.json index 6058b76306e..d1ace6bff38 100644 --- a/googleapiclient/discovery_cache/documents/cloudscheduler.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudscheduler.v1.json @@ -418,7 +418,7 @@ } } }, - "revision": "20230612", + "revision": "20230630", "rootUrl": "https://cloudscheduler.googleapis.com/", "schemas": { "AppEngineHttpTarget": { @@ -580,6 +580,7 @@ "lastAttemptTime": { "description": "Output only. The time the last job attempt started.", "format": "google-datetime", + "readOnly": true, "type": "string" }, "name": { @@ -601,6 +602,7 @@ "scheduleTime": { "description": "Output only. The next time the job is scheduled. Note that this may be a retry of a previously failed attempt or the next execution time according to the schedule.", "format": "google-datetime", + "readOnly": true, "type": "string" }, "state": { @@ -619,11 +621,13 @@ "The job is disabled by the system due to error. The user cannot directly set a job to be disabled.", "The job state resulting from a failed CloudScheduler.UpdateJob operation. To recover a job from this state, retry CloudScheduler.UpdateJob until a successful response is received." ], + "readOnly": true, "type": "string" }, "status": { "$ref": "Status", - "description": "Output only. The response from the target for the last attempted execution." + "description": "Output only. The response from the target for the last attempted execution.", + "readOnly": true }, "timeZone": { "description": "Specifies the time zone to be used in interpreting schedule. The value of this field must be a time zone name from the [tz database](http://en.wikipedia.org/wiki/Tz_database). Note that some time zones include a provision for daylight savings time. The rules for daylight saving time are determined by the chosen tz. For UTC use the string \"utc\". If a time zone is not specified, the default will be in UTC (also known as GMT).", @@ -632,6 +636,7 @@ "userUpdateTime": { "description": "Output only. The creation time of the job.", "format": "google-datetime", + "readOnly": true, "type": "string" } }, @@ -751,24 +756,24 @@ "additionalProperties": { "type": "string" }, - "description": "Attributes for this message. If this field is empty, the message must contain non-empty data. This can be used to filter messages on the subscription.", + "description": "Optional. Attributes for this message. If this field is empty, the message must contain non-empty data. This can be used to filter messages on the subscription.", "type": "object" }, "data": { - "description": "The message data field. If this field is empty, the message must contain at least one attribute.", + "description": "Optional. The message data field. If this field is empty, the message must contain at least one attribute.", "format": "byte", "type": "string" }, "messageId": { - "description": "ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a `PubsubMessage` via a `Pull` call or a push delivery. It must not be populated by the publisher in a `Publish` call.", + "description": "Optional. ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a `PubsubMessage` via a `Pull` call or a push delivery. It must not be populated by the publisher in a `Publish` call.", "type": "string" }, "orderingKey": { - "description": "If non-empty, identifies related messages for which publish order should be respected. If a `Subscription` has `enable_message_ordering` set to `true`, messages published with the same non-empty `ordering_key` value will be delivered to subscribers in the order in which they are received by the Pub/Sub system. All `PubsubMessage`s published in a given `PublishRequest` must specify the same `ordering_key` value. For more information, see [ordering messages](https://cloud.google.com/pubsub/docs/ordering).", + "description": "Optional. If non-empty, identifies related messages for which publish order should be respected. If a `Subscription` has `enable_message_ordering` set to `true`, messages published with the same non-empty `ordering_key` value will be delivered to subscribers in the order in which they are received by the Pub/Sub system. All `PubsubMessage`s published in a given `PublishRequest` must specify the same `ordering_key` value. For more information, see [ordering messages](https://cloud.google.com/pubsub/docs/ordering).", "type": "string" }, "publishTime": { - "description": "The time at which the message was published, populated by the server when it receives the `Publish` call. It must not be populated by the publisher in a `Publish` call.", + "description": "Optional. The time at which the message was published, populated by the server when it receives the `Publish` call. It must not be populated by the publisher in a `Publish` call.", "format": "google-datetime", "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/cloudscheduler.v1beta1.json b/googleapiclient/discovery_cache/documents/cloudscheduler.v1beta1.json index be8b7d27793..c2c99cafd7e 100644 --- a/googleapiclient/discovery_cache/documents/cloudscheduler.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudscheduler.v1beta1.json @@ -433,7 +433,7 @@ } } }, - "revision": "20230612", + "revision": "20230630", "rootUrl": "https://cloudscheduler.googleapis.com/", "schemas": { "AppEngineHttpTarget": { @@ -595,6 +595,7 @@ "lastAttemptTime": { "description": "Output only. The time the last job attempt started.", "format": "google-datetime", + "readOnly": true, "type": "string" }, "legacyAppEngineCron": { @@ -620,6 +621,7 @@ "scheduleTime": { "description": "Output only. The next time the job is scheduled. Note that this may be a retry of a previously failed attempt or the next execution time according to the schedule.", "format": "google-datetime", + "readOnly": true, "type": "string" }, "state": { @@ -638,11 +640,13 @@ "The job is disabled by the system due to error. The user cannot directly set a job to be disabled.", "The job state resulting from a failed CloudScheduler.UpdateJob operation. To recover a job from this state, retry CloudScheduler.UpdateJob until a successful response is received." ], + "readOnly": true, "type": "string" }, "status": { "$ref": "Status", - "description": "Output only. The response from the target for the last attempted execution." + "description": "Output only. The response from the target for the last attempted execution.", + "readOnly": true }, "timeZone": { "description": "Specifies the time zone to be used in interpreting schedule. The value of this field must be a time zone name from the [tz database](http://en.wikipedia.org/wiki/Tz_database). Note that some time zones include a provision for daylight savings time. The rules for daylight saving time are determined by the chosen tz. For UTC use the string \"utc\". If a time zone is not specified, the default will be in UTC (also known as GMT).", @@ -651,6 +655,7 @@ "userUpdateTime": { "description": "Output only. The creation time of the job.", "format": "google-datetime", + "readOnly": true, "type": "string" } }, @@ -770,24 +775,24 @@ "additionalProperties": { "type": "string" }, - "description": "Attributes for this message. If this field is empty, the message must contain non-empty data. This can be used to filter messages on the subscription.", + "description": "Optional. Attributes for this message. If this field is empty, the message must contain non-empty data. This can be used to filter messages on the subscription.", "type": "object" }, "data": { - "description": "The message data field. If this field is empty, the message must contain at least one attribute.", + "description": "Optional. The message data field. If this field is empty, the message must contain at least one attribute.", "format": "byte", "type": "string" }, "messageId": { - "description": "ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a `PubsubMessage` via a `Pull` call or a push delivery. It must not be populated by the publisher in a `Publish` call.", + "description": "Optional. ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a `PubsubMessage` via a `Pull` call or a push delivery. It must not be populated by the publisher in a `Publish` call.", "type": "string" }, "orderingKey": { - "description": "If non-empty, identifies related messages for which publish order should be respected. If a `Subscription` has `enable_message_ordering` set to `true`, messages published with the same non-empty `ordering_key` value will be delivered to subscribers in the order in which they are received by the Pub/Sub system. All `PubsubMessage`s published in a given `PublishRequest` must specify the same `ordering_key` value. For more information, see [ordering messages](https://cloud.google.com/pubsub/docs/ordering).", + "description": "Optional. If non-empty, identifies related messages for which publish order should be respected. If a `Subscription` has `enable_message_ordering` set to `true`, messages published with the same non-empty `ordering_key` value will be delivered to subscribers in the order in which they are received by the Pub/Sub system. All `PubsubMessage`s published in a given `PublishRequest` must specify the same `ordering_key` value. For more information, see [ordering messages](https://cloud.google.com/pubsub/docs/ordering).", "type": "string" }, "publishTime": { - "description": "The time at which the message was published, populated by the server when it receives the `Publish` call. It must not be populated by the publisher in a `Publish` call.", + "description": "Optional. The time at which the message was published, populated by the server when it receives the `Publish` call. It must not be populated by the publisher in a `Publish` call.", "format": "google-datetime", "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/cloudsearch.v1.json b/googleapiclient/discovery_cache/documents/cloudsearch.v1.json index a729622c033..39608938704 100644 --- a/googleapiclient/discovery_cache/documents/cloudsearch.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudsearch.v1.json @@ -938,7 +938,7 @@ "query": { "methods": { "removeActivity": { - "description": "Provides functionality to remove logged activity for a user. Currently to be used only for dynamite 1p clients **Note:** This API requires a standard end user account to execute. A service account can't perform Remove Activity requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/).", + "description": "Provides functionality to remove logged activity for a user. Currently to be used only for Chat 1p clients **Note:** This API requires a standard end user account to execute. A service account can't perform Remove Activity requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/).", "flatPath": "v1/query:removeActivity", "httpMethod": "POST", "id": "cloudsearch.query.removeActivity", @@ -1016,7 +1016,7 @@ "type": "boolean" }, "requestOptions.languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For translations. Set this field using the language set in browser or for the page. In the event that the user's language preference is known, set this field to the known user language. When specified, the documents in search results are biased towards the specified language. From Suggest API perspective, for 3p suggest this is used as a hint while making predictions to add language boosting.", + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For translations. Set this field using the language set in browser or for the page. In the event that the user's language preference is known, set this field to the known user language. When specified, the documents in search results are biased towards the specified language. The Suggest API uses this field as a hint to make better third-party autocomplete predictions.", "location": "query", "type": "string" }, @@ -2096,46 +2096,9 @@ } } }, - "revision": "20230621", + "revision": "20230705", "rootUrl": "https://cloudsearch.googleapis.com/", "schemas": { - "AclInfo": { - "description": "Next tag: 4", - "id": "AclInfo", - "properties": { - "groupsCount": { - "description": "Number of groups which have at least read access to the document.", - "format": "int32", - "type": "integer" - }, - "scope": { - "description": "The scope to which the content was shared.", - "enum": [ - "LIMITED", - "DASHER_DOMAIN_WITH_LINK", - "DASHER_DOMAIN", - "PUBLIC_WITH_LINK", - "PUBLIC", - "TEAM_DRIVE" - ], - "enumDescriptions": [ - "Explicit set of people and groups.", - "Anybody at the same domain with the link.", - "Now it works only for google.com. Anybody at the same domain. Now it works only", - "for google.com. Anybody with the link.", - "Anybody.", - "Special tag to indicate TeamDrive scope." - ], - "type": "string" - }, - "usersCount": { - "description": "Number of users which have at least read access to the document.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, "Action": { "id": "Action", "properties": { @@ -2527,7 +2490,7 @@ "type": "object" }, "DataSource": { - "description": "Datasource is a logical namespace for items to be indexed. All items must belong to a datasource. This is the prerequisite before items can be indexed into Cloud Search.", + "description": "Datasource is a logical namespace for items to be indexed. All items must belong to a datasource. This is the prerequisite before items can be indexed into Cloud Search. ", "id": "DataSource", "properties": { "disableModifications": { @@ -3300,6 +3263,39 @@ "PERSON_KNOWLEDGE_CARD", "PEOPLE_SEARCH_PROMOTION_CARD" ], + "enumDeprecated": [ + false, + true, + true, + true, + true, + true, + true, + false, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + false, + false, + false, + false, + false, + true, + true, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "The default type, an unknown card type.", "The user's agenda for the day.", @@ -3337,6 +3333,7 @@ }, "conflictingMeetingsCard": { "$ref": "EnterpriseTopazSidekickConflictingEventsCardProto", + "deprecated": true, "description": "Conflicting events card." }, "documentListCard": { @@ -3345,6 +3342,7 @@ }, "documentsWithMentions": { "$ref": "EnterpriseTopazSidekickDocumentPerCategoryList", + "deprecated": true, "description": "Documents with mentions." }, "findMeetingTimeCard": { @@ -3361,6 +3359,7 @@ }, "meeting": { "$ref": "EnterpriseTopazSidekickAgendaEntry", + "deprecated": true, "description": "Meeting card." }, "meetingNotesCard": { @@ -3389,6 +3388,7 @@ }, "personalizedDocsCard": { "$ref": "EnterpriseTopazSidekickPersonalizedDocsCardProto", + "deprecated": true, "description": "Card with recommended documents for the user." }, "relatedPeopleAnswerCard": { @@ -3397,10 +3397,12 @@ }, "shareMeetingDocsCard": { "$ref": "EnterpriseTopazSidekickShareMeetingDocsCardProto", + "deprecated": true, "description": "Sahre meeting docs card." }, "sharedDocuments": { "$ref": "EnterpriseTopazSidekickDocumentPerCategoryList", + "deprecated": true, "description": "Shared documents." }, "suggestedQueryAnswerCard": { @@ -3545,6 +3547,7 @@ "type": "string" }, "provenance": { + "deprecated": true, "description": "Document provenance.", "enum": [ "UNKNOWN_PROVENANCE", @@ -3563,6 +3566,7 @@ "type": "string" }, "reason": { + "deprecated": true, "description": "Justification of why this document is being returned.", "enum": [ "UNKNOWN", @@ -3686,6 +3690,7 @@ "id": "EnterpriseTopazSidekickCommonDocumentDriveDocumentMetadata", "properties": { "documentId": { + "deprecated": true, "description": "The drive document cosmo id. Client could use the id to build a URL to open a document. Please use Document.document_id.", "type": "string" }, @@ -3833,6 +3838,7 @@ "type": "string" }, "gaiaId": { + "deprecated": true, "description": "This field is deprecated. The obfuscated_id should be used instead.", "format": "int64", "type": "string" @@ -3897,6 +3903,7 @@ "id": "EnterpriseTopazSidekickDocumentGroup", "properties": { "groupType": { + "deprecated": true, "description": "Document group type", "enum": [ "UNKNOWN_TYPE", @@ -3977,6 +3984,18 @@ "SHARED_NOT_VIEWED", "EDITED" ], + "enumDeprecated": [ + false, + true, + false, + true, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "", "", @@ -4263,6 +4282,7 @@ "id": "EnterpriseTopazSidekickPeopleAnswerPersonAnswerCard", "properties": { "answer": { + "deprecated": true, "description": "List of answers.", "items": { "$ref": "SafeHtmlProto" @@ -4424,6 +4444,7 @@ "type": "string" }, "gaiaId": { + "deprecated": true, "description": "Gaia id.", "format": "int64", "type": "string" @@ -5037,118 +5058,6 @@ }, "type": "object" }, - "GoogleDocsMetadata": { - "description": "The corpus specific metadata for office-type documents, from Google Docs and other sources. This message is passed to the scorer and beyond. Next tag: 9", - "id": "GoogleDocsMetadata", - "properties": { - "aclInfo": { - "$ref": "AclInfo", - "description": "Contains number of users and groups which can access the document." - }, - "documentType": { - "description": "The conceptual type (presentation, document, etc.) of this document.", - "enum": [ - "UNKNOWN", - "DOCUMENT", - "PRESENTATION", - "SPREADSHEET", - "PDF", - "IMAGE", - "BINARY_BLOB", - "FUSION_TABLE", - "FOLDER", - "DRAWING", - "VIDEO", - "FORM", - "DRAFT_SITE", - "DRAFT_SITE_PAGE", - "JAM", - "SHORTCUT", - "SCRIPT" - ], - "enumDescriptions": [ - "If the type is unknown or not represented in this enum.", - "Writely, Word, etc.", - "Presently, PowerPoint, etc.", - "Trix, Excel, etc.", - "File types for Gdrive objects are below.", - "", - "Fall-back for unknown Gdrive types.", - "", - "", - "", - "", - "", - "For Atari page and site drafts", - "", - "Jamboard Jams (go/jam)", - "Drive Shortcuts (go/shortcuts)", - "" - ], - "type": "string" - }, - "fileExtension": { - "description": "The file extension of the document. NOTE: As of October 2018 this field is not backfilled for old documents.", - "type": "string" - }, - "lastContentModifiedTimestamp": { - "description": "The last time this document was modified, in seconds since epoch. Only counts content modifications.", - "format": "int64", - "type": "string" - }, - "numSubscribers": { - "description": "Contains number of subscribers for the document.", - "format": "int32", - "type": "integer" - }, - "numViewers": { - "description": "Size of untruncated viewers list.", - "format": "int32", - "type": "integer" - }, - "resultInfo": { - "$ref": "GoogleDocsResultInfo", - "description": "Additional per-result information, akin to Gmail's SingleThreadResponse. Note: GWS no longer seems to use this field, but there's still one reference to it for Scribe, so we can't remove it." - }, - "typeInfo": { - "$ref": "TypeInfo", - "description": "Contains additional information about the document depending on its type." - } - }, - "type": "object" - }, - "GoogleDocsResultInfo": { - "description": "A message containing information about a specific result. This information is passed to the scorer and beyond; in particular, GWS relies on it to format the result in the UI. Split from GoogleDocsMetadata in case we later want to reuse the message.", - "id": "GoogleDocsResultInfo", - "properties": { - "attachmentSha1": { - "description": "The SHA1 hash of the object in Drive, if any.", - "type": "string" - }, - "cosmoId": { - "$ref": "Id", - "description": "The storage identifier for the object in Cosmo. This field is intended to used by Stratus/Moonshine integration only. It should not be exposed externally (please refer to encrypted_id for that purpose)." - }, - "cosmoNameSpace": { - "description": "For Cosmo objects, the Cosmo namespace the object was in. This allows downstream clients to identify whether a document was created in Writely or Kix, Presently or Punch, or whether it was uploaded from GDrive. See storage_cosmo.Id.NAME_SPACE for a list of all Cosmo name spaces.", - "format": "int32", - "type": "integer" - }, - "encryptedId": { - "description": "The encrypted (user-visible) id of this object. Knowing the id is sufficient to create a canonical URL for this document.", - "type": "string" - }, - "mimeType": { - "description": "The mimetype of the document.", - "type": "string" - }, - "shareScope": { - "$ref": "ShareScope", - "description": "The visibility indicator in the UI will be based upon this." - } - }, - "type": "object" - }, "HtmlOperatorOptions": { "description": "Used to provide a search operator for html properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.", "id": "HtmlOperatorOptions", @@ -5189,27 +5098,6 @@ }, "type": "object" }, - "Id": { - "description": "Identifies a particular object, including both Users and DirEntries. This Id is unique across the entire server instance, such as the production or qa instance.", - "id": "Id", - "properties": { - "creatorUserId": { - "description": "The User account in which the DirEntry was originally created. If name_space==GAIA, then it's the gaia_id of the user this id is referring to. This field should really be called the \"bucket ID\", not the creator ID. In some circumstances, such as copying a Google Docs file, a user can create an item in a different user's bucket, so it should not be relied upon for anything other than bucket location. To look up the requesting user who initially created item, use the `creator_id` DirEntry field instead.", - "format": "uint64", - "type": "string" - }, - "localId": { - "description": "The local identifier for the DirEntry (local to the creator's account). local_id + app_name is guaranteed to be unique within the creator account, but not across all User accounts. The string is case sensitive. Ignore if name_space==GAIA. NB For name_space==COSMO, all local_id's should be defined in google3/java/com/google/storage/cosmo/server/api/SpecialObjectIds.java as they have a special predefined meaning. See cosmo.client.CosmoIdFactory.createObjectId(long,String) for IMPORTANT recommendations when generating IDs.", - "type": "string" - }, - "nameSpace": { - "description": "The name space in which this id is unique (typically the application that created it). Values should be drawn from the above enum, but for experimentation, use values greater than 1000.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, "IndexItemOptions": { "id": "IndexItemOptions", "properties": { @@ -6957,7 +6845,7 @@ "description": "Debug options of the request" }, "languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For translations. Set this field using the language set in browser or for the page. In the event that the user's language preference is known, set this field to the known user language. When specified, the documents in search results are biased towards the specified language. From Suggest API perspective, for 3p suggest this is used as a hint while making predictions to add language boosting.", + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For translations. Set this field using the language set in browser or for the page. In the event that the user's language preference is known, set this field to the known user language. When specified, the documents in search results are biased towards the specified language. The Suggest API uses this field as a hint to make better third-party autocomplete predictions.", "type": "string" }, "searchApplicationId": { @@ -7491,36 +7379,6 @@ }, "type": "object" }, - "ShareScope": { - "id": "ShareScope", - "properties": { - "domain": { - "description": "If scope is DOMAIN, this field contains the dasher domain, for example \"google.com\".", - "type": "string" - }, - "scope": { - "description": "The scope to which the content was shared.", - "enum": [ - "UNKNOWN", - "PRIVATE", - "LIMITED", - "EXTENDED", - "DASHER_DOMAIN", - "PUBLIC" - ], - "enumDescriptions": [ - "", - "Only the author can view the post.", - "Viewable only by a set of people.", - "Viewable by extended circles.", - "", - "" - ], - "type": "string" - } - }, - "type": "object" - }, "Snippet": { "description": "Snippet of the search result, which summarizes the content of the resulting page.", "id": "Snippet", @@ -7953,17 +7811,6 @@ }, "type": "object" }, - "TypeInfo": { - "description": "Next tag: 2", - "id": "TypeInfo", - "properties": { - "videoInfo": { - "$ref": "VideoInfo", - "description": "Contains additional video information only if document_type is VIDEO." - } - }, - "type": "object" - }, "UnmappedIdentity": { "id": "UnmappedIdentity", "properties": { @@ -8121,18 +7968,6 @@ } }, "type": "object" - }, - "VideoInfo": { - "description": "Next tag: 2", - "id": "VideoInfo", - "properties": { - "duration": { - "description": "Duration of the video in milliseconds. This field can be absent for recently uploaded video or inaccurate sometimes.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" } }, "servicePath": "", diff --git a/googleapiclient/discovery_cache/documents/cloudsupport.v2.json b/googleapiclient/discovery_cache/documents/cloudsupport.v2.json index 3416a0129aa..a63d0c7a9f7 100644 --- a/googleapiclient/discovery_cache/documents/cloudsupport.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudsupport.v2.json @@ -552,7 +552,7 @@ } } }, - "revision": "20230628", + "revision": "20230708", "rootUrl": "https://cloudsupport.googleapis.com/", "schemas": { "Actor": { @@ -808,6 +808,7 @@ "id": "CompositeMedia", "properties": { "blobRef": { + "deprecated": true, "description": "# gdata.* are outside protos with mising documentation", "format": "byte", "type": "string" @@ -1115,15 +1116,18 @@ "id": "Media", "properties": { "algorithm": { + "deprecated": true, "description": "# gdata.* are outside protos with mising documentation", "type": "string" }, "bigstoreObjectRef": { + "deprecated": true, "description": "# gdata.* are outside protos with mising documentation", "format": "byte", "type": "string" }, "blobRef": { + "deprecated": true, "description": "# gdata.* are outside protos with mising documentation", "format": "byte", "type": "string" @@ -1186,6 +1190,7 @@ "type": "string" }, "hash": { + "deprecated": true, "description": "# gdata.* are outside protos with mising documentation", "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json b/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json index b29375aaba4..9fc15c1efd1 100644 --- a/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json +++ b/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json @@ -548,7 +548,7 @@ } } }, - "revision": "20230628", + "revision": "20230708", "rootUrl": "https://cloudsupport.googleapis.com/", "schemas": { "Actor": { @@ -824,6 +824,7 @@ "id": "CompositeMedia", "properties": { "blobRef": { + "deprecated": true, "description": "# gdata.* are outside protos with mising documentation", "format": "byte", "type": "string" @@ -1131,15 +1132,18 @@ "id": "Media", "properties": { "algorithm": { + "deprecated": true, "description": "# gdata.* are outside protos with mising documentation", "type": "string" }, "bigstoreObjectRef": { + "deprecated": true, "description": "# gdata.* are outside protos with mising documentation", "format": "byte", "type": "string" }, "blobRef": { + "deprecated": true, "description": "# gdata.* are outside protos with mising documentation", "format": "byte", "type": "string" @@ -1202,6 +1206,7 @@ "type": "string" }, "hash": { + "deprecated": true, "description": "# gdata.* are outside protos with mising documentation", "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/compute.beta.json b/googleapiclient/discovery_cache/documents/compute.beta.json index 8872b40e9bb..6617572a909 100644 --- a/googleapiclient/discovery_cache/documents/compute.beta.json +++ b/googleapiclient/discovery_cache/documents/compute.beta.json @@ -7776,6 +7776,227 @@ } } }, + "instanceGroupManagerResizeRequests": { + "methods": { + "delete": { + "description": "Deletes the specified, inactive resize request. Requests that are still active cannot be deleted. Deleting request does not delete instances that were provisioned previously.", + "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}", + "httpMethod": "DELETE", + "id": "compute.instanceGroupManagerResizeRequests.delete", + "parameterOrder": [ + "project", + "zone", + "instanceGroupManager", + "resizeRequest" + ], + "parameters": { + "instanceGroupManager": { + "description": "The name of the managed instance group. The name should conform to RFC1035 or be a resource ID.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "resizeRequest": { + "description": "The name of the resize request to delete. The name should conform to RFC1035 or be a resource ID.", + "location": "path", + "required": true, + "type": "string" + }, + "zone": { + "description": "The name of the zone where the managed instance group is located. The name should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "get": { + "description": "Returns all of the details about the specified resize request.", + "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}", + "httpMethod": "GET", + "id": "compute.instanceGroupManagerResizeRequests.get", + "parameterOrder": [ + "project", + "zone", + "instanceGroupManager", + "resizeRequest" + ], + "parameters": { + "instanceGroupManager": { + "description": "The name of the managed instance group. Name should conform to RFC1035 or be a resource ID.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "resizeRequest": { + "description": "The name of the resize request. Name should conform to RFC1035 or be a resource ID.", + "location": "path", + "required": true, + "type": "string" + }, + "zone": { + "description": "Name of the href=\"/compute/docs/regions-zones/#available\">zone scoping this request. Name should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}", + "response": { + "$ref": "InstanceGroupManagerResizeRequest" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "insert": { + "description": "Creates a new resize request that starts provisioning VMs immediately or queues VM creation.", + "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests", + "httpMethod": "POST", + "id": "compute.instanceGroupManagerResizeRequests.insert", + "parameterOrder": [ + "project", + "zone", + "instanceGroupManager" + ], + "parameters": { + "instanceGroupManager": { + "description": "The name of the managed instance group to which the resize request will be added. Name should conform to RFC1035 or be a resource ID.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "zone": { + "description": "The name of the zone where the managed instance group is located and where the resize request will be created. Name should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests", + "request": { + "$ref": "InstanceGroupManagerResizeRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "list": { + "description": "Retrieves a list of resize requests that are contained in the managed instance group.", + "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests", + "httpMethod": "GET", + "id": "compute.instanceGroupManagerResizeRequests.list", + "parameterOrder": [ + "project", + "zone", + "instanceGroupManager" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.", + "location": "query", + "type": "string" + }, + "instanceGroupManager": { + "description": "The name of the managed instance group. The name should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "location": "query", + "type": "boolean" + }, + "zone": { + "description": "The name of the zone where the managed instance group is located. The name should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests", + "response": { + "$ref": "InstanceGroupManagerResizeRequestsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + } + } + }, "instanceGroupManagers": { "methods": { "abandonInstances": { @@ -13599,6 +13820,41 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, + "getMacsecConfig": { + "description": "Returns the interconnectMacsecConfig for the specified Interconnect.", + "flatPath": "projects/{project}/global/interconnects/{interconnect}/getMacsecConfig", + "httpMethod": "GET", + "id": "compute.interconnects.getMacsecConfig", + "parameterOrder": [ + "project", + "interconnect" + ], + "parameters": { + "interconnect": { + "description": "Name of the interconnect resource to query.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/global/interconnects/{interconnect}/getMacsecConfig", + "response": { + "$ref": "InterconnectsGetMacsecConfigResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, "insert": { "description": "Creates an Interconnect in the specified project using the data included in the request.", "flatPath": "projects/{project}/global/interconnects", @@ -19480,7 +19736,8 @@ ] }, "moveInstance": { - "description": "Moves an instance and its attached persistent disks from one zone to another. *Note*: Moving VMs or disks by using this method might cause unexpected behavior. For more information, see the [known issue](/compute/docs/troubleshooting/known-issues#moving_vms_or_disks_using_the_moveinstance_api_or_the_causes_unexpected_behavior).", + "deprecated": true, + "description": "Moves an instance and its attached persistent disks from one zone to another. *Note*: Moving VMs or disks by using this method might cause unexpected behavior. For more information, see the [known issue](/compute/docs/troubleshooting/known-issues#moving_vms_or_disks_using_the_moveinstance_api_or_the_causes_unexpected_behavior). [Deprecated] This method is deprecated. See [moving instance across zones](/compute/docs/instances/moving-instance-across-zones) instead.", "flatPath": "projects/{project}/moveInstance", "httpMethod": "POST", "id": "compute.projects.moveInstance", @@ -25035,6 +25292,54 @@ }, "regionNetworkEndpointGroups": { "methods": { + "attachNetworkEndpoints": { + "description": "Attach a list of network endpoints to the specified network endpoint group.", + "flatPath": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints", + "httpMethod": "POST", + "id": "compute.regionNetworkEndpointGroups.attachNetworkEndpoints", + "parameterOrder": [ + "project", + "region", + "networkEndpointGroup" + ], + "parameters": { + "networkEndpointGroup": { + "description": "The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "The name of the region where you want to create the network endpoint group. It should comply with RFC1035.", + "location": "path", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints", + "request": { + "$ref": "RegionNetworkEndpointGroupsAttachEndpointsRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "delete": { "description": "Deletes the specified network endpoint group. Note that the NEG cannot be deleted if it is configured as a backend of a backend service.", "flatPath": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}", @@ -25080,6 +25385,54 @@ "https://www.googleapis.com/auth/compute" ] }, + "detachNetworkEndpoints": { + "description": "Detach the network endpoint from the specified network endpoint group.", + "flatPath": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints", + "httpMethod": "POST", + "id": "compute.regionNetworkEndpointGroups.detachNetworkEndpoints", + "parameterOrder": [ + "project", + "region", + "networkEndpointGroup" + ], + "parameters": { + "networkEndpointGroup": { + "description": "The name of the network endpoint group you are detaching network endpoints from. It should comply with RFC1035.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "The name of the region where the network endpoint group is located. It should comply with RFC1035.", + "location": "path", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints", + "request": { + "$ref": "RegionNetworkEndpointGroupsDetachEndpointsRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "get": { "description": "Returns the specified network endpoint group.", "flatPath": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}", @@ -25223,6 +25576,75 @@ "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ] + }, + "listNetworkEndpoints": { + "description": "Lists the network endpoints in the specified network endpoint group.", + "flatPath": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints", + "httpMethod": "POST", + "id": "compute.regionNetworkEndpointGroups.listNetworkEndpoints", + "parameterOrder": [ + "project", + "region", + "networkEndpointGroup" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.", + "location": "query", + "type": "string" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "networkEndpointGroup": { + "description": "The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035.", + "location": "path", + "required": true, + "type": "string" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "The name of the region where the network endpoint group is located. It should comply with RFC1035.", + "location": "path", + "required": true, + "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "location": "query", + "type": "boolean" + } + }, + "path": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints", + "response": { + "$ref": "NetworkEndpointGroupsListNetworkEndpoints" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] } } }, @@ -38097,7 +38519,7 @@ } } }, - "revision": "20230620", + "revision": "20230701", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -38256,6 +38678,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -38378,6 +38830,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -38482,6 +38964,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -38853,6 +39365,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -38975,6 +39517,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -39079,6 +39651,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -39477,6 +40079,10 @@ "description": "Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you specify this field when creating a VM, you can provide either the full or partial URL. For example, the following values are valid: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType If you specify this field when creating or updating an instance template or all-instances configuration, specify the type of the disk, not the URL. For example: pd-standard.", "type": "string" }, + "enableConfidentialCompute": { + "description": "Whether this disk is using confidential compute mode.", + "type": "boolean" + }, "guestOsFeatures": { "description": "A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures", "items": { @@ -39814,6 +40420,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -39936,6 +40572,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -40098,6 +40764,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -40714,6 +41410,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -40956,9 +41682,10 @@ }, "outlierDetection": { "$ref": "OutlierDetection", - "description": "Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. If not set, this feature is considered disabled. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, HTTP2, or GRPC, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. " + "description": "Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service. If not set, this feature is considered disabled. Results of the outlier detection algorithm (ejection of endpoints from the load balancing pool and returning them back to the pool) are executed independently by each proxy instance of the load balancer. In most cases, more than one proxy instance handles the traffic received by a backend service. Thus, it is possible that an unhealthy endpoint is detected and ejected by only some of the proxies, and while this happens, other proxies may continue to send requests to the same unhealthy endpoint until they detect and eject the unhealthy endpoint. Applicable backend endpoints can be: - VM instances in an Instance Group - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT) - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT) - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud Functions Services - Private Service Connect NEGs, that resolve to Google-managed regional API endpoints or managed services published using Private Service Connect Applicable backend service types can be: - A global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. - A regional backend service with the serviceProtocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not supported for Serverless NEGs. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true." }, "port": { + "deprecated": true, "description": "Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port.", "format": "int32", "type": "integer" @@ -41124,6 +41851,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -41467,6 +42224,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -41676,6 +42463,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -42456,6 +43273,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -42578,6 +43425,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -42682,6 +43559,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -43103,6 +44010,10 @@ "$ref": "CustomerEncryptionKey", "description": "Encrypts the disk using a customer-supplied encryption key or a customer-managed encryption key. Encryption keys do not protect access to metadata of the disk. After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later. For example, to create a disk snapshot, to create a disk image, to create a machine image, or to attach the disk to a virtual machine. After you encrypt a disk with a customer-managed key, the diskEncryptionKey.kmsKeyName is set to a key *version* name once the disk is created. The disk is encrypted with this version of the key. In the response, diskEncryptionKey.kmsKeyName appears in the following format: \"diskEncryptionKey.kmsKeyName\": \"projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key /cryptoKeysVersions/version If you do not provide an encryption key when creating the disk, then the disk is encrypted using an automatically generated key and you don't need to provide a key to use the disk later." }, + "enableConfidentialCompute": { + "description": "Whether this disk is using confidential compute mode.", + "type": "boolean" + }, "eraseWindowsVssSignature": { "description": "Specifies whether the disk restored from a source snapshot should erase Windows specific VSS signature.", "type": "boolean" @@ -43120,6 +44031,7 @@ "type": "string" }, "interface": { + "deprecated": true, "description": "[Deprecated] Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI.", "enum": [ "NVME", @@ -43430,6 +44342,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -43624,6 +44566,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -43877,6 +44849,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -43999,6 +45001,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -44103,6 +45135,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -44244,6 +45306,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -44518,6 +45610,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -44758,6 +45880,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -44918,6 +46070,7 @@ "type": "boolean" }, "enableLogging": { + "deprecated": true, "description": "Deprecated in favor of enable in LogConfig. This field denotes whether to enable logging for a particular firewall rule. If logging is enabled, logs will be exported t Cloud Logging.", "type": "boolean" }, @@ -45060,6 +46213,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -45180,6 +46363,7 @@ "type": "string" }, "displayName": { + "deprecated": true, "description": "Deprecated, please use short name instead. User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" @@ -45247,6 +46431,7 @@ "type": "string" }, "displayName": { + "deprecated": true, "description": "[Output Only] Deprecated, please use short name instead. The display name of the firewall policy of the association.", "type": "string" }, @@ -45323,6 +46508,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -45928,127 +47143,187 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], - "enumDescriptions": [ - "Warning about failed cleanup of transient changes made by a failed operation.", - "A link to a deprecated resource was created.", - "When deploying and at least one of the resources has a type marked as deprecated", - "The user created a boot disk that is larger than image size.", - "When deploying and at least one of the resources has a type marked as experimental", - "Warning that is present in an external api call", - "Warning that value of a field has been overridden. Deprecated unused field.", - "The operation involved use of an injected kernel, which is deprecated.", - "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", - "When deploying a deployment with a exceedingly large number of resources", - "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", - "A resource depends on a missing type", - "The route's nextHopIp address is not assigned to an instance on the network.", - "The route's next hop instance cannot ip forward.", - "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", - "The route's nextHopInstance URL refers to an instance that does not exist.", - "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", - "The route's next hop instance does not have a status of RUNNING.", - "Error which is not critical. We decided to continue the process despite the mentioned error.", - "No results are present on a particular list page.", - "Success is reported, but some results may be missing due to errors", - "The user attempted to use a resource that requires a TOS they have not accepted.", - "Warning that a resource is in use.", - "One or more of the resources set to auto-delete could not be deleted because they were in use.", - "When a resource schema validation is ignored.", - "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", - "When undeclared properties in the schema are present", - "A given scope cannot be reached." - ], - "type": "string" - }, - "data": { - "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", - "items": { - "properties": { - "key": { - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", - "type": "string" - }, - "value": { - "description": "[Output Only] A warning data value corresponding to the key.", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - }, - "message": { - "description": "[Output Only] A human-readable description of the warning code.", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "ForwardingRuleList": { - "description": "Contains a list of ForwardingRule resources.", - "id": "ForwardingRuleList", - "properties": { - "id": { - "description": "[Output Only] Unique identifier for the resource; defined by the server.", - "type": "string" - }, - "items": { - "description": "A list of ForwardingRule resources.", - "items": { - "$ref": "ForwardingRule" - }, - "type": "array" - }, - "kind": { - "default": "compute#forwardingRuleList", - "description": "Type of resource.", - "type": "string" - }, - "nextPageToken": { - "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", - "type": "string" - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" - }, - "warning": { - "description": "[Output Only] Informational warning message.", - "properties": { - "code": { - "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", - "enum": [ - "CLEANUP_FAILED", - "DEPRECATED_RESOURCE_USED", - "DEPRECATED_TYPE_USED", - "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", - "EXPERIMENTAL_TYPE_USED", - "EXTERNAL_API_WARNING", - "FIELD_VALUE_OVERRIDEN", - "INJECTED_KERNELS_DEPRECATED", - "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", - "LARGE_DEPLOYMENT_WARNING", - "LIST_OVERHEAD_QUOTA_EXCEED", - "MISSING_TYPE_DEPENDENCY", - "NEXT_HOP_ADDRESS_NOT_ASSIGNED", - "NEXT_HOP_CANNOT_IP_FORWARD", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", - "NEXT_HOP_INSTANCE_NOT_FOUND", - "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", - "NEXT_HOP_NOT_RUNNING", - "NOT_CRITICAL_ERROR", - "NO_RESULTS_ON_PAGE", - "PARTIAL_SUCCESS", - "REQUIRED_TOS_AGREEMENT", - "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", - "RESOURCE_NOT_DELETED", - "SCHEMA_VALIDATION_IGNORED", - "SINGLE_INSTANCE_PROPERTY_TEMPLATE", - "UNDECLARED_PROPERTIES", - "UNREACHABLE" + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "ForwardingRuleList": { + "description": "Contains a list of ForwardingRule resources.", + "id": "ForwardingRuleList", + "properties": { + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "description": "A list of ForwardingRule resources.", + "items": { + "$ref": "ForwardingRule" + }, + "type": "array" + }, + "kind": { + "default": "compute#forwardingRuleList", + "description": "Type of resource.", + "type": "string" + }, + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "warning": { + "description": "[Output Only] Informational warning message.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", @@ -46182,6 +47457,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -46799,6 +48104,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -46916,6 +48251,7 @@ "type": "string" }, "healthStatusAggregationStrategy": { + "deprecated": true, "description": "This field is deprecated. Use health_status_aggregation_policy instead. Policy for how the results from multiple health checks for the same endpoint are aggregated. - NO_AGGREGATION. An EndpointHealth message is returned for each backend in the health check service. - AND. If any backend's health check reports UNHEALTHY, then UNHEALTHY is the HealthState of the entire health check service. If all backend's are healthy, the HealthState of the health check service is HEALTHY. .", "enum": [ "AND", @@ -47039,6 +48375,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -47168,6 +48534,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -47272,6 +48668,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -47790,6 +49216,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -48216,6 +49672,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -48315,6 +49801,10 @@ "format": "int64", "type": "string" }, + "enableConfidentialCompute": { + "description": "Whether this image is created from a confidential compute mode disk. [Output Only]: This field is not set by user, but from source disk.", + "type": "boolean" + }, "family": { "description": "The name of the image family to which this image belongs. The image family name can be from a publicly managed image family provided by Compute Engine, or from a custom image family you create. For example, centos-stream-9 is a publicly available image family. For more information, see Image family best practices. When creating disks, you can specify an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.", "type": "string" @@ -48395,6 +49885,7 @@ "type": "string" }, "sha1Checksum": { + "deprecated": true, "description": "[Deprecated] This field is deprecated. An optional SHA1 checksum of the disk image before unpackaging provided by the client when the disk image is created.", "pattern": "[a-f0-9]{40}", "type": "string" @@ -48575,6 +50066,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -49017,6 +50538,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -49258,127 +50809,187 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], - "enumDescriptions": [ - "Warning about failed cleanup of transient changes made by a failed operation.", - "A link to a deprecated resource was created.", - "When deploying and at least one of the resources has a type marked as deprecated", - "The user created a boot disk that is larger than image size.", - "When deploying and at least one of the resources has a type marked as experimental", - "Warning that is present in an external api call", - "Warning that value of a field has been overridden. Deprecated unused field.", - "The operation involved use of an injected kernel, which is deprecated.", - "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", - "When deploying a deployment with a exceedingly large number of resources", - "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", - "A resource depends on a missing type", - "The route's nextHopIp address is not assigned to an instance on the network.", - "The route's next hop instance cannot ip forward.", - "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", - "The route's nextHopInstance URL refers to an instance that does not exist.", - "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", - "The route's next hop instance does not have a status of RUNNING.", - "Error which is not critical. We decided to continue the process despite the mentioned error.", - "No results are present on a particular list page.", - "Success is reported, but some results may be missing due to errors", - "The user attempted to use a resource that requires a TOS they have not accepted.", - "Warning that a resource is in use.", - "One or more of the resources set to auto-delete could not be deleted because they were in use.", - "When a resource schema validation is ignored.", - "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", - "When undeclared properties in the schema are present", - "A given scope cannot be reached." - ], - "type": "string" - }, - "data": { - "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", - "items": { - "properties": { - "key": { - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", - "type": "string" - }, - "value": { - "description": "[Output Only] A warning data value corresponding to the key.", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - }, - "message": { - "description": "[Output Only] A human-readable description of the warning code.", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "InstanceGroupList": { - "description": "A list of InstanceGroup resources.", - "id": "InstanceGroupList", - "properties": { - "id": { - "description": "[Output Only] Unique identifier for the resource; defined by the server.", - "type": "string" - }, - "items": { - "description": "A list of InstanceGroup resources.", - "items": { - "$ref": "InstanceGroup" - }, - "type": "array" - }, - "kind": { - "default": "compute#instanceGroupList", - "description": "[Output Only] The resource type, which is always compute#instanceGroupList for instance group lists.", - "type": "string" - }, - "nextPageToken": { - "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", - "type": "string" - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" - }, - "warning": { - "description": "[Output Only] Informational warning message.", - "properties": { - "code": { - "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", - "enum": [ - "CLEANUP_FAILED", - "DEPRECATED_RESOURCE_USED", - "DEPRECATED_TYPE_USED", - "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", - "EXPERIMENTAL_TYPE_USED", - "EXTERNAL_API_WARNING", - "FIELD_VALUE_OVERRIDEN", - "INJECTED_KERNELS_DEPRECATED", - "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", - "LARGE_DEPLOYMENT_WARNING", - "LIST_OVERHEAD_QUOTA_EXCEED", - "MISSING_TYPE_DEPENDENCY", - "NEXT_HOP_ADDRESS_NOT_ASSIGNED", - "NEXT_HOP_CANNOT_IP_FORWARD", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", - "NEXT_HOP_INSTANCE_NOT_FOUND", - "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", - "NEXT_HOP_NOT_RUNNING", - "NOT_CRITICAL_ERROR", - "NO_RESULTS_ON_PAGE", - "PARTIAL_SUCCESS", - "REQUIRED_TOS_AGREEMENT", - "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", - "RESOURCE_NOT_DELETED", - "SCHEMA_VALIDATION_IGNORED", - "SINGLE_INSTANCE_PROPERTY_TEMPLATE", - "UNDECLARED_PROPERTIES", - "UNREACHABLE" + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "InstanceGroupList": { + "description": "A list of InstanceGroup resources.", + "id": "InstanceGroupList", + "properties": { + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "description": "A list of InstanceGroup resources.", + "items": { + "$ref": "InstanceGroup" + }, + "type": "array" + }, + "kind": { + "default": "compute#instanceGroupList", + "description": "[Output Only] The resource type, which is always compute#instanceGroupList for instance group lists.", + "type": "string" + }, + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "warning": { + "description": "[Output Only] Informational warning message.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", @@ -49746,6 +51357,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -49836,10 +51477,12 @@ "defaultActionOnFailure": { "description": "The action that a MIG performs on a failed or an unhealthy VM. A VM is marked as unhealthy when the application running on that VM fails a health check. Valid values are - REPAIR (default): MIG automatically repairs a failed or an unhealthy VM by recreating it. For more information, see About repairing VMs in a MIG. - DO_NOTHING: MIG does not repair a failed or an unhealthy VM. ", "enum": [ + "DELETE", "DO_NOTHING", "REPAIR" ], "enumDescriptions": [ + "MIG deletes a failed or an unhealthy VM. Deleting the VM decreases the target size of the MIG.", "MIG does not repair a failed or an unhealthy VM.", "(Default) MIG automatically repairs a failed or an unhealthy VM by recreating it. For more information, see About repairing VMs in a MIG." ], @@ -49923,6 +51566,316 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "InstanceGroupManagerResizeRequest": { + "description": "InstanceGroupManagerResizeRequest represents a request to create a number of VMs: either immediately or by queuing the request for the specified time. This resize request is nested under InstanceGroupManager and the VMs created by this request are added to the owning InstanceGroupManager.", + "id": "InstanceGroupManagerResizeRequest", + "properties": { + "count": { + "description": "The count of instances to create as part of this resize request.", + "format": "int32", + "type": "integer" + }, + "creationTimestamp": { + "description": "[Output Only] The creation timestamp for this resize request in RFC3339 text format.", + "type": "string" + }, + "description": { + "description": "An optional description of this resource.", + "type": "string" + }, + "id": { + "description": "[Output Only] A unique identifier for this resource type. The server generates this identifier.", + "format": "uint64", + "type": "string" + }, + "kind": { + "default": "compute#instanceGroupManagerResizeRequest", + "description": "[Output Only] The resource type, which is always compute#instanceGroupManagerResizeRequest for resize requests.", + "type": "string" + }, + "name": { + "annotations": { + "required": [ + "compute.instanceGroupManagerResizeRequests.insert" + ] + }, + "description": "The name of this resize request. The name must be 1-63 characters long, and comply with RFC1035.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] The URL for this resize request. The server defines this URL.", + "type": "string" + }, + "selfLinkWithId": { + "description": "[Output Only] Server-defined URL for this resource with the resource id.", + "type": "string" + }, + "state": { + "description": "[Output only] Current state of the request.", + "enum": [ + "ACCEPTED", + "CREATING", + "FAILED", + "PROVISIONING", + "SUCCEEDED" + ], + "enumDescriptions": [ + "The request was created successfully and was accepted for provisioning when the capacity becomes available.", + "resize request is being created and may still fail creation.", + "The request failed before or during provisioning. If the request fails during provisioning, any VMs that were created during provisioning are rolled back and removed from the MIG.", + "The target resource(s) are being provisioned.", + "The request succeeded." + ], + "type": "string" + }, + "status": { + "$ref": "InstanceGroupManagerResizeRequestStatus", + "description": "[Output only] Status of the request. The Status message is aligned with QueuedResource.status. ResizeRequest.queuing_policy contains the queuing policy as provided by the user; it could have either valid_until_time or valid_until_duration. ResizeRequest.status.queuing_policy always contains absolute time as calculated by the server when the request is queued." + }, + "zone": { + "description": "[Output Only] The URL of a zone where the resize request is located. Populated only for zonal resize requests.", + "type": "string" + } + }, + "type": "object" + }, + "InstanceGroupManagerResizeRequestStatus": { + "id": "InstanceGroupManagerResizeRequestStatus", + "properties": { + "error": { + "description": "Errors encountered during the queueing or provisioning phases of the ResizeRequest.", + "properties": { + "errors": { + "description": "[Output Only] The array of errors encountered while processing this operation.", + "items": { + "properties": { + "code": { + "description": "[Output Only] The error type identifier for this error.", + "type": "string" + }, + "errorDetails": { + "description": "[Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.", + "items": { + "properties": { + "errorInfo": { + "$ref": "ErrorInfo" + }, + "help": { + "$ref": "Help" + }, + "localizedMessage": { + "$ref": "LocalizedMessage" + }, + "quotaInfo": { + "$ref": "QuotaExceededInfo" + } + }, + "type": "object" + }, + "type": "array" + }, + "location": { + "description": "[Output Only] Indicates the field in the request that caused the error. This property is optional.", + "type": "string" + }, + "message": { + "description": "[Output Only] An optional, human-readable error message.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "InstanceGroupManagerResizeRequestsListResponse": { + "description": "[Output Only] A list of resize requests.", + "id": "InstanceGroupManagerResizeRequestsListResponse", + "properties": { + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "description": "A list of resize request resources.", + "items": { + "$ref": "InstanceGroupManagerResizeRequest" + }, + "type": "array" + }, + "kind": { + "default": "compute#instanceGroupManagerResizeRequestList", + "description": "[Output Only] Type of the resource. Always compute#instanceGroupManagerResizeRequestList for a list of resize requests.", + "type": "string" + }, + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "warning": { + "description": "[Output Only] Informational warning message.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -50030,6 +51983,7 @@ "type": "boolean" }, "isStateful": { + "deprecated": true, "description": "[Output Only] A bit indicating whether the managed instance group has stateful configuration, that is, if you have configured any items in a stateful policy or in per-instance configs. The group might report that it has no stateful configuration even when there is still some preserved state on a managed instance, for example, if you have deleted all PICs but not yet applied those deletions. This field is deprecated in favor of has_stateful_config.", "type": "boolean" }, @@ -50356,6 +52310,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -50502,6 +52486,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -50690,6 +52704,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -50825,6 +52869,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -50965,6 +53039,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -51087,6 +53191,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -51562,6 +53696,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -51684,6 +53848,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -51788,6 +53982,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -51949,6 +54173,7 @@ "id": "InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy", "properties": { "displayName": { + "deprecated": true, "description": "[Output Only] Deprecated, please use short name instead. The display name of the firewall policy.", "type": "string" }, @@ -52080,6 +54305,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -52429,6 +54684,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -52551,6 +54836,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -52666,6 +54981,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -52750,6 +55095,19 @@ "description": "Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true.", "type": "boolean" }, + "availableFeatures": { + "description": "[Output only] List of features available for this Interconnect connection, which can take one of the following values: - MACSEC If present then the interconnect was created on MACsec capable hardware ports. If not present then the interconnect is provisioned on non-MACsec capable ports and MACsec enablement will fail.", + "items": { + "enum": [ + "IF_MACSEC" + ], + "enumDescriptions": [ + "Media Access Control security (MACsec)" + ], + "type": "string" + }, + "type": "array" + }, "circuitInfos": { "description": "[Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG.", "items": { @@ -52843,6 +55201,14 @@ "description": "URL of the InterconnectLocation object that represents where this connection is to be provisioned.", "type": "string" }, + "macsec": { + "$ref": "InterconnectMacsec", + "description": "Configuration to enable Media Access Control security (MACsec) on the Interconnect connection between Google and your on-premises router." + }, + "macsecEnabled": { + "description": "Enable or disable MACsec on this Interconnect connection. MACsec enablement fails if the MACsec object is not specified.", + "type": "boolean" + }, "name": { "annotations": { "required": [ @@ -52882,6 +55248,19 @@ "description": "Indicates that this is a Cross-Cloud Interconnect. This field specifies the location outside of Google's network that the interconnect is connected to.", "type": "string" }, + "requestedFeatures": { + "description": "Optional. List of features requested for this Interconnect connection, which can take one of the following values: - MACSEC If specified then the interconnect will be created on MACsec capable hardware ports. If not specified, the default value is false, which will allocate non-MACsec capable ports first if available. This parameter can only be provided during interconnect INSERT and cannot be changed using interconnect PATCH.", + "items": { + "enum": [ + "IF_MACSEC" + ], + "enumDescriptions": [ + "Media Access Control security (MACsec)" + ], + "type": "string" + }, + "type": "array" + }, "requestedLinkCount": { "description": "Target number of physical links in the link bundle, as requested by the customer.", "format": "int32", @@ -53032,6 +55411,7 @@ "type": "string" }, "googleReferenceId": { + "deprecated": true, "description": "[Output Only] Google reference ID, to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. [Deprecated] This field is not used.", "type": "string" }, @@ -53258,6 +55638,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -53421,6 +55831,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -53556,6 +55996,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -53635,7 +56105,7 @@ "type": "object" }, "InterconnectDiagnostics": { - "description": "Diagnostics information about interconnect, contains detailed and current technical information about Google's side of the connection.", + "description": "Diagnostics information about the Interconnect connection, which contains detailed and current technical information about Google's side of the connection.", "id": "InterconnectDiagnostics", "properties": { "arpCaches": { @@ -53774,6 +56244,10 @@ "lacpStatus": { "$ref": "InterconnectDiagnosticsLinkLACPStatus" }, + "macsec": { + "$ref": "InterconnectDiagnosticsMacsecStatus", + "description": "Describes the status of MACsec encryption on this link." + }, "operationalStatus": { "description": "The operational status of the link.", "enum": [ @@ -53797,6 +56271,21 @@ }, "type": "object" }, + "InterconnectDiagnosticsMacsecStatus": { + "description": "Describes the status of MACsec encryption on the link.", + "id": "InterconnectDiagnosticsMacsecStatus", + "properties": { + "ckn": { + "description": "Indicates the Connectivity Association Key Name (CKN) currently being used if MACsec is operational.", + "type": "string" + }, + "operational": { + "description": "Indicates whether or not MACsec is operational on this link.", + "type": "boolean" + } + }, + "type": "object" + }, "InterconnectList": { "description": "Response to the list request, and contains a list of interconnects.", "id": "InterconnectList", @@ -53860,6 +56349,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -53931,6 +56450,34 @@ "description": "[Output Only] Availability zone for this InterconnectLocation. Within a metropolitan area (metro), maintenance will not be simultaneously scheduled in more than one availability zone. Example: \"zone1\" or \"zone2\".", "type": "string" }, + "availableFeatures": { + "description": "[Output only] List of features available at this InterconnectLocation, which can take one of the following values: - MACSEC ", + "items": { + "enum": [ + "IF_MACSEC" + ], + "enumDescriptions": [ + "Media Access Control security (MACsec)" + ], + "type": "string" + }, + "type": "array" + }, + "availableLinkTypes": { + "description": "[Output only] List of link types available at this InterconnectLocation, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR - LINK_TYPE_ETHERNET_100G_LR ", + "items": { + "enum": [ + "LINK_TYPE_ETHERNET_100G_LR", + "LINK_TYPE_ETHERNET_10G_LR" + ], + "enumDescriptions": [ + "100G Ethernet, LR Optics.", + "10G Ethernet, LR Optics. [(rate_bps) = 10000000000];" + ], + "type": "string" + }, + "type": "array" + }, "city": { "description": "[Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: \"Chicago, IL\", \"Amsterdam, Netherlands\".", "type": "string" @@ -54090,6 +56637,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -54181,6 +56758,76 @@ }, "type": "object" }, + "InterconnectMacsec": { + "description": "Configuration information for enabling Media Access Control security (MACsec) on this Interconnect connection between Google and your on-premises router.", + "id": "InterconnectMacsec", + "properties": { + "failOpen": { + "description": "If set to true, the Interconnect connection is configured with a should-secure MACsec security policy, that allows the Google router to fallback to cleartext traffic if the MKA session cannot be established. By default, the Interconnect connection is configured with a must-secure security policy that drops all traffic if the MKA session cannot be established with your router.", + "type": "boolean" + }, + "preSharedKeys": { + "description": "Required. A keychain placeholder describing a set of named key objects along with their start times. A MACsec CKN/CAK will be generated for each key in the key chain. Google router will automatically pick the key with the most recent startTime when establishing or re-establishing a MACsec secure link.", + "items": { + "$ref": "InterconnectMacsecPreSharedKey" + }, + "type": "array" + } + }, + "type": "object" + }, + "InterconnectMacsecConfig": { + "description": "MACsec configuration information for the Interconnect connection. Contains the generated Connectivity Association Key Name (CKN) and the key (CAK) for this Interconnect connection.", + "id": "InterconnectMacsecConfig", + "properties": { + "preSharedKeys": { + "description": "A keychain placeholder describing a set of named key objects along with their start times. A MACsec CKN/CAK is generated for each key in the key chain. Google router automatically picks the key with the most recent startTime when establishing or re-establishing a MACsec secure link.", + "items": { + "$ref": "InterconnectMacsecConfigPreSharedKey" + }, + "type": "array" + } + }, + "type": "object" + }, + "InterconnectMacsecConfigPreSharedKey": { + "description": "Describes a pre-shared key used to setup MACsec in static connectivity association key (CAK) mode.", + "id": "InterconnectMacsecConfigPreSharedKey", + "properties": { + "cak": { + "description": "An auto-generated Connectivity Association Key (CAK) for this key.", + "type": "string" + }, + "ckn": { + "description": "An auto-generated Connectivity Association Key Name (CKN) for this key.", + "type": "string" + }, + "name": { + "description": "User provided name for this pre-shared key.", + "type": "string" + }, + "startTime": { + "description": "User provided timestamp on or after which this key is valid.", + "type": "string" + } + }, + "type": "object" + }, + "InterconnectMacsecPreSharedKey": { + "description": "Describes a pre-shared key used to setup MACsec in static connectivity association key (CAK) mode.", + "id": "InterconnectMacsecPreSharedKey", + "properties": { + "name": { + "description": "Required. A name for this pre-shared key. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", + "type": "string" + }, + "startTime": { + "description": "A RFC3339 timestamp on or after which the key is valid. startTime can be in the future. If the keychain has a single key, startTime can be omitted. If the keychain has multiple keys, startTime is mandatory for each key. The start times of keys must be in increasing order. The start times of two consecutive keys must be at least 6 hours apart.", + "type": "string" + } + }, + "type": "object" + }, "InterconnectOutageNotification": { "description": "Description of a planned outage on this Interconnect.", "id": "InterconnectOutageNotification", @@ -54494,6 +57141,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -54573,6 +57250,20 @@ }, "type": "object" }, + "InterconnectsGetMacsecConfigResponse": { + "description": "Response for the InterconnectsGetMacsecConfigRequest.", + "id": "InterconnectsGetMacsecConfigResponse", + "properties": { + "etag": { + "description": "end_interface: MixerGetResponseWithEtagBuilder", + "type": "string" + }, + "result": { + "$ref": "InterconnectMacsecConfig" + } + }, + "type": "object" + }, "License": { "description": "Represents a License resource. A License represents billing and aggregate usage data for public and marketplace images. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. ", "id": "License", @@ -54803,6 +57494,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -55231,6 +57952,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -55448,6 +58199,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -55570,6 +58351,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -55674,6 +58485,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -55823,6 +58664,10 @@ "$ref": "ManagedInstanceLastAttempt", "description": "[Output Only] Information about the last attempt to create or delete the instance." }, + "name": { + "description": "[Output Only] The name of the instance. The name will always exist even if the instance has not yet been created.", + "type": "string" + }, "preservedStateFromConfig": { "$ref": "PreservedState", "description": "[Output Only] Preserved state applied from per-instance config for this instance." @@ -56056,6 +58901,7 @@ "id": "Network", "properties": { "IPv4Range": { + "deprecated": true, "description": "Deprecated in favor of subnet mode networks. The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.", "pattern": "[0-9]{1,3}(?:\\.[0-9]{1,3}){3}/[0-9]{1,2}", "type": "string" @@ -56315,6 +59161,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -56481,6 +59357,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -56585,6 +59491,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -56768,6 +59704,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -56872,6 +59838,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -57014,6 +60010,7 @@ }, "loadBalancer": { "$ref": "NetworkEndpointGroupLbNetworkEndpointGroup", + "deprecated": true, "description": "This field is only valid when the network endpoint group is used for load balancing. [Deprecated] This field is deprecated." }, "name": { @@ -57151,6 +60148,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -57268,19 +60295,23 @@ "id": "NetworkEndpointGroupLbNetworkEndpointGroup", "properties": { "defaultPort": { + "deprecated": true, "description": "The default port used if the port number is not specified in the network endpoint. [Deprecated] This field is deprecated.", "format": "int32", "type": "integer" }, "network": { + "deprecated": true, "description": "The URL of the network to which all network endpoints in the NEG belong. Uses \"default\" project network if unspecified. [Deprecated] This field is deprecated.", "type": "string" }, "subnetwork": { + "deprecated": true, "description": "Optional URL of the subnetwork to which all network endpoints in the NEG belong. [Deprecated] This field is deprecated.", "type": "string" }, "zone": { + "deprecated": true, "description": "[Output Only] The URL of the zone where the network endpoint group is located. [Deprecated] This field is deprecated.", "type": "string" } @@ -57349,6 +60380,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -57585,6 +60646,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -57689,6 +60780,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -57938,6 +61059,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -58163,6 +61314,7 @@ "id": "NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy", "properties": { "displayName": { + "deprecated": true, "description": "[Output Only] Deprecated, please use short name instead. The display name of the firewall policy.", "type": "string" }, @@ -58402,6 +61554,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -58556,6 +61738,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -58809,6 +62021,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -58913,6 +62155,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -59167,6 +62439,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -59289,6 +62591,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -59408,6 +62740,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -59598,6 +62960,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -59720,6 +63112,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -59824,6 +63246,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -60015,6 +63467,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -60264,6 +63746,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -60399,6 +63911,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -60521,6 +64063,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -60625,6 +64197,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -60708,54 +64310,54 @@ "properties": { "baseEjectionTime": { "$ref": "Duration", - "description": "The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s." + "description": "The base time that a backend endpoint is ejected for. Defaults to 30000ms or 30s. After a backend endpoint is returned back to the load balancing pool, it can be ejected again in another ejection analysis. Thus, the total ejection time is equal to the base ejection time multiplied by the number of times the backend endpoint has been ejected. Defaults to 30000ms or 30s." }, "consecutiveErrors": { - "description": "Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.", + "description": "Number of consecutive errors before a backend endpoint is ejected from the load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.", "format": "int32", "type": "integer" }, "consecutiveGatewayFailure": { - "description": "The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.", + "description": "The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3.", "format": "int32", "type": "integer" }, "enforcingConsecutiveErrors": { - "description": "The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.", + "description": "The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.", "format": "int32", "type": "integer" }, "enforcingConsecutiveGatewayFailure": { - "description": "The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.", + "description": "The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.", "format": "int32", "type": "integer" }, "enforcingSuccessRate": { - "description": "The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.", + "description": "The percentage chance that a backend endpoint will be ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service uses Serverless NEG.", "format": "int32", "type": "integer" }, "interval": { "$ref": "Duration", - "description": "Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second." + "description": "Time interval between ejection analysis sweeps. This can result in both new ejections and backend endpoints being returned to service. The interval is equal to the number of seconds as defined in outlierDetection.interval.seconds plus the number of nanoseconds as defined in outlierDetection.interval.nanos. Defaults to 1 second." }, "maxEjectionPercent": { - "description": "Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%.", + "description": "Maximum percentage of backend endpoints in the load balancing pool for the backend service that can be ejected if the ejection conditions are met. Defaults to 50%.", "format": "int32", "type": "integer" }, "successRateMinimumHosts": { - "description": "The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5.", + "description": "The number of backend endpoints in the load balancing pool that must have enough request volume to detect success rate outliers. If the number of backend endpoints is fewer than this setting, outlier detection via success rate statistics is not performed for any backend endpoint in the load balancing pool. Defaults to 5. Not supported when the backend service uses Serverless NEG.", "format": "int32", "type": "integer" }, "successRateRequestVolume": { - "description": "The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100.", + "description": "The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this backend endpoint in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that backend endpoint. Defaults to 100. Not supported when the backend service uses Serverless NEG.", "format": "int32", "type": "integer" }, "successRateStdevFactor": { - "description": "This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900.", + "description": "This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * successRateStdevFactor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. Not supported when the backend service uses Serverless NEG.", "format": "int32", "type": "integer" } @@ -60973,6 +64575,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -61143,6 +64775,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -61316,6 +64978,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -61973,6 +65665,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -62212,6 +65934,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -62333,6 +66085,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -62480,6 +66262,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -63063,6 +66875,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -63197,6 +67039,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -63366,6 +67238,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -63502,6 +67404,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -63749,6 +67681,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -63955,6 +67917,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -64118,6 +68110,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -64177,6 +68199,32 @@ }, "type": "object" }, + "RegionNetworkEndpointGroupsAttachEndpointsRequest": { + "id": "RegionNetworkEndpointGroupsAttachEndpointsRequest", + "properties": { + "networkEndpoints": { + "description": "The list of network endpoints to be attached.", + "items": { + "$ref": "NetworkEndpoint" + }, + "type": "array" + } + }, + "type": "object" + }, + "RegionNetworkEndpointGroupsDetachEndpointsRequest": { + "id": "RegionNetworkEndpointGroupsDetachEndpointsRequest", + "properties": { + "networkEndpoints": { + "description": "The list of network endpoints to be detached.", + "items": { + "$ref": "NetworkEndpoint" + }, + "type": "array" + } + }, + "type": "object" + }, "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse": { "id": "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse", "properties": { @@ -64507,6 +68555,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -64628,6 +68706,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -64743,153 +68851,213 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], - "enumDescriptions": [ - "Warning about failed cleanup of transient changes made by a failed operation.", - "A link to a deprecated resource was created.", - "When deploying and at least one of the resources has a type marked as deprecated", - "The user created a boot disk that is larger than image size.", - "When deploying and at least one of the resources has a type marked as experimental", - "Warning that is present in an external api call", - "Warning that value of a field has been overridden. Deprecated unused field.", - "The operation involved use of an injected kernel, which is deprecated.", - "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", - "When deploying a deployment with a exceedingly large number of resources", - "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", - "A resource depends on a missing type", - "The route's nextHopIp address is not assigned to an instance on the network.", - "The route's next hop instance cannot ip forward.", - "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", - "The route's nextHopInstance URL refers to an instance that does not exist.", - "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", - "The route's next hop instance does not have a status of RUNNING.", - "Error which is not critical. We decided to continue the process despite the mentioned error.", - "No results are present on a particular list page.", - "Success is reported, but some results may be missing due to errors", - "The user attempted to use a resource that requires a TOS they have not accepted.", - "Warning that a resource is in use.", - "One or more of the resources set to auto-delete could not be deleted because they were in use.", - "When a resource schema validation is ignored.", - "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", - "When undeclared properties in the schema are present", - "A given scope cannot be reached." - ], - "type": "string" - }, - "data": { - "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", - "items": { - "properties": { - "key": { - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", - "type": "string" - }, - "value": { - "description": "[Output Only] A warning data value corresponding to the key.", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - }, - "message": { - "description": "[Output Only] A human-readable description of the warning code.", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "ResourceCommitment": { - "description": "Commitment for a particular resource (a Commitment is composed of one or more of these).", - "id": "ResourceCommitment", - "properties": { - "acceleratorType": { - "description": "Name of the accelerator type resource. Applicable only when the type is ACCELERATOR.", - "type": "string" - }, - "amount": { - "description": "The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU.", - "format": "int64", - "type": "string" - }, - "type": { - "description": "Type of resource for which this commitment applies. Possible values are VCPU, MEMORY, LOCAL_SSD, and ACCELERATOR.", - "enum": [ - "ACCELERATOR", - "LOCAL_SSD", - "MEMORY", - "UNSPECIFIED", - "VCPU" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "" - ], - "type": "string" - } - }, - "type": "object" - }, - "ResourceGroupReference": { - "id": "ResourceGroupReference", - "properties": { - "group": { - "description": "A URI referencing one of the instance groups or network endpoint groups listed in the backend service.", - "type": "string" - } - }, - "type": "object" - }, - "ResourcePoliciesScopedList": { - "id": "ResourcePoliciesScopedList", - "properties": { - "resourcePolicies": { - "description": "A list of resourcePolicies contained in this scope.", - "items": { - "$ref": "ResourcePolicy" - }, - "type": "array" - }, - "warning": { - "description": "Informational warning which replaces the list of resourcePolicies when the list is empty.", - "properties": { - "code": { - "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", - "enum": [ - "CLEANUP_FAILED", - "DEPRECATED_RESOURCE_USED", - "DEPRECATED_TYPE_USED", - "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", - "EXPERIMENTAL_TYPE_USED", - "EXTERNAL_API_WARNING", - "FIELD_VALUE_OVERRIDEN", - "INJECTED_KERNELS_DEPRECATED", - "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", - "LARGE_DEPLOYMENT_WARNING", - "LIST_OVERHEAD_QUOTA_EXCEED", - "MISSING_TYPE_DEPENDENCY", - "NEXT_HOP_ADDRESS_NOT_ASSIGNED", - "NEXT_HOP_CANNOT_IP_FORWARD", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", - "NEXT_HOP_INSTANCE_NOT_FOUND", - "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", - "NEXT_HOP_NOT_RUNNING", - "NOT_CRITICAL_ERROR", - "NO_RESULTS_ON_PAGE", - "PARTIAL_SUCCESS", - "REQUIRED_TOS_AGREEMENT", - "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", - "RESOURCE_NOT_DELETED", - "SCHEMA_VALIDATION_IGNORED", - "SINGLE_INSTANCE_PROPERTY_TEMPLATE", - "UNDECLARED_PROPERTIES", - "UNREACHABLE" + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "ResourceCommitment": { + "description": "Commitment for a particular resource (a Commitment is composed of one or more of these).", + "id": "ResourceCommitment", + "properties": { + "acceleratorType": { + "description": "Name of the accelerator type resource. Applicable only when the type is ACCELERATOR.", + "type": "string" + }, + "amount": { + "description": "The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU.", + "format": "int64", + "type": "string" + }, + "type": { + "description": "Type of resource for which this commitment applies. Possible values are VCPU, MEMORY, LOCAL_SSD, and ACCELERATOR.", + "enum": [ + "ACCELERATOR", + "LOCAL_SSD", + "MEMORY", + "UNSPECIFIED", + "VCPU" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "ResourceGroupReference": { + "id": "ResourceGroupReference", + "properties": { + "group": { + "description": "A URI referencing one of the instance groups or network endpoint groups listed in the backend service.", + "type": "string" + } + }, + "type": "object" + }, + "ResourcePoliciesScopedList": { + "id": "ResourcePoliciesScopedList", + "properties": { + "resourcePolicies": { + "description": "A list of resourcePolicies contained in this scope.", + "items": { + "$ref": "ResourcePolicy" + }, + "type": "array" + }, + "warning": { + "description": "Informational warning which replaces the list of resourcePolicies when the list is empty.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", @@ -65103,6 +69271,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -65345,6 +69543,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -65800,6 +70028,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -65954,6 +70212,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -66188,6 +70476,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -66591,6 +70909,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -66713,10 +71061,12 @@ "description": "List of NAT-ted endpoint types supported by the Nat Gateway. If the list is empty, then it will be equivalent to include ENDPOINT_TYPE_VM", "items": { "enum": [ + "ENDPOINT_TYPE_MANAGED_PROXY_LB", "ENDPOINT_TYPE_SWG", "ENDPOINT_TYPE_VM" ], "enumDescriptions": [ + "This is used for Regional Internal/External HTTP(S) and TCP Proxy load balancer endpoints.", "This is used for Secure Web Gateway endpoints.", "This is the default." ], @@ -66810,6 +71160,18 @@ "format": "int32", "type": "integer" }, + "type": { + "description": "Indicates whether this NAT is used for public or private IP translation. If unspecified, it defaults to PUBLIC.", + "enum": [ + "PRIVATE", + "PUBLIC" + ], + "enumDescriptions": [ + "NAT used for private IP translation.", + "NAT used for public IP translation. This is the default." + ], + "type": "string" + }, "udpIdleTimeoutSec": { "description": "Timeout (in seconds) for UDP connections. Defaults to 30s if not set.", "format": "int32", @@ -66876,12 +71238,26 @@ }, "type": "array" }, + "sourceNatActiveRanges": { + "description": "A list of URLs of the subnetworks used as source ranges for this NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT. This field is used for private NAT.", + "items": { + "type": "string" + }, + "type": "array" + }, "sourceNatDrainIps": { "description": "A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT rule only. This field is used for public NAT.", "items": { "type": "string" }, "type": "array" + }, + "sourceNatDrainRanges": { + "description": "A list of URLs of subnetworks representing source ranges to be drained. This is only supported on patch/update, and these subnetworks must have previously been used as active ranges in this NAT Rule. This field is used for private NAT.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -67220,6 +71596,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -67802,6 +72208,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -67915,6 +72351,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -68161,6 +72627,40 @@ "" ], "type": "string" + }, + "thresholdConfigs": { + "description": "Configuration options for layer7 adaptive protection for various customizable thresholds.", + "items": { + "$ref": "SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfig" + }, + "type": "array" + } + }, + "type": "object" + }, + "SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfig": { + "id": "SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfig", + "properties": { + "autoDeployConfidenceThreshold": { + "format": "float", + "type": "number" + }, + "autoDeployExpirationSec": { + "format": "int32", + "type": "integer" + }, + "autoDeployImpactedBaselineThreshold": { + "format": "float", + "type": "number" + }, + "autoDeployLoadThreshold": { + "format": "float", + "type": "number" + }, + "name": { + "description": "The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the security policy.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string" } }, "type": "object" @@ -68175,9 +72675,11 @@ "jsonParsing": { "enum": [ "DISABLED", - "STANDARD" + "STANDARD", + "STANDARD_WITH_GRAPHQL" ], "enumDescriptions": [ + "", "", "" ], @@ -68316,6 +72818,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -68815,6 +73347,17 @@ "SNI", "XFF_IP" ], + "enumDeprecated": [ + false, + true, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "", "", @@ -68874,6 +73417,17 @@ "SNI", "XFF_IP" ], + "enumDeprecated": [ + false, + true, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "", "", @@ -68973,6 +73527,7 @@ "id": "SecuritySettings", "properties": { "authentication": { + "deprecated": true, "description": "[Deprecated] Use clientTlsPolicy instead.", "type": "string" }, @@ -69152,6 +73707,7 @@ "type": "array" }, "producerForwardingRule": { + "deprecated": true, "description": "The URL of a forwarding rule with loadBalancingScheme INTERNAL* that is serving the endpoint identified by this service attachment.", "type": "string" }, @@ -69249,6 +73805,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -69425,6 +74011,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -69529,6 +74145,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -69831,6 +74477,10 @@ "format": "int64", "type": "string" }, + "enableConfidentialCompute": { + "description": "Whether this snapshot is created from a confidential compute mode disk. [Output Only]: This field is not set by user, but from source disk.", + "type": "boolean" + }, "guestFlush": { "description": "[Input Only] Whether to attempt an application consistent snapshot by informing the OS to prepare for the snapshot process.", "type": "boolean" @@ -70065,6 +74715,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -70403,6 +75083,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -70525,6 +75235,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -70703,6 +75443,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -70835,6 +75605,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -70956,6 +75756,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -71072,6 +75902,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -71251,6 +76111,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -71498,6 +76388,7 @@ "enum": [ "INTERNAL_HTTPS_LOAD_BALANCER", "PRIVATE", + "PRIVATE_NAT", "PRIVATE_RFC_1918", "PRIVATE_SERVICE_CONNECT", "REGIONAL_MANAGED_PROXY" @@ -71505,6 +76396,7 @@ "enumDescriptions": [ "Subnet reserved for Internal HTTP(S) Load Balancing.", "Regular user created or automatically created subnet.", + "Subnetwork used as source range for Private NAT Gateways.", "Regular user created or automatically created subnet.", "Subnetworks created for Private Service Connect in the producer network.", "Subnetwork used for Regional Internal/External HTTP(S) Load Balancing." @@ -71639,6 +76531,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -71761,6 +76683,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -71955,6 +76907,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -72233,6 +77215,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -72337,6 +77349,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -72529,6 +77571,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -72651,6 +77723,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -72755,6 +77857,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -72862,10 +77994,12 @@ "id": "TargetHttpsProxy", "properties": { "authentication": { + "deprecated": true, "description": "[Deprecated] Use serverTlsPolicy instead.", "type": "string" }, "authorization": { + "deprecated": true, "description": "[Deprecated] Use authorizationPolicy instead.", "type": "string" }, @@ -73035,6 +78169,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -73157,6 +78321,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -73346,6 +78540,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -73468,6 +78692,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -73572,6 +78826,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -73790,6 +79074,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -73929,6 +79243,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -74085,6 +79429,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -74332,6 +79706,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -74436,6 +79840,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -74651,6 +80085,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -74773,6 +80237,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -74996,6 +80490,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -75118,6 +80642,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -75222,6 +80776,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -75515,6 +81099,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -75734,6 +81348,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -75838,6 +81482,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -75989,6 +81663,7 @@ "enum": [ "INTERNAL_HTTPS_LOAD_BALANCER", "PRIVATE", + "PRIVATE_NAT", "PRIVATE_RFC_1918", "PRIVATE_SERVICE_CONNECT", "REGIONAL_MANAGED_PROXY" @@ -75996,6 +81671,7 @@ "enumDescriptions": [ "Subnet reserved for Internal HTTP(S) Load Balancing.", "Regular user created or automatically created subnet.", + "Subnetwork used as source range for Private NAT Gateways.", "Regular user created or automatically created subnet.", "Subnetworks created for Private Service Connect in the producer network.", "Subnetwork used for Regional Internal/External HTTP(S) Load Balancing." @@ -76117,6 +81793,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -76353,6 +82059,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -76577,6 +82313,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -76699,6 +82465,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -76925,6 +82721,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -77208,6 +83034,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -77330,6 +83186,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -77434,6 +83320,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -77614,6 +83530,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -77823,6 +83769,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", diff --git a/googleapiclient/discovery_cache/documents/compute.v1.json b/googleapiclient/discovery_cache/documents/compute.v1.json index 44286fcfa3c..78ebb5d5ddf 100644 --- a/googleapiclient/discovery_cache/documents/compute.v1.json +++ b/googleapiclient/discovery_cache/documents/compute.v1.json @@ -17437,7 +17437,8 @@ ] }, "moveInstance": { - "description": "Moves an instance and its attached persistent disks from one zone to another. *Note*: Moving VMs or disks by using this method might cause unexpected behavior. For more information, see the [known issue](/compute/docs/troubleshooting/known-issues#moving_vms_or_disks_using_the_moveinstance_api_or_the_causes_unexpected_behavior).", + "deprecated": true, + "description": "Moves an instance and its attached persistent disks from one zone to another. *Note*: Moving VMs or disks by using this method might cause unexpected behavior. For more information, see the [known issue](/compute/docs/troubleshooting/known-issues#moving_vms_or_disks_using_the_moveinstance_api_or_the_causes_unexpected_behavior). [Deprecated] This method is deprecated. See [moving instance across zones](/compute/docs/instances/moving-instance-across-zones) instead.", "flatPath": "projects/{project}/moveInstance", "httpMethod": "POST", "id": "compute.projects.moveInstance", @@ -33731,7 +33732,7 @@ } } }, - "revision": "20230620", + "revision": "20230701", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -33867,6 +33868,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -33989,6 +34020,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -34093,6 +34154,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -34460,6 +34551,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -34582,6 +34703,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -34686,6 +34837,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -35380,6 +35561,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -35502,6 +35713,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -35664,6 +35905,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -36245,6 +36516,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -36487,9 +36788,10 @@ }, "outlierDetection": { "$ref": "OutlierDetection", - "description": "Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. If not set, this feature is considered disabled. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, HTTP2, or GRPC, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. " + "description": "Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service. If not set, this feature is considered disabled. Results of the outlier detection algorithm (ejection of endpoints from the load balancing pool and returning them back to the pool) are executed independently by each proxy instance of the load balancer. In most cases, more than one proxy instance handles the traffic received by a backend service. Thus, it is possible that an unhealthy endpoint is detected and ejected by only some of the proxies, and while this happens, other proxies may continue to send requests to the same unhealthy endpoint until they detect and eject the unhealthy endpoint. Applicable backend endpoints can be: - VM instances in an Instance Group - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT) - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT) - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud Functions Services - Private Service Connect NEGs, that resolve to Google-managed regional API endpoints or managed services published using Private Service Connect Applicable backend service types can be: - A global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. - A regional backend service with the serviceProtocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not supported for Serverless NEGs. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true." }, "port": { + "deprecated": true, "description": "Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port.", "format": "int32", "type": "integer" @@ -36651,6 +36953,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -36994,6 +37326,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -37203,6 +37565,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -37918,6 +38310,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -38040,6 +38462,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -38144,6 +38596,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -38794,6 +39276,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -38988,6 +39500,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -39241,6 +39783,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -39363,6 +39935,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -39467,6 +40069,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -39608,6 +40240,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -39879,6 +40541,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -40115,6 +40807,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -40413,6 +41135,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -40533,6 +41285,7 @@ "type": "string" }, "displayName": { + "deprecated": true, "description": "Deprecated, please use short name instead. User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" @@ -40600,6 +41353,7 @@ "type": "string" }, "displayName": { + "deprecated": true, "description": "[Output Only] Deprecated, please use short name instead. The display name of the firewall policy of the association.", "type": "string" }, @@ -40676,6 +41430,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -41273,6 +42057,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -41395,6 +42209,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -41527,6 +42371,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -42144,6 +43018,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -42372,6 +43276,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -42501,6 +43435,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -42605,6 +43569,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -43088,6 +44082,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -43496,6 +44520,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -43671,6 +44725,7 @@ "type": "string" }, "sha1Checksum": { + "deprecated": true, "description": "[Deprecated] This field is deprecated. An optional SHA1 checksum of the disk image before unpackaging provided by the client when the disk image is created.", "pattern": "[a-f0-9]{40}", "type": "string" @@ -43840,6 +44895,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -44256,6 +45341,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -44497,6 +45612,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -44619,6 +45764,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -44729,6 +45904,10 @@ "description": "[Output Only] The URL of the Instance Group resource.", "type": "string" }, + "instanceLifecyclePolicy": { + "$ref": "InstanceGroupManagerInstanceLifecyclePolicy", + "description": "The repair policy for this managed instance group." + }, "instanceTemplate": { "description": "The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.", "type": "string" @@ -44961,6 +46140,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -45035,6 +46244,24 @@ }, "type": "object" }, + "InstanceGroupManagerInstanceLifecyclePolicy": { + "id": "InstanceGroupManagerInstanceLifecyclePolicy", + "properties": { + "forceUpdateOnRepair": { + "description": "A bit indicating whether to forcefully apply the group's latest configuration when repairing a VM. Valid options are: - NO (default): If configuration updates are available, they are not forcefully applied during repair. Instead, configuration updates are applied according to the group's update policy. - YES: If configuration updates are available, they are applied during repair. ", + "enum": [ + "NO", + "YES" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, "InstanceGroupManagerList": { "description": "[Output Only] A list of managed instance groups.", "id": "InstanceGroupManagerList", @@ -45098,6 +46325,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -45504,6 +46761,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -45635,6 +46922,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -45811,6 +47128,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -45946,6 +47293,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -46086,6 +47463,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -46208,6 +47615,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -46640,6 +48077,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -46762,6 +48229,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -46866,6 +48363,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -47007,6 +48534,7 @@ "id": "InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy", "properties": { "displayName": { + "deprecated": true, "description": "[Output Only] Deprecated, please use short name instead. The display name of the firewall policy.", "type": "string" }, @@ -47102,6 +48630,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -47562,6 +49120,7 @@ "type": "string" }, "googleReferenceId": { + "deprecated": true, "description": "[Output Only] Google reference ID, to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. [Deprecated] This field is not used.", "type": "string" }, @@ -47788,6 +49347,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -47951,6 +49540,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -48086,6 +49705,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -48165,7 +49814,7 @@ "type": "object" }, "InterconnectDiagnostics": { - "description": "Diagnostics information about interconnect, contains detailed and current technical information about Google's side of the connection.", + "description": "Diagnostics information about the Interconnect connection, which contains detailed and current technical information about Google's side of the connection.", "id": "InterconnectDiagnostics", "properties": { "arpCaches": { @@ -48390,6 +50039,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -48620,6 +50299,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -49024,6 +50733,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -49333,6 +51072,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -49761,6 +51530,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -49993,6 +51792,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -50115,6 +51944,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -50219,6 +52078,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -50587,6 +52476,7 @@ "id": "Network", "properties": { "IPv4Range": { + "deprecated": true, "description": "Deprecated in favor of subnet mode networks. The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.", "pattern": "[0-9]{1,3}(?:\\.[0-9]{1,3}){3}/[0-9]{1,2}", "type": "string" @@ -50846,6 +52736,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -51012,6 +52932,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -51116,6 +53066,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -51299,6 +53279,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -51403,6 +53413,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -51670,6 +53710,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -51844,6 +53914,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -52041,6 +54141,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -52145,6 +54275,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -52394,6 +54554,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -52612,6 +54802,7 @@ "id": "NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy", "properties": { "displayName": { + "deprecated": true, "description": "[Output Only] Deprecated, please use short name instead. The display name of the firewall policy.", "type": "string" }, @@ -52832,6 +55023,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -52986,6 +55207,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -53239,6 +55490,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -53343,6 +55624,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -53597,6 +55908,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -53719,6 +56060,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -53838,6 +56209,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -54028,6 +56429,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -54150,6 +56581,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -54254,6 +56715,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -54445,6 +56936,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -54691,6 +57212,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -54826,6 +57377,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -54948,6 +57529,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -55052,6 +57663,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -55117,54 +57758,54 @@ "properties": { "baseEjectionTime": { "$ref": "Duration", - "description": "The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s." + "description": "The base time that a backend endpoint is ejected for. Defaults to 30000ms or 30s. After a backend endpoint is returned back to the load balancing pool, it can be ejected again in another ejection analysis. Thus, the total ejection time is equal to the base ejection time multiplied by the number of times the backend endpoint has been ejected. Defaults to 30000ms or 30s." }, "consecutiveErrors": { - "description": "Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.", + "description": "Number of consecutive errors before a backend endpoint is ejected from the load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.", "format": "int32", "type": "integer" }, "consecutiveGatewayFailure": { - "description": "The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.", + "description": "The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3.", "format": "int32", "type": "integer" }, "enforcingConsecutiveErrors": { - "description": "The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.", + "description": "The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.", "format": "int32", "type": "integer" }, "enforcingConsecutiveGatewayFailure": { - "description": "The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.", + "description": "The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.", "format": "int32", "type": "integer" }, "enforcingSuccessRate": { - "description": "The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.", + "description": "The percentage chance that a backend endpoint will be ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service uses Serverless NEG.", "format": "int32", "type": "integer" }, "interval": { "$ref": "Duration", - "description": "Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second." + "description": "Time interval between ejection analysis sweeps. This can result in both new ejections and backend endpoints being returned to service. The interval is equal to the number of seconds as defined in outlierDetection.interval.seconds plus the number of nanoseconds as defined in outlierDetection.interval.nanos. Defaults to 1 second." }, "maxEjectionPercent": { - "description": "Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%.", + "description": "Maximum percentage of backend endpoints in the load balancing pool for the backend service that can be ejected if the ejection conditions are met. Defaults to 50%.", "format": "int32", "type": "integer" }, "successRateMinimumHosts": { - "description": "The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5.", + "description": "The number of backend endpoints in the load balancing pool that must have enough request volume to detect success rate outliers. If the number of backend endpoints is fewer than this setting, outlier detection via success rate statistics is not performed for any backend endpoint in the load balancing pool. Defaults to 5. Not supported when the backend service uses Serverless NEG.", "format": "int32", "type": "integer" }, "successRateRequestVolume": { - "description": "The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100.", + "description": "The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this backend endpoint in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that backend endpoint. Defaults to 100. Not supported when the backend service uses Serverless NEG.", "format": "int32", "type": "integer" }, "successRateStdevFactor": { - "description": "This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900.", + "description": "This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * successRateStdevFactor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. Not supported when the backend service uses Serverless NEG.", "format": "int32", "type": "integer" } @@ -55382,6 +58023,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -55552,6 +58223,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -55725,6 +58426,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -56324,6 +59055,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -56563,6 +59324,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -56684,6 +59475,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -56831,6 +59652,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -57412,6 +60263,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -57533,6 +60414,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -57702,6 +60613,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -57838,6 +60779,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -58085,6 +61056,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -58264,6 +61265,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -58427,6 +61458,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -58814,6 +61875,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -58935,6 +62026,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -59050,6 +62171,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -59198,6 +62349,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -59410,6 +62591,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -59647,6 +62858,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -60067,6 +63308,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -60221,6 +63492,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -60455,6 +63756,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -60858,6 +64189,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -61487,6 +64848,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -62041,6 +65432,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -62154,6 +65575,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -62464,6 +65915,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -63056,6 +66537,7 @@ "type": "array" }, "producerForwardingRule": { + "deprecated": true, "description": "The URL of a forwarding rule with loadBalancingScheme INTERNAL* that is serving the endpoint identified by this service attachment.", "type": "string" }, @@ -63153,6 +66635,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -63329,6 +66841,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -63433,6 +66975,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -63867,6 +67439,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -64191,6 +67793,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -64313,6 +67945,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -64491,6 +68153,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -64623,6 +68315,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -64744,6 +68466,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -64860,6 +68612,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -65039,6 +68821,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -65387,6 +69199,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -65509,6 +69351,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -65699,6 +69571,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -65972,6 +69874,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -66076,6 +70008,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -66292,6 +70254,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -66396,6 +70388,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -66661,6 +70683,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -66783,6 +70835,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -66968,6 +71050,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -67090,6 +71202,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -67194,6 +71336,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -67408,6 +71580,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -67547,6 +71749,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -67703,6 +71935,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -67950,6 +72212,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -68054,6 +72346,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -68269,6 +72591,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -68391,6 +72743,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -68614,6 +72996,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -68736,6 +73148,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -68840,6 +73282,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -69129,6 +73601,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -69348,6 +73850,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -69452,6 +73984,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -69731,6 +74293,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -69967,6 +74559,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -70179,6 +74801,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -70301,6 +74953,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -70523,6 +75205,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -70806,6 +75518,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -70928,6 +75670,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -71032,6 +75804,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -71212,6 +76014,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", @@ -71421,6 +76253,36 @@ "UNDECLARED_PROPERTIES", "UNREACHABLE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", diff --git a/googleapiclient/discovery_cache/documents/connectors.v1.json b/googleapiclient/discovery_cache/documents/connectors.v1.json index e9d0812122b..866899868d2 100644 --- a/googleapiclient/discovery_cache/documents/connectors.v1.json +++ b/googleapiclient/discovery_cache/documents/connectors.v1.json @@ -453,6 +453,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "repairEventing": { + "description": "RepaiEventing tries to repair eventing related event subscriptions.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:repairEventing", + "httpMethod": "POST", + "id": "connectors.projects.locations.connections.repairEventing", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of the form: `projects/*/locations/*/connections/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:repairEventing", + "request": { + "$ref": "RepairEventingRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "setIamPolicy": { "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:setIamPolicy", @@ -543,6 +571,201 @@ } } }, + "eventSubscriptions": { + "methods": { + "create": { + "description": "Creates a new EventSubscription in a given project,location and connection.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/eventSubscriptions", + "httpMethod": "POST", + "id": "connectors.projects.locations.connections.eventSubscriptions.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "eventSubscriptionId": { + "description": "Required. Identifier to assign to the Event Subscription. Must be unique within scope of the parent resource.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent resource of the EventSubscription, of the form: `projects/*/locations/*/connections/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/eventSubscriptions", + "request": { + "$ref": "EventSubscription" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single EventSubscription.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/eventSubscriptions/{eventSubscriptionsId}", + "httpMethod": "DELETE", + "id": "connectors.projects.locations.connections.eventSubscriptions.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of the form: `projects/*/locations/*/connections/*/eventsubscriptions/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/eventSubscriptions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single EventSubscription.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/eventSubscriptions/{eventSubscriptionsId}", + "httpMethod": "GET", + "id": "connectors.projects.locations.connections.eventSubscriptions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of the form: `projects/*/locations/*/connections/*/eventSubscriptions/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/eventSubscriptions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "EventSubscription" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List EventSubscriptions in a given project,location and connection.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/eventSubscriptions", + "httpMethod": "GET", + "id": "connectors.projects.locations.connections.eventSubscriptions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Filter. https://g3doc.corp.google.com/cloud/control2/g3doc/dev/apihosting/list_filtering.md#filtering.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Order by parameters.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent resource of the EventSubscription, of the form: `projects/*/locations/*/connections/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/eventSubscriptions", + "response": { + "$ref": "ListEventSubscriptionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single EventSubscription.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/eventSubscriptions/{eventSubscriptionsId}", + "httpMethod": "PATCH", + "id": "connectors.projects.locations.connections.eventSubscriptions.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of the EventSubscription. Format: projects/{project}/locations/{location}/connections/{connection}/eventSubscriptions/{event_subscription}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/eventSubscriptions/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The list of fields to update. Fields are specified relative to the Subscription. A field will be overwritten if it is in the mask. You can modify only the fields listed below. To update the EventSubscription details: * `serviceAccount`", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "EventSubscription" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "retry": { + "description": "RetryEventSubscription retries the registration of Subscription.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/eventSubscriptions/{eventSubscriptionsId}:retry", + "httpMethod": "POST", + "id": "connectors.projects.locations.connections.eventSubscriptions.retry", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of the form: `projects/*/locations/*/connections/*/eventSubscriptions/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/eventSubscriptions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:retry", + "request": { + "$ref": "RetryEventSubscriptionRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "runtimeActionSchemas": { "methods": { "list": { @@ -828,6 +1051,40 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "updateSettings": { + "description": "Update the global settings of a project.", + "flatPath": "v1/projects/{projectsId}/locations/global/settings", + "httpMethod": "PATCH", + "id": "connectors.projects.locations.global.updateSettings", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Resource name of the Connection. Format: projects/{project}/locations/global/settings}", + "location": "path", + "pattern": "^projects/[^/]+/locations/global/settings$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The list of fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "Settings" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -1438,6 +1695,73 @@ "https://www.googleapis.com/auth/cloud-platform" ] } + }, + "resources": { + "eventtypes": { + "methods": { + "get": { + "description": "Gets details of a single event type.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/providers/{providersId}/connectors/{connectorsId}/versions/{versionsId}/eventtypes/{eventtypesId}", + "httpMethod": "GET", + "id": "connectors.projects.locations.providers.connectors.versions.eventtypes.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of the form: `projects/*/locations/*/providers/*/connectors/*/versions/*/eventtypes/*` Only global location is supported for EventType resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/providers/[^/]+/connectors/[^/]+/versions/[^/]+/eventtypes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "EventType" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Event Types in a given Connector Version.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/providers/{providersId}/connectors/{connectorsId}/versions/{versionsId}/eventtypes", + "httpMethod": "GET", + "id": "connectors.projects.locations.providers.connectors.versions.eventtypes.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent resource of the connectors, of the form: `projects/*/locations/*/providers/*/connectors/*/versions/*` Only global location is supported for EventType resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/providers/[^/]+/connectors/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/eventtypes", + "response": { + "$ref": "ListEventTypesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } } } } @@ -1449,7 +1773,7 @@ } } }, - "revision": "20230614", + "revision": "20230706", "rootUrl": "https://connectors.googleapis.com/", "schemas": { "AuditConfig": { @@ -1803,6 +2127,11 @@ "description": "Required. Connector version on which the connection is created. The format is: projects/*/locations/*/providers/*/connectors/*/versions/* Only global location is supported for ConnectorVersion resource.", "type": "string" }, + "connectorVersionInfraConfig": { + "$ref": "ConnectorVersionInfraConfig", + "description": "Output only. Infra configs supported by Connector Version.", + "readOnly": true + }, "connectorVersionLaunchStage": { "description": "Output only. Flag to mark the version indicating the launch stage.", "enum": [ @@ -1844,6 +2173,29 @@ "readOnly": true, "type": "string" }, + "eventingConfig": { + "$ref": "EventingConfig", + "description": "Optional. Eventing config of a connection" + }, + "eventingEnablementType": { + "description": "Optional. Eventing enablement type. Will be nil if eventing is not enabled.", + "enum": [ + "EVENTING_ENABLEMENT_TYPE_UNSPECIFIED", + "EVENTING_AND_CONNECTION", + "ONLY_EVENTING" + ], + "enumDescriptions": [ + "Eventing Enablement Type Unspecifeied.", + "Both connection and eventing.", + "Only Eventing." + ], + "type": "string" + }, + "eventingRuntimeData": { + "$ref": "EventingRuntimeData", + "description": "Output only. Eventing Runtime Data.", + "readOnly": true + }, "imageLocation": { "description": "Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName}", "readOnly": true, @@ -2038,6 +2390,11 @@ "readOnly": true, "type": "string" }, + "eventingDetails": { + "$ref": "EventingDetails", + "description": "Output only. Eventing details. Will be null if eventing is not supported.", + "readOnly": true + }, "externalUri": { "description": "Output only. Link to external page.", "readOnly": true, @@ -2089,6 +2446,18 @@ }, "type": "object" }, + "ConnectorInfraConfig": { + "description": "This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version", + "id": "ConnectorInfraConfig", + "properties": { + "ratelimitThreshold": { + "description": "Max QPS supported by the connector version before throttling of requests.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "ConnectorVersion": { "description": "ConnectorVersion indicates a specific version of a connector.", "id": "ConnectorVersion", @@ -2109,6 +2478,11 @@ "readOnly": true, "type": "array" }, + "connectorInfraConfig": { + "$ref": "ConnectorInfraConfig", + "description": "Output only. Infra configs supported by Connector.", + "readOnly": true + }, "createTime": { "description": "Output only. Created time.", "format": "google-datetime", @@ -2133,6 +2507,11 @@ "description": "Output only. Configuration for Egress Control.", "readOnly": true }, + "eventingConfigTemplate": { + "$ref": "EventingConfigTemplate", + "description": "Output only. Eventing configuration supported by the Connector.", + "readOnly": true + }, "labels": { "additionalProperties": { "type": "string" @@ -2202,6 +2581,19 @@ }, "type": "object" }, + "ConnectorVersionInfraConfig": { + "description": "This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version", + "id": "ConnectorVersionInfraConfig", + "properties": { + "ratelimitThreshold": { + "description": "Output only. Max QPS supported by the connector version before throttling of requests.", + "format": "int64", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "ConnectorsLogConfig": { "description": "Log configuration for the connection.", "id": "ConnectorsLogConfig", @@ -2354,6 +2746,24 @@ }, "type": "object" }, + "EndPoint": { + "description": "Endpoint message includes details of the Destination endpoint.", + "id": "EndPoint", + "properties": { + "endpointUri": { + "description": "The URI of the Endpoint.", + "type": "string" + }, + "headers": { + "description": "List of Header to be added to the Endpoint.", + "items": { + "$ref": "Header" + }, + "type": "array" + } + }, + "type": "object" + }, "EndpointAttachment": { "description": "represents the Connector's Endpoint Attachment resource", "id": "EndpointAttachment", @@ -2413,9 +2823,339 @@ }, "type": "object" }, - "Expr": { - "description": "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.", - "id": "Expr", + "EventSubscription": { + "description": "represents the Connector's EventSubscription resource", + "id": "EventSubscription", + "properties": { + "createTime": { + "description": "Output only. Created time.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "destinations": { + "$ref": "EventSubscriptionDestination", + "description": "Optional. The destination to hit when we receive an event" + }, + "eventTypeId": { + "description": "Optional. Event type id of the event of current EventSubscription.", + "type": "string" + }, + "name": { + "description": "Required. Resource name of the EventSubscription. Format: projects/{project}/locations/{location}/connections/{connection}/eventSubscriptions/{event_subscription}", + "type": "string" + }, + "status": { + "$ref": "EventSubscriptionStatus", + "description": "Optional. Status indicates the status of the event subscription resource" + }, + "subscriber": { + "description": "Optional. name of the Subscriber for the current EventSubscription.", + "type": "string" + }, + "subscriberLink": { + "description": "Optional. Link for Subscriber of the current EventSubscription.", + "type": "string" + }, + "updateTime": { + "description": "Output only. Updated time.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "EventSubscriptionDestination": { + "description": "Message for EventSubscription Destination to act on receiving an event", + "id": "EventSubscriptionDestination", + "properties": { + "endpoint": { + "$ref": "EndPoint", + "description": "OPTION 1: Hit an endpoint when we receive an event." + }, + "serviceAccount": { + "description": "Service account needed for runtime plane to trigger IP workflow.", + "type": "string" + }, + "type": { + "description": "type of the destination", + "enum": [ + "TYPE_UNSPECIFIED", + "ENDPOINT" + ], + "enumDescriptions": [ + "Default state.", + "Endpoint - Hit the value of endpoint when event is received" + ], + "type": "string" + } + }, + "type": "object" + }, + "EventSubscriptionStatus": { + "description": "EventSubscription Status denotes the status of the EventSubscription resource.", + "id": "EventSubscriptionStatus", + "properties": { + "description": { + "description": "Output only. Description of the state.", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. State of Event Subscription resource.", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "UPDATING", + "ACTIVE", + "SUSPENDED", + "ERROR" + ], + "enumDescriptions": [ + "Default state.", + "EventSubscription creation is in progress.", + "EventSubscription is in Updating status.", + "EventSubscription is in Active state and is ready to receive events.", + "EventSubscription is currently suspended.", + "EventSubscription is in Error state." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "EventType": { + "description": "EventType includes fields.", + "id": "EventType", + "properties": { + "createTime": { + "description": "Output only. Created time.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "enrichedEventPayloadSchema": { + "description": "Output only. Schema of the event payload after enriched. Will be null if read before send is not supported.", + "readOnly": true, + "type": "string" + }, + "entityType": { + "description": "Output only. Runtime entity type name. Will be null if entity type map is not available. Used for read before send feature.", + "readOnly": true, + "type": "string" + }, + "eventPayloadSchema": { + "description": "Output only. Schema of webhook event payload.", + "readOnly": true, + "type": "string" + }, + "eventTypeId": { + "description": "Output only. Event type id. Example: `ticket.created`.", + "readOnly": true, + "type": "string" + }, + "idPath": { + "description": "Output only. Id path denotes the path of id in webhook payload.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. Resource name of the eventtype. Format: projects/{project}/locations/{location}/providers/{provider}/connectors/{connector}/versions/{version}/eventtypes/{eventtype} Only global location is supported for Connector resource.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Updated time.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "EventingConfig": { + "description": "Eventing Configuration of a connection", + "id": "EventingConfig", + "properties": { + "additionalVariables": { + "description": "Additional eventing related field values", + "items": { + "$ref": "ConfigVariable" + }, + "type": "array" + }, + "authConfig": { + "$ref": "AuthConfig", + "description": "Auth details for the webhook adapter." + }, + "encryptionKey": { + "$ref": "ConfigVariable", + "description": "Encryption key (can be either Google managed or CMEK)." + }, + "enrichmentEnabled": { + "description": "Enrichment Enabled.", + "type": "boolean" + }, + "registrationDestinationConfig": { + "$ref": "DestinationConfig", + "description": "Registration endpoint for auto regsitration." + } + }, + "type": "object" + }, + "EventingConfigTemplate": { + "description": "Eventing Config details of a connector version.", + "id": "EventingConfigTemplate", + "properties": { + "additionalVariables": { + "description": "Additional fields that need to be rendered.", + "items": { + "$ref": "ConfigVariableTemplate" + }, + "type": "array" + }, + "authConfigTemplates": { + "description": "AuthConfigTemplates represents the auth values for the webhook adapter.", + "items": { + "$ref": "AuthConfigTemplate" + }, + "type": "array" + }, + "autoRefresh": { + "description": "Auto refresh to extend webhook life.", + "type": "boolean" + }, + "autoRegistrationSupported": { + "description": "Auto Registration supported.", + "type": "boolean" + }, + "encryptionKeyTemplate": { + "$ref": "ConfigVariableTemplate", + "description": "Encryption key (can be either Google managed or CMEK)." + }, + "enrichmentSupported": { + "description": "Enrichment Supported.", + "type": "boolean" + }, + "isEventingSupported": { + "description": "Is Eventing Supported.", + "type": "boolean" + }, + "registrationDestinationConfig": { + "$ref": "DestinationConfigTemplate", + "description": "Registration host destination config template." + } + }, + "type": "object" + }, + "EventingDetails": { + "description": "Eventing Details message.", + "id": "EventingDetails", + "properties": { + "customEventTypes": { + "description": "Output only. Custom Event Types.", + "readOnly": true, + "type": "boolean" + }, + "description": { + "description": "Output only. Description.", + "readOnly": true, + "type": "string" + }, + "documentationLink": { + "description": "Output only. Link to public documentation.", + "readOnly": true, + "type": "string" + }, + "iconLocation": { + "description": "Output only. Cloud storage location of the icon.", + "readOnly": true, + "type": "string" + }, + "launchStage": { + "description": "Output only. Eventing Launch Stage.", + "enum": [ + "LAUNCH_STAGE_UNSPECIFIED", + "PREVIEW", + "GA", + "DEPRECATED", + "PRIVATE_PREVIEW" + ], + "enumDescriptions": [ + "LAUNCH_STAGE_UNSPECIFIED.", + "PREVIEW.", + "GA.", + "DEPRECATED.", + "PRIVATE_PREVIEW." + ], + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. Name of the Eventing trigger.", + "readOnly": true, + "type": "string" + }, + "searchTags": { + "description": "Output only. Array of search keywords.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "EventingRuntimeData": { + "description": "Eventing runtime data has the details related to eventing managed by the system.", + "id": "EventingRuntimeData", + "properties": { + "eventsListenerEndpoint": { + "description": "Output only. Events listener endpoint. The value will populated after provisioning the events listener.", + "readOnly": true, + "type": "string" + }, + "status": { + "$ref": "EventingStatus", + "description": "Output only. Current status of eventing.", + "readOnly": true + } + }, + "type": "object" + }, + "EventingStatus": { + "description": "EventingStatus indicates the state of eventing.", + "id": "EventingStatus", + "properties": { + "description": { + "description": "Output only. Description of error if State is set to \"ERROR\".", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. State.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "ERROR" + ], + "enumDescriptions": [ + "Default state.", + "Eventing is enabled and ready to receive events.", + "Eventing is not active due to an error." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Expr": { + "description": "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.", + "id": "Expr", "properties": { "description": { "description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", @@ -2526,6 +3266,53 @@ "DATA_TYPE_TIME_WITH_TIMEZONE", "DATA_TYPE_TIMESTAMP_WITH_TIMEZONE" ], + "enumDeprecated": [ + false, + true, + false, + false, + false, + true, + false, + true, + true, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Data type is not specified.", "DEPRECATED! Use DATA_TYPE_INTEGER.", @@ -2640,6 +3427,21 @@ }, "type": "object" }, + "Header": { + "description": "Header details for a given header to be added to Endpoint.", + "id": "Header", + "properties": { + "key": { + "description": "Key of Header.", + "type": "string" + }, + "value": { + "description": "Value of Header.", + "type": "string" + } + }, + "type": "object" + }, "InputParameter": { "description": "Metadata of an input parameter.", "id": "InputParameter", @@ -2693,6 +3495,53 @@ "DATA_TYPE_TIME_WITH_TIMEZONE", "DATA_TYPE_TIMESTAMP_WITH_TIMEZONE" ], + "enumDeprecated": [ + false, + true, + false, + false, + false, + true, + false, + true, + true, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Data type is not specified.", "DEPRECATED! Use DATA_TYPE_INTEGER.", @@ -2880,6 +3729,49 @@ }, "type": "object" }, + "ListEventSubscriptionsResponse": { + "description": "Response message for ConnectorsService.ListEventSubscriptions", + "id": "ListEventSubscriptionsResponse", + "properties": { + "eventSubscriptions": { + "description": "Subscriptions.", + "items": { + "$ref": "EventSubscription" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Next page token.", + "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListEventTypesResponse": { + "description": "Response message for Connectors.ListEventTypes.", + "id": "ListEventTypesResponse", + "properties": { + "eventTypes": { + "description": "A list of connector versions.", + "items": { + "$ref": "EventType" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Next page token.", + "type": "string" + } + }, + "type": "object" + }, "ListLocationsResponse": { "description": "The response message for Locations.ListLocations.", "id": "ListLocationsResponse", @@ -3407,6 +4299,12 @@ "properties": {}, "type": "object" }, + "RepairEventingRequest": { + "description": "Request message for ConnectorsService.RepairEventing", + "id": "RepairEventingRequest", + "properties": {}, + "type": "object" + }, "Resource": { "description": "Resource definition", "id": "Resource", @@ -3489,6 +4387,53 @@ "DATA_TYPE_TIME_WITH_TIMEZONE", "DATA_TYPE_TIMESTAMP_WITH_TIMEZONE" ], + "enumDeprecated": [ + false, + true, + false, + false, + false, + true, + false, + true, + true, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Data type is not specified.", "DEPRECATED! Use DATA_TYPE_INTEGER.", @@ -3549,6 +4494,12 @@ }, "type": "object" }, + "RetryEventSubscriptionRequest": { + "description": "Request message for ConnectorsService.RefreshEventSubscription", + "id": "RetryEventSubscriptionRequest", + "properties": {}, + "type": "object" + }, "RoleGrant": { "description": "This configuration defines all the Cloud IAM roles that needs to be granted to a particular GCP resource for the selected principal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user.", "id": "RoleGrant", @@ -3671,6 +4622,15 @@ "DELETING", "UPDATING" ], + "enumDeprecated": [ + false, + true, + true, + false, + false, + false, + false + ], "enumDescriptions": [ "STATE_UNSPECIFIED.", "INACTIVE.", diff --git a/googleapiclient/discovery_cache/documents/connectors.v2.json b/googleapiclient/discovery_cache/documents/connectors.v2.json index 032b3140e4a..c7b7ebcb0b9 100644 --- a/googleapiclient/discovery_cache/documents/connectors.v2.json +++ b/googleapiclient/discovery_cache/documents/connectors.v2.json @@ -478,7 +478,7 @@ } } }, - "revision": "20230614", + "revision": "20230706", "rootUrl": "https://connectors.googleapis.com/", "schemas": { "Action": { @@ -672,6 +672,53 @@ "TIME_WITH_TIMEZONE", "TIMESTAMP_WITH_TIMEZONE" ], + "enumDeprecated": [ + false, + true, + false, + false, + false, + true, + false, + true, + true, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Datatype unspecified.", "Deprecated Int type, use INTEGER type instead.", @@ -801,6 +848,53 @@ "TIME_WITH_TIMEZONE", "TIMESTAMP_WITH_TIMEZONE" ], + "enumDeprecated": [ + false, + true, + false, + false, + false, + true, + false, + true, + true, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Datatype unspecified.", "Deprecated Int type, use INTEGER type instead.", @@ -1015,6 +1109,53 @@ "TIME_WITH_TIMEZONE", "TIMESTAMP_WITH_TIMEZONE" ], + "enumDeprecated": [ + false, + true, + false, + false, + false, + true, + false, + true, + true, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Datatype unspecified.", "Deprecated Int type, use INTEGER type instead.", diff --git a/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json b/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json index d189338bccf..cf53ea60fc8 100644 --- a/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json +++ b/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json @@ -1384,7 +1384,7 @@ } } }, - "revision": "20230626", + "revision": "20230702", "rootUrl": "https://contactcenterinsights.googleapis.com/", "schemas": { "GoogleCloudContactcenterinsightsV1Analysis": { @@ -1768,6 +1768,7 @@ "format": "int32", "type": "integer" }, + "deprecated": true, "description": "A map associating each issue resource name with its respective number of matches in the set of conversations. Key has the format: `projects//locations//issueModels//issues/` Deprecated, use `issue_matches_stats` field instead.", "type": "object" }, @@ -2052,6 +2053,7 @@ "id": "GoogleCloudContactcenterinsightsV1ConversationParticipant", "properties": { "dialogflowParticipant": { + "deprecated": true, "description": "Deprecated. Use `dialogflow_participant_name` instead. The name of the Dialogflow participant. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}", "type": "string" }, @@ -2987,6 +2989,7 @@ "type": "string" }, "medium": { + "deprecated": true, "description": "Medium of conversations used in training data. This field is being deprecated. To specify the medium to be used in training a new issue model, set the `medium` field on `filter`.", "enum": [ "MEDIUM_UNSPECIFIED", @@ -4230,6 +4233,7 @@ "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant", "properties": { "dialogflowParticipant": { + "deprecated": true, "description": "Deprecated. Use `dialogflow_participant_name` instead. The name of the Dialogflow participant. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}", "type": "string" }, @@ -5119,6 +5123,7 @@ "type": "string" }, "medium": { + "deprecated": true, "description": "Medium of conversations used in training data. This field is being deprecated. To specify the medium to be used in training a new issue model, set the `medium` field on `filter`.", "enum": [ "MEDIUM_UNSPECIFIED", diff --git a/googleapiclient/discovery_cache/documents/container.v1.json b/googleapiclient/discovery_cache/documents/container.v1.json index 7a832d9d4a5..c97d5f0cc1d 100644 --- a/googleapiclient/discovery_cache/documents/container.v1.json +++ b/googleapiclient/discovery_cache/documents/container.v1.json @@ -2540,7 +2540,7 @@ } } }, - "revision": "20230620", + "revision": "20230626", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2644,6 +2644,33 @@ }, "type": "object" }, + "AdvancedDatapathObservabilityConfig": { + "description": "AdvancedDatapathObservabilityConfig specifies configuration of observability features of advanced datapath.", + "id": "AdvancedDatapathObservabilityConfig", + "properties": { + "enableMetrics": { + "description": "Expose flow metrics on nodes", + "type": "boolean" + }, + "relayMode": { + "description": "Method used to make Relay available", + "enum": [ + "RELAY_MODE_UNSPECIFIED", + "DISABLED", + "INTERNAL_VPC_LB", + "EXTERNAL_LB" + ], + "enumDescriptions": [ + "Default value. This shouldn't be used.", + "disabled", + "exposed via internal load balancer", + "exposed via external load balancer" + ], + "type": "string" + } + }, + "type": "object" + }, "AdvancedMachineFeatures": { "description": "Specifies options for controlling advanced machine features.", "id": "AdvancedMachineFeatures", @@ -3763,7 +3790,7 @@ "Default value", "Use GKE default DNS provider(kube-dns) for DNS resolution.", "Use CloudDNS for DNS resolution.", - "Use KubeDNS for DNS resolution" + "Use KubeDNS for DNS resolution." ], "type": "string" }, @@ -4200,7 +4227,7 @@ "type": "boolean" }, "defaultPodIpv4RangeUtilization": { - "description": "Output only. [Output only] The utilization of the cluster default IPv4 range for pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.", + "description": "Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.", "format": "double", "readOnly": true, "type": "number" @@ -4765,6 +4792,10 @@ "description": "MonitoringConfig is cluster monitoring configuration.", "id": "MonitoringConfig", "properties": { + "advancedDatapathObservabilityConfig": { + "$ref": "AdvancedDatapathObservabilityConfig", + "description": "Configuration of Advanced Datapath Observability features." + }, "componentConfig": { "$ref": "MonitoringComponentConfig", "description": "Monitoring components configuration" @@ -5219,7 +5250,7 @@ "type": "string" }, "podIpv4RangeUtilization": { - "description": "Output only. [Output only] The utilization of the IPv4 range for pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.", + "description": "Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.", "format": "double", "readOnly": true, "type": "number" diff --git a/googleapiclient/discovery_cache/documents/container.v1beta1.json b/googleapiclient/discovery_cache/documents/container.v1beta1.json index eb0da05157a..4245e15f59c 100644 --- a/googleapiclient/discovery_cache/documents/container.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/container.v1beta1.json @@ -2565,7 +2565,7 @@ } } }, - "revision": "20230613", + "revision": "20230626", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2682,6 +2682,33 @@ }, "type": "object" }, + "AdvancedDatapathObservabilityConfig": { + "description": "AdvancedDatapathObservabilityConfig specifies configuration of observability features of advanced datapath.", + "id": "AdvancedDatapathObservabilityConfig", + "properties": { + "enableMetrics": { + "description": "Expose flow metrics on nodes", + "type": "boolean" + }, + "relayMode": { + "description": "Method used to make Relay available", + "enum": [ + "RELAY_MODE_UNSPECIFIED", + "DISABLED", + "INTERNAL_VPC_LB", + "EXTERNAL_LB" + ], + "enumDescriptions": [ + "Default value. This shouldn't be used.", + "disabled", + "exposed via internal load balancer", + "exposed via external load balancer" + ], + "type": "string" + } + }, + "type": "object" + }, "AdvancedMachineFeatures": { "description": "Specifies options for controlling advanced machine features.", "id": "AdvancedMachineFeatures", @@ -3903,7 +3930,7 @@ "Default value", "Use GKE default DNS provider(kube-dns) for DNS resolution.", "Use CloudDNS for DNS resolution.", - "Use KubeDNS for DNS resolution" + "Use KubeDNS for DNS resolution." ], "type": "string" }, @@ -4378,7 +4405,7 @@ "type": "boolean" }, "defaultPodIpv4RangeUtilization": { - "description": "Output only. [Output only] The utilization of the cluster default IPv4 range for pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.", + "description": "Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.", "format": "double", "readOnly": true, "type": "number" @@ -5031,6 +5058,10 @@ "description": "MonitoringConfig is cluster monitoring configuration.", "id": "MonitoringConfig", "properties": { + "advancedDatapathObservabilityConfig": { + "$ref": "AdvancedDatapathObservabilityConfig", + "description": "Configuration of Advanced Datapath Observability features." + }, "componentConfig": { "$ref": "MonitoringComponentConfig", "description": "Monitoring components configuration" @@ -5501,7 +5532,7 @@ "type": "string" }, "podIpv4RangeUtilization": { - "description": "Output only. [Output only] The utilization of the IPv4 range for pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.", + "description": "Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.", "format": "double", "readOnly": true, "type": "number" diff --git a/googleapiclient/discovery_cache/documents/content.v2.1.json b/googleapiclient/discovery_cache/documents/content.v2.1.json index cbd653564c8..434c38b36c5 100644 --- a/googleapiclient/discovery_cache/documents/content.v2.1.json +++ b/googleapiclient/discovery_cache/documents/content.v2.1.json @@ -6271,7 +6271,7 @@ } } }, - "revision": "20230704", + "revision": "20230706", "rootUrl": "https://shoppingcontent.googleapis.com/", "schemas": { "Account": { @@ -6486,6 +6486,11 @@ "SHOPIFY_ORDER_MANAGEMENT", "SHOPIFY_INTEGRATION" ], + "enumDeprecated": [ + false, + true, + false + ], "enumDescriptions": [ "Unknown purpose.", "The credentials allow Google to manage Shopify orders on behalf of the merchant (deprecated).", @@ -11450,6 +11455,7 @@ "type": "string" }, "productDescription": { + "deprecated": true, "description": "Plain text description of this product (deprecated: Please use product_title instead).", "type": "string" }, @@ -11467,10 +11473,12 @@ "type": "string" }, "sku": { + "deprecated": true, "description": "Merchant SKU for this item (deprecated).", "type": "string" }, "upc": { + "deprecated": true, "description": "Universal product code for this item (deprecated: Please use GTIN instead).", "type": "string" } @@ -14167,6 +14175,7 @@ "type": "array" }, "status": { + "deprecated": true, "description": "Deprecated. Destination approval status in `targetCountry` of the offer.", "type": "string" } @@ -14703,6 +14712,7 @@ "type": "array" }, "includeAttributes": { + "deprecated": true, "description": "Deprecated: Setting this field has no effect and attributes are never included.", "type": "boolean" }, @@ -14983,6 +14993,7 @@ "type": "array" }, "promotionDisplayDates": { + "deprecated": true, "description": "String representation of the promotion display dates. Deprecated. Use `promotion_display_time_period` instead.", "type": "string" }, @@ -14991,6 +15002,7 @@ "description": "`TimePeriod` representation of the promotion's display dates." }, "promotionEffectiveDates": { + "deprecated": true, "description": "String representation of the promotion effective dates. Deprecated. Use `promotion_effective_time_period` instead.", "type": "string" }, @@ -15652,6 +15664,7 @@ }, "buyboxWinningProductStats": { "$ref": "RepricingProductReportBuyboxWinningProductStats", + "deprecated": true, "description": "Stats specific to buybox winning rules for product report (deprecated)." }, "date": { @@ -15899,6 +15912,7 @@ "properties": { "buyboxWinningRuleStats": { "$ref": "RepricingRuleReportBuyboxWinningRuleStats", + "deprecated": true, "description": "Stats specific to buybox winning rules for rule report (deprecated)." }, "date": { diff --git a/googleapiclient/discovery_cache/documents/customsearch.v1.json b/googleapiclient/discovery_cache/documents/customsearch.v1.json index a8c46f8a465..ddd0dd36053 100644 --- a/googleapiclient/discovery_cache/documents/customsearch.v1.json +++ b/googleapiclient/discovery_cache/documents/customsearch.v1.json @@ -688,7 +688,7 @@ } } }, - "revision": "20230703", + "revision": "20230708", "rootUrl": "https://customsearch.googleapis.com/", "schemas": { "Promotion": { diff --git a/googleapiclient/discovery_cache/documents/datacatalog.v1.json b/googleapiclient/discovery_cache/documents/datacatalog.v1.json index 82913dc7052..d550c571245 100644 --- a/googleapiclient/discovery_cache/documents/datacatalog.v1.json +++ b/googleapiclient/discovery_cache/documents/datacatalog.v1.json @@ -2144,7 +2144,7 @@ } } }, - "revision": "20230619", + "revision": "20230630", "rootUrl": "https://datacatalog.googleapis.com/", "schemas": { "Binding": { diff --git a/googleapiclient/discovery_cache/documents/datacatalog.v1beta1.json b/googleapiclient/discovery_cache/documents/datacatalog.v1beta1.json index 8be8bd4a662..4b3887a3d3d 100644 --- a/googleapiclient/discovery_cache/documents/datacatalog.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/datacatalog.v1beta1.json @@ -1813,7 +1813,7 @@ } } }, - "revision": "20230619", + "revision": "20230630", "rootUrl": "https://datacatalog.googleapis.com/", "schemas": { "Binding": { diff --git a/googleapiclient/discovery_cache/documents/dataflow.v1b3.json b/googleapiclient/discovery_cache/documents/dataflow.v1b3.json index fdb135f9433..4afa0ab8150 100644 --- a/googleapiclient/discovery_cache/documents/dataflow.v1b3.json +++ b/googleapiclient/discovery_cache/documents/dataflow.v1b3.json @@ -2214,7 +2214,7 @@ } } }, - "revision": "20230619", + "revision": "20230703", "rootUrl": "https://dataflow.googleapis.com/", "schemas": { "ApproximateProgress": { @@ -2222,15 +2222,18 @@ "id": "ApproximateProgress", "properties": { "percentComplete": { + "deprecated": true, "description": "Obsolete.", "format": "float", "type": "number" }, "position": { "$ref": "Position", + "deprecated": true, "description": "Obsolete." }, "remainingTime": { + "deprecated": true, "description": "Obsolete.", "format": "google-duration", "type": "string" @@ -4100,6 +4103,7 @@ "type": "string" }, "deprecatedPersistentDirectory": { + "deprecated": true, "description": "DEPRECATED. The location of the persistent state for this range, as a persistent directory in the worker local filesystem.", "type": "string" }, @@ -4748,7 +4752,8 @@ "WORKER_REGION", "WORKER_ZONE", "BOOLEAN", - "ENUM" + "ENUM", + "NUMBER" ], "enumDescriptions": [ "Default input type.", @@ -4769,7 +4774,8 @@ "The parameter specifies a Worker Region.", "The parameter specifies a Worker Zone.", "The parameter specifies a boolean input.", - "The parameter specifies an enum input." + "The parameter specifies an enum input.", + "The parameter specifies a number input." ], "type": "string" }, @@ -5170,6 +5176,11 @@ "description": "Optional. Whether to bypass the safety checks for the job's temporary directory. Use with caution.", "type": "boolean" }, + "diskSizeGb": { + "description": "Optional. The disk size, in gigabytes, to use on each remote Compute Engine worker instance.", + "format": "int32", + "type": "integer" + }, "enableStreamingEngine": { "description": "Optional. Whether to enable Streaming Engine for the job.", "type": "boolean" @@ -5814,6 +5825,7 @@ "type": "string" }, "desiredShardSizeBytes": { + "deprecated": true, "description": "DEPRECATED in favor of desired_bundle_size_bytes.", "format": "int64", "type": "string" @@ -5862,6 +5874,7 @@ "type": "string" }, "shards": { + "deprecated": true, "description": "DEPRECATED in favor of bundles.", "items": { "$ref": "SourceSplitShard" @@ -6850,10 +6863,12 @@ }, "suggestedStopPoint": { "$ref": "ApproximateProgress", + "deprecated": true, "description": "DEPRECATED in favor of split_request." }, "suggestedStopPosition": { "$ref": "Position", + "deprecated": true, "description": "Obsolete, always empty." } }, @@ -6886,6 +6901,7 @@ "type": "array" }, "metricUpdates": { + "deprecated": true, "description": "DEPRECATED in favor of counter_updates.", "items": { "$ref": "MetricUpdate" @@ -6894,6 +6910,7 @@ }, "progress": { "$ref": "ApproximateProgress", + "deprecated": true, "description": "DEPRECATED in favor of reported_progress." }, "reportIndex": { @@ -6912,6 +6929,7 @@ }, "sourceFork": { "$ref": "SourceFork", + "deprecated": true, "description": "DEPRECATED in favor of dynamic_source_split." }, "sourceOperationResponse": { diff --git a/googleapiclient/discovery_cache/documents/dataform.v1beta1.json b/googleapiclient/discovery_cache/documents/dataform.v1beta1.json index 84230d79d0b..454a68ab034 100644 --- a/googleapiclient/discovery_cache/documents/dataform.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/dataform.v1beta1.json @@ -1816,7 +1816,7 @@ } } }, - "revision": "20230626", + "revision": "20230701", "rootUrl": "https://dataform.googleapis.com/", "schemas": { "Assertion": { diff --git a/googleapiclient/discovery_cache/documents/datamigration.v1.json b/googleapiclient/discovery_cache/documents/datamigration.v1.json index 7d4b008d6a7..6c56d3cbd14 100644 --- a/googleapiclient/discovery_cache/documents/datamigration.v1.json +++ b/googleapiclient/discovery_cache/documents/datamigration.v1.json @@ -706,7 +706,7 @@ ], "parameters": { "commitId": { - "description": "Request a specific commit ID. If not specified, the entities from the latest commit are returned.", + "description": "Optional. Request a specific commit ID. If not specified, the entities from the latest commit are returned.", "location": "query", "type": "string" }, @@ -718,23 +718,23 @@ "type": "string" }, "filter": { - "description": "Filter the returned entities based on AIP-160 standard.", + "description": "Optional. Filter the returned entities based on AIP-160 standard.", "location": "query", "type": "string" }, "pageSize": { - "description": "The maximum number of entities to return. The service may return fewer entities than the value specifies.", + "description": "Optional. The maximum number of entities to return. The service may return fewer entities than the value specifies.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "The nextPageToken value received in the previous call to conversionWorkspace.describeDatabaseEntities, used in the subsequent request to retrieve the next page of results. On first call this should be left blank. When paginating, all other parameters provided to conversionWorkspace.describeDatabaseEntities must match the call that provided the page token.", + "description": "Optional. The nextPageToken value received in the previous call to conversionWorkspace.describeDatabaseEntities, used in the subsequent request to retrieve the next page of results. On first call this should be left blank. When paginating, all other parameters provided to conversionWorkspace.describeDatabaseEntities must match the call that provided the page token.", "location": "query", "type": "string" }, "tree": { - "description": "The tree to fetch.", + "description": "Required. The tree to fetch.", "enum": [ "DB_TREE_TYPE_UNSPECIFIED", "SOURCE_TREE", @@ -751,9 +751,26 @@ "type": "string" }, "uncommitted": { - "description": "Whether to retrieve the latest committed version of the entities or the latest version. This field is ignored if a specific commit_id is specified.", + "description": "Optional. Whether to retrieve the latest committed version of the entities or the latest version. This field is ignored if a specific commit_id is specified.", "location": "query", "type": "boolean" + }, + "view": { + "description": "Optional. Results view based on AIP-157", + "enum": [ + "DATABASE_ENTITY_VIEW_UNSPECIFIED", + "DATABASE_ENTITY_VIEW_BASIC", + "DATABASE_ENTITY_VIEW_FULL", + "DATABASE_ENTITY_VIEW_ROOT_SUMMARY" + ], + "enumDescriptions": [ + "Unspecified view. Defaults to basic view.", + "Default view. Does not return DDLs or Issues.", + "Return full entity details including mappings, ddl and issues.", + "Top-most (Database, Schema) nodes which are returned contains summary details for their decendents such as the number of entities per type and issues rollups. When this view is used, only a single page of result is returned and the page_size property of the request is ignored. The returned page will only include the top-most node types." + ], + "location": "query", + "type": "string" } }, "path": "v1/{+conversionWorkspace}:describeDatabaseEntities", @@ -1058,6 +1075,99 @@ "resources": { "mappingRules": { "methods": { + "create": { + "description": "Creates a new mapping rule for a given conversion workspace.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}/mappingRules", + "httpMethod": "POST", + "id": "datamigration.projects.locations.conversionWorkspaces.mappingRules.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "mappingRuleId": { + "description": "Required. The ID of the rule to create.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent which owns this collection of mapping rules.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored. It is recommended to always set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/mappingRules", + "request": { + "$ref": "MappingRule" + }, + "response": { + "$ref": "MappingRule" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single mapping rule.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}/mappingRules/{mappingRulesId}", + "httpMethod": "DELETE", + "id": "datamigration.projects.locations.conversionWorkspaces.mappingRules.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the mapping rule resource to delete.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+/mappingRules/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored. It is recommended to always set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the details of a mapping rule.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}/mappingRules/{mappingRulesId}", + "httpMethod": "GET", + "id": "datamigration.projects.locations.conversionWorkspaces.mappingRules.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the mapping rule resource to get. Example: conversionWorkspaces/123/mappingRules/rule123 In order to retrieve a previous revision of the mapping rule, also provide the revision ID. Example: conversionWorkspace/123/mappingRules/rule123@c7cfa2a8c7cfa2a8c7cfa2a8c7cfa2a8", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+/mappingRules/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "MappingRule" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "import": { "description": "Imports the mapping rules for a given conversion workspace. Supports various formats of external rules files.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}/mappingRules:import", @@ -1085,6 +1195,42 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "list": { + "description": "Lists the mapping rules for a specific conversion workspace.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}/mappingRules", + "httpMethod": "GET", + "id": "datamigration.projects.locations.conversionWorkspaces.mappingRules.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of rules to return. The service may return fewer than this value.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The nextPageToken value received in the previous call to mappingRules.list, used in the subsequent request to retrieve the next page of results. On first call this should be left blank. When paginating, all other parameters provided to mappingRules.list must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Name of the conversion workspace resource whose mapping rules are listed in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/mappingRules", + "response": { + "$ref": "ListMappingRulesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } } @@ -1114,7 +1260,7 @@ "type": "string" }, "requestId": { - "description": "A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored. It is recommended to always set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", + "description": "Optional. A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored. It is recommended to always set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", "location": "query", "type": "string" } @@ -1951,7 +2097,7 @@ } } }, - "revision": "20230622", + "revision": "20230703", "rootUrl": "https://datamigration.googleapis.com/", "schemas": { "AlloyDbConnectionProfile": { @@ -2002,10 +2148,18 @@ "description": "Request message for 'ApplyConversionWorkspace' request.", "id": "ApplyConversionWorkspaceRequest", "properties": { + "autoCommit": { + "description": "Optional. Specifies whether the conversion workspace is to be committed automatically after the apply.", + "type": "boolean" + }, "connectionProfile": { - "description": "Fully qualified (Uri) name of the destination connection profile.", + "description": "Optional. Fully qualified (Uri) name of the destination connection profile.", "type": "string" }, + "dryRun": { + "description": "Optional. Only validates the apply process, but doesn't change the destination database. Only works for PostgreSQL destination connection profile.", + "type": "boolean" + }, "filter": { "description": "Filter which entities to apply. Leaving this field empty will apply all of the entities. Supports Google AIP 160 based filtering.", "type": "string" @@ -2013,16 +2167,40 @@ }, "type": "object" }, + "ApplyHash": { + "description": "Apply a hash function on the value.", + "id": "ApplyHash", + "properties": { + "uuidFromBytes": { + "$ref": "Empty", + "description": "Optional. Generate UUID from the data's byte array" + } + }, + "type": "object" + }, "ApplyJobDetails": { "description": "Details regarding an Apply background job.", "id": "ApplyJobDetails", "properties": { "connectionProfile": { - "description": "The connection profile which was used for the apply job.", + "description": "Output only. The connection profile which was used for the apply job.", + "readOnly": true, "type": "string" }, "filter": { - "description": "AIP-160 based filter used to specify the entities to apply", + "description": "Output only. AIP-160 based filter used to specify the entities to apply", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "AssignSpecificValue": { + "description": "Set to a specific value (value is converted to fit the target data type)", + "id": "AssignSpecificValue", + "properties": { + "value": { + "description": "Required. Specific value to be assigned", "type": "string" } }, @@ -2082,14 +2260,16 @@ "properties": { "applyJobDetails": { "$ref": "ApplyJobDetails", - "description": "Apply job details." + "description": "Output only. Apply job details.", + "readOnly": true }, "completionComment": { - "description": "Job completion comment, such as how many entities were seeded, how many warnings were found during conversion, and similar information.", + "description": "Output only. Job completion comment, such as how many entities were seeded, how many warnings were found during conversion, and similar information.", + "readOnly": true, "type": "string" }, "completionState": { - "description": "Job completion state, i.e. the final state after the job completed.", + "description": "Output only. Job completion state, i.e. the final state after the job completed.", "enum": [ "JOB_COMPLETION_STATE_UNSPECIFIED", "SUCCEEDED", @@ -2100,11 +2280,13 @@ "Success.", "Error." ], + "readOnly": true, "type": "string" }, "convertJobDetails": { "$ref": "ConvertJobDetails", - "description": "Convert job details." + "description": "Output only. Convert job details.", + "readOnly": true }, "finishTime": { "description": "The timestamp when the background job was finished.", @@ -2117,7 +2299,8 @@ }, "importRulesJobDetails": { "$ref": "ImportRulesJobDetails", - "description": "Import rules job details." + "description": "Output only. Import rules job details.", + "readOnly": true }, "jobType": { "description": "The type of job that was executed.", @@ -2138,12 +2321,14 @@ "type": "string" }, "requestAutocommit": { - "description": "Whether the client requested the conversion workspace to be committed after a successful completion of the job.", + "description": "Output only. Whether the client requested the conversion workspace to be committed after a successful completion of the job.", + "readOnly": true, "type": "boolean" }, "seedJobDetails": { "$ref": "SeedJobDetails", - "description": "Seed job details." + "description": "Output only. Seed job details.", + "readOnly": true }, "startTime": { "description": "The timestamp when the background job was started.", @@ -2473,6 +2658,33 @@ }, "type": "object" }, + "ConditionalColumnSetValue": { + "description": "Options to configure rule type ConditionalColumnSetValue. The rule is used to transform the data which is being replicated/migrated. The rule filter field can refer to one or more entities. The rule scope can be one of: Column.", + "id": "ConditionalColumnSetValue", + "properties": { + "customFeatures": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Custom engine specific features.", + "type": "object" + }, + "sourceNumericFilter": { + "$ref": "SourceNumericFilter", + "description": "Optional. Optional filter on source column precision and scale. Used for fixed point numbers such as NUMERIC/NUMBER data types." + }, + "sourceTextFilter": { + "$ref": "SourceTextFilter", + "description": "Optional. Optional filter on source column length. Used for text based data types like varchar." + }, + "valueTransformation": { + "$ref": "ValueTransformation", + "description": "Required. Description of data transformation during migration." + } + }, + "type": "object" + }, "ConnectionProfile": { "description": "A connection profile definition.", "id": "ConnectionProfile", @@ -2634,14 +2846,14 @@ "description": "Required. The destination engine details." }, "displayName": { - "description": "The display name for the workspace.", + "description": "Optional. The display name for the workspace.", "type": "string" }, "globalSettings": { "additionalProperties": { "type": "string" }, - "description": "A generic list of settings for the workspace. The settings are database pair dependant and can indicate default behavior for the mapping rules engine or turn on or off specific features. Such examples can be: convert_foreign_key_to_interleave=true, skip_triggers=false, ignore_non_table_synonyms=true", + "description": "Optional. A generic list of settings for the workspace. The settings are database pair dependant and can indicate default behavior for the mapping rules engine or turn on or off specific features. Such examples can be: convert_foreign_key_to_interleave=true, skip_triggers=false, ignore_non_table_synonyms=true", "type": "object" }, "hasUncommittedChanges": { @@ -2697,11 +2909,15 @@ "id": "ConvertConversionWorkspaceRequest", "properties": { "autoCommit": { - "description": "Specifies whether the conversion workspace is to be committed automatically after the conversion.", + "description": "Optional. Specifies whether the conversion workspace is to be committed automatically after the conversion.", + "type": "boolean" + }, + "convertFullPath": { + "description": "Optional. Automatically convert the full entity path for each entity specified by the filter. For example, if the filter specifies a table, that table schema (and database if there is one) will also be converted.", "type": "boolean" }, "filter": { - "description": "Filter the entities to convert. Leaving this field empty will convert all of the entities. Supports Google AIP-160 style filtering.", + "description": "Optional. Filter the entities to convert. Leaving this field empty will convert all of the entities. Supports Google AIP-160 style filtering.", "type": "string" } }, @@ -2712,12 +2928,24 @@ "id": "ConvertJobDetails", "properties": { "filter": { - "description": "AIP-160 based filter used to specify the entities to convert", + "description": "Output only. AIP-160 based filter used to specify the entities to convert", + "readOnly": true, "type": "string" } }, "type": "object" }, + "ConvertRowIdToColumn": { + "description": "Options to configure rule type ConvertROWIDToColumn. The rule is used to add column rowid to destination tables based on an Oracle rowid function/property. The rule filter field can refer to one or more entities. The rule scope can be one of: Table. This rule requires additional filter to be specified beyond the basic rule filter field, which is whether or not to work on tables which already have a primary key defined.", + "id": "ConvertRowIdToColumn", + "properties": { + "onlyIfNoPrimaryKey": { + "description": "Required. Only work on tables without primary key defined", + "type": "boolean" + } + }, + "type": "object" + }, "DatabaseEngineInfo": { "description": "The type and version of a source or destination database.", "id": "DatabaseEngineInfo", @@ -2749,6 +2977,10 @@ "description": "The base entity type for all the database related entities. The message contains the entity name, the name of its parent, the entity type, and the specific details per entity type.", "id": "DatabaseEntity", "properties": { + "database": { + "$ref": "DatabaseInstanceEntity", + "description": "Database." + }, "databaseFunction": { "$ref": "FunctionEntity", "description": "Function." @@ -2757,6 +2989,13 @@ "$ref": "PackageEntity", "description": "Package." }, + "entityDdl": { + "description": "Details about the entity DDL script. Multiple DDL scripts are provided for child entities such as a table entity will have one DDL for the table with additional DDLs for each index, constraint and such.", + "items": { + "$ref": "EntityDdl" + }, + "type": "array" + }, "entityType": { "description": "The type of the database entity (table, view, index, ...).", "enum": [ @@ -2797,6 +3036,13 @@ ], "type": "string" }, + "issues": { + "description": "Details about the various issues found for the entity.", + "items": { + "$ref": "EntityIssue" + }, + "type": "array" + }, "mappings": { "description": "Details about entity mappings. For source tree entities, this holds the draft entities which were generated by the mapping rules. For draft tree entities, this holds the source entities which were converted to form the draft entity. Destination entities will have no mapping details.", "items": { @@ -2804,6 +3050,10 @@ }, "type": "array" }, + "materializedView": { + "$ref": "MaterializedViewEntity", + "description": "Materialized view." + }, "parentEntity": { "description": "The full name of the parent entity (e.g. schema name).", "type": "string" @@ -2848,6 +3098,10 @@ ], "type": "string" }, + "udt": { + "$ref": "UDTEntity", + "description": "UDT." + }, "view": { "$ref": "ViewEntity", "description": "View." @@ -2855,6 +3109,21 @@ }, "type": "object" }, + "DatabaseInstanceEntity": { + "description": "DatabaseInstance acts as a parent entity to other database entities.", + "id": "DatabaseInstanceEntity", + "properties": { + "customFeatures": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Custom engine specific features.", + "type": "object" + } + }, + "type": "object" + }, "DatabaseType": { "description": "A message defining the database engine and provider.", "id": "DatabaseType", @@ -2928,6 +3197,36 @@ }, "type": "object" }, + "DoubleComparisonFilter": { + "description": "Filter based on relation between source value and compare value of type double in ConditionalColumnSetValue", + "id": "DoubleComparisonFilter", + "properties": { + "value": { + "description": "Required. Double compare value to be used", + "format": "double", + "type": "number" + }, + "valueComparison": { + "description": "Required. Relation between source value and compare value", + "enum": [ + "VALUE_COMPARISON_UNSPECIFIED", + "VALUE_COMPARISON_IF_VALUE_SMALLER_THAN", + "VALUE_COMPARISON_IF_VALUE_SMALLER_EQUAL_THAN", + "VALUE_COMPARISON_IF_VALUE_LARGER_THAN", + "VALUE_COMPARISON_IF_VALUE_LARGER_EQUAL_THAN" + ], + "enumDescriptions": [ + "Value comparison unspecified.", + "Value is smaller than the Compare value.", + "Value is smaller or equal than the Compare value.", + "Value is larger than the Compare value.", + "Value is larger or equal than the Compare value." + ], + "type": "string" + } + }, + "type": "object" + }, "DumpFlag": { "description": "Dump flag definition.", "id": "DumpFlag", @@ -2974,16 +3273,24 @@ }, "type": "object" }, - "EntityMapping": { - "description": "Details of the mappings of a database entity.", - "id": "EntityMapping", + "EntityDdl": { + "description": "A single DDL statement for a specific entity", + "id": "EntityDdl", "properties": { - "draftEntity": { - "description": "Target entity full name. The draft entity can also include a column, index or constraint using the same naming notation schema.table.column.", + "ddl": { + "description": "The actual ddl code.", "type": "string" }, - "draftType": { - "description": "Type of draft entity.", + "ddlType": { + "description": "Type of DDL (Create, Alter).", + "type": "string" + }, + "entity": { + "description": "The name of the database entity the ddl refers to.", + "type": "string" + }, + "entityType": { + "description": "The entity type (if the DDL is for a sub entity).", "enum": [ "DATABASE_ENTITY_TYPE_UNSPECIFIED", "DATABASE_ENTITY_TYPE_SCHEMA", @@ -3022,19 +3329,30 @@ ], "type": "string" }, - "mappingLog": { - "description": "Entity mapping log entries. Multiple rules can be effective and contribute changes to a converted entity, such as a rule can handle the entity name, another rule can handle an entity type. In addition, rules which did not change the entity are also logged along with the reason preventing them to do so.", + "issueId": { + "description": "EntityIssues found for this ddl.", "items": { - "$ref": "EntityMappingLogEntry" + "type": "string" }, "type": "array" + } + }, + "type": "object" + }, + "EntityIssue": { + "description": "Issue related to the entity.", + "id": "EntityIssue", + "properties": { + "code": { + "description": "Error/Warning code", + "type": "string" }, - "sourceEntity": { - "description": "Source entity full name. The source entity can also be a column, index or constraint using the same naming notation schema.table.column.", + "ddl": { + "description": "The ddl which caused the issue, if relevant.", "type": "string" }, - "sourceType": { - "description": "Type of source entity.", + "entityType": { + "description": "The entity type (if the DDL is for a sub entity).", "enum": [ "DATABASE_ENTITY_TYPE_UNSPECIFIED", "DATABASE_ENTITY_TYPE_SCHEMA", @@ -3072,71 +3390,249 @@ "Database." ], "type": "string" - } - }, - "type": "object" - }, - "EntityMappingLogEntry": { - "description": "A single record of a rule which was used for a mapping.", - "id": "EntityMappingLogEntry", - "properties": { - "mappingComment": { - "description": "Comment.", - "type": "string" }, - "ruleId": { - "description": "Which rule caused this log entry.", + "id": { + "description": "Unique Issue ID.", "type": "string" }, - "ruleRevisionId": { - "description": "Rule revision ID.", - "type": "string" - } - }, - "type": "object" - }, - "Expr": { - "description": "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.", - "id": "Expr", - "properties": { - "description": { - "description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", + "message": { + "description": "Issue detailed message", "type": "string" }, - "expression": { - "description": "Textual representation of an expression in Common Expression Language syntax.", - "type": "string" + "position": { + "$ref": "Position", + "description": "The position of the issue found, if relevant." }, - "location": { - "description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", + "severity": { + "description": "Severity of the issue", + "enum": [ + "ISSUE_SEVERITY_UNSPECIFIED", + "ISSUE_SEVERITY_INFO", + "ISSUE_SEVERITY_WARNING", + "ISSUE_SEVERITY_ERROR" + ], + "enumDescriptions": [ + "Unspecified issue severity", + "Info", + "Warning", + "Error" + ], "type": "string" }, - "title": { - "description": "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.", + "type": { + "description": "The type of the issue.", + "enum": [ + "ISSUE_TYPE_UNSPECIFIED", + "ISSUE_TYPE_DDL", + "ISSUE_TYPE_APPLY", + "ISSUE_TYPE_CONVERT" + ], + "enumDescriptions": [ + "Unspecified issue type.", + "Issue originated from the DDL", + "Issue originated during the apply process", + "Issue originated during the convert process" + ], "type": "string" } }, "type": "object" }, - "FetchStaticIpsResponse": { - "description": "Response message for a 'FetchStaticIps' request.", - "id": "FetchStaticIpsResponse", + "EntityMapping": { + "description": "Details of the mappings of a database entity.", + "id": "EntityMapping", "properties": { - "nextPageToken": { - "description": "A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "draftEntity": { + "description": "Target entity full name. The draft entity can also include a column, index or constraint using the same naming notation schema.table.column.", "type": "string" }, - "staticIps": { - "description": "List of static IPs.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "ForwardSshTunnelConnectivity": { + "draftType": { + "description": "Type of draft entity.", + "enum": [ + "DATABASE_ENTITY_TYPE_UNSPECIFIED", + "DATABASE_ENTITY_TYPE_SCHEMA", + "DATABASE_ENTITY_TYPE_TABLE", + "DATABASE_ENTITY_TYPE_COLUMN", + "DATABASE_ENTITY_TYPE_CONSTRAINT", + "DATABASE_ENTITY_TYPE_INDEX", + "DATABASE_ENTITY_TYPE_TRIGGER", + "DATABASE_ENTITY_TYPE_VIEW", + "DATABASE_ENTITY_TYPE_SEQUENCE", + "DATABASE_ENTITY_TYPE_STORED_PROCEDURE", + "DATABASE_ENTITY_TYPE_FUNCTION", + "DATABASE_ENTITY_TYPE_SYNONYM", + "DATABASE_ENTITY_TYPE_DATABASE_PACKAGE", + "DATABASE_ENTITY_TYPE_UDT", + "DATABASE_ENTITY_TYPE_MATERIALIZED_VIEW", + "DATABASE_ENTITY_TYPE_DATABASE" + ], + "enumDescriptions": [ + "Unspecified database entity type.", + "Schema.", + "Table.", + "Column.", + "Constraint.", + "Index.", + "Trigger.", + "View.", + "Sequence.", + "Stored Procedure.", + "Function.", + "Synonym.", + "Package.", + "UDT.", + "Materialized View.", + "Database." + ], + "type": "string" + }, + "mappingLog": { + "description": "Entity mapping log entries. Multiple rules can be effective and contribute changes to a converted entity, such as a rule can handle the entity name, another rule can handle an entity type. In addition, rules which did not change the entity are also logged along with the reason preventing them to do so.", + "items": { + "$ref": "EntityMappingLogEntry" + }, + "type": "array" + }, + "sourceEntity": { + "description": "Source entity full name. The source entity can also be a column, index or constraint using the same naming notation schema.table.column.", + "type": "string" + }, + "sourceType": { + "description": "Type of source entity.", + "enum": [ + "DATABASE_ENTITY_TYPE_UNSPECIFIED", + "DATABASE_ENTITY_TYPE_SCHEMA", + "DATABASE_ENTITY_TYPE_TABLE", + "DATABASE_ENTITY_TYPE_COLUMN", + "DATABASE_ENTITY_TYPE_CONSTRAINT", + "DATABASE_ENTITY_TYPE_INDEX", + "DATABASE_ENTITY_TYPE_TRIGGER", + "DATABASE_ENTITY_TYPE_VIEW", + "DATABASE_ENTITY_TYPE_SEQUENCE", + "DATABASE_ENTITY_TYPE_STORED_PROCEDURE", + "DATABASE_ENTITY_TYPE_FUNCTION", + "DATABASE_ENTITY_TYPE_SYNONYM", + "DATABASE_ENTITY_TYPE_DATABASE_PACKAGE", + "DATABASE_ENTITY_TYPE_UDT", + "DATABASE_ENTITY_TYPE_MATERIALIZED_VIEW", + "DATABASE_ENTITY_TYPE_DATABASE" + ], + "enumDescriptions": [ + "Unspecified database entity type.", + "Schema.", + "Table.", + "Column.", + "Constraint.", + "Index.", + "Trigger.", + "View.", + "Sequence.", + "Stored Procedure.", + "Function.", + "Synonym.", + "Package.", + "UDT.", + "Materialized View.", + "Database." + ], + "type": "string" + } + }, + "type": "object" + }, + "EntityMappingLogEntry": { + "description": "A single record of a rule which was used for a mapping.", + "id": "EntityMappingLogEntry", + "properties": { + "mappingComment": { + "description": "Comment.", + "type": "string" + }, + "ruleId": { + "description": "Which rule caused this log entry.", + "type": "string" + }, + "ruleRevisionId": { + "description": "Rule revision ID.", + "type": "string" + } + }, + "type": "object" + }, + "EntityMove": { + "description": "Options to configure rule type EntityMove. The rule is used to move an entity to a new schema. The rule filter field can refer to one or more entities. The rule scope can be one of: Table, Column, Constraint, Index, View, Function, Stored Procedure, Materialized View, Sequence, UDT", + "id": "EntityMove", + "properties": { + "newSchema": { + "description": "Required. The new schema", + "type": "string" + } + }, + "type": "object" + }, + "Expr": { + "description": "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.", + "id": "Expr", + "properties": { + "description": { + "description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", + "type": "string" + }, + "expression": { + "description": "Textual representation of an expression in Common Expression Language syntax.", + "type": "string" + }, + "location": { + "description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", + "type": "string" + }, + "title": { + "description": "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.", + "type": "string" + } + }, + "type": "object" + }, + "FetchStaticIpsResponse": { + "description": "Response message for a 'FetchStaticIps' request.", + "id": "FetchStaticIpsResponse", + "properties": { + "nextPageToken": { + "description": "A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "staticIps": { + "description": "List of static IPs.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "FilterTableColumns": { + "description": "Options to configure rule type FilterTableColumns. The rule is used to filter the list of columns to include or exclude from a table. The rule filter field can refer to one entity. The rule scope can be: Table Only one of the two lists can be specified for the rule.", + "id": "FilterTableColumns", + "properties": { + "excludeColumns": { + "description": "Optional. List of columns to be excluded for a particular table.", + "items": { + "type": "string" + }, + "type": "array" + }, + "includeColumns": { + "description": "Optional. List of columns to be included for a particular table.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ForwardSshTunnelConnectivity": { "description": "Forward SSH Tunnel connectivity.", "id": "ForwardSshTunnelConnectivity", "properties": { @@ -3279,18 +3775,18 @@ "id": "ImportMappingRulesRequest", "properties": { "autoCommit": { - "description": "Should the conversion workspace be committed automatically after the import operation.", + "description": "Required. Should the conversion workspace be committed automatically after the import operation.", "type": "boolean" }, "rulesFiles": { - "description": "One or more rules files.", + "description": "Required. One or more rules files.", "items": { "$ref": "RulesFile" }, "type": "array" }, "rulesFormat": { - "description": "The format of the rules content file.", + "description": "Required. The format of the rules content file.", "enum": [ "IMPORT_RULES_FILE_FORMAT_UNSPECIFIED", "IMPORT_RULES_FILE_FORMAT_HARBOUR_BRIDGE_SESSION_FILE", @@ -3311,7 +3807,7 @@ "id": "ImportRulesJobDetails", "properties": { "fileFormat": { - "description": "The requested file format.", + "description": "Output only. The requested file format.", "enum": [ "IMPORT_RULES_FILE_FORMAT_UNSPECIFIED", "IMPORT_RULES_FILE_FORMAT_HARBOUR_BRIDGE_SESSION_FILE", @@ -3322,13 +3818,15 @@ "HarbourBridge session file.", "Ora2Pg configuration file." ], + "readOnly": true, "type": "string" }, "files": { - "description": "File names used for the import rules job.", + "description": "Output only. File names used for the import rules job.", "items": { "type": "string" }, + "readOnly": true, "type": "array" } }, @@ -3368,6 +3866,36 @@ }, "type": "object" }, + "IntComparisonFilter": { + "description": "Filter based on relation between source value and compare value of type integer in ConditionalColumnSetValue", + "id": "IntComparisonFilter", + "properties": { + "value": { + "description": "Required. Integer compare value to be used", + "format": "int64", + "type": "string" + }, + "valueComparison": { + "description": "Required. Relation between source value and compare value", + "enum": [ + "VALUE_COMPARISON_UNSPECIFIED", + "VALUE_COMPARISON_IF_VALUE_SMALLER_THAN", + "VALUE_COMPARISON_IF_VALUE_SMALLER_EQUAL_THAN", + "VALUE_COMPARISON_IF_VALUE_LARGER_THAN", + "VALUE_COMPARISON_IF_VALUE_LARGER_EQUAL_THAN" + ], + "enumDescriptions": [ + "Value comparison unspecified.", + "Value is smaller than the Compare value.", + "Value is smaller or equal than the Compare value.", + "Value is larger than the Compare value.", + "Value is larger or equal than the Compare value." + ], + "type": "string" + } + }, + "type": "object" + }, "ListConnectionProfilesResponse": { "description": "Response message for 'ListConnectionProfiles' request.", "id": "ListConnectionProfilesResponse", @@ -3436,6 +3964,24 @@ }, "type": "object" }, + "ListMappingRulesResponse": { + "description": "Response message for 'ListMappingRulesRequest' request.", + "id": "ListMappingRulesResponse", + "properties": { + "mappingRules": { + "description": "The list of conversion workspace mapping rules.", + "items": { + "$ref": "MappingRule" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, "ListMigrationJobsResponse": { "description": "Response message for 'ListMigrationJobs' request.", "id": "ListMigrationJobsResponse", @@ -3550,6 +4096,190 @@ }, "type": "object" }, + "MappingRule": { + "description": "Definition of a transformation that is to be applied to a group of entities in the source schema. Several such transformations can be applied to an entity sequentially to define the corresponding entity in the target schema.", + "id": "MappingRule", + "properties": { + "conditionalColumnSetValue": { + "$ref": "ConditionalColumnSetValue", + "description": "Optional. Rule to specify how the data contained in a column should be transformed (such as trimmed, rounded, etc) provided that the data meets certain criteria." + }, + "convertRowidColumn": { + "$ref": "ConvertRowIdToColumn", + "description": "Optional. Rule to specify how multiple tables should be converted with an additional rowid column." + }, + "displayName": { + "description": "Optional. A human readable name", + "type": "string" + }, + "entityMove": { + "$ref": "EntityMove", + "description": "Optional. Rule to specify how multiple entities should be relocated into a different schema." + }, + "filter": { + "$ref": "MappingRuleFilter", + "description": "Required. The rule filter" + }, + "filterTableColumns": { + "$ref": "FilterTableColumns", + "description": "Optional. Rule to specify the list of columns to include or exclude from a table." + }, + "multiColumnDataTypeChange": { + "$ref": "MultiColumnDatatypeChange", + "description": "Optional. Rule to specify how multiple columns should be converted to a different data type." + }, + "multiEntityRename": { + "$ref": "MultiEntityRename", + "description": "Optional. Rule to specify how multiple entities should be renamed." + }, + "name": { + "description": "Full name of the mapping rule resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{set}/mappingRule/{rule}.", + "type": "string" + }, + "revisionCreateTime": { + "description": "Output only. The timestamp that the revision was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "revisionId": { + "description": "Output only. The revision ID of the mapping rule. A new revision is committed whenever the mapping rule is changed in any way. The format is an 8-character hexadecimal string.", + "readOnly": true, + "type": "string" + }, + "ruleOrder": { + "description": "Required. The order in which the rule is applied. Lower order rules are applied before higher value rules so they may end up being overridden.", + "format": "int64", + "type": "string" + }, + "ruleScope": { + "description": "Required. The rule scope", + "enum": [ + "DATABASE_ENTITY_TYPE_UNSPECIFIED", + "DATABASE_ENTITY_TYPE_SCHEMA", + "DATABASE_ENTITY_TYPE_TABLE", + "DATABASE_ENTITY_TYPE_COLUMN", + "DATABASE_ENTITY_TYPE_CONSTRAINT", + "DATABASE_ENTITY_TYPE_INDEX", + "DATABASE_ENTITY_TYPE_TRIGGER", + "DATABASE_ENTITY_TYPE_VIEW", + "DATABASE_ENTITY_TYPE_SEQUENCE", + "DATABASE_ENTITY_TYPE_STORED_PROCEDURE", + "DATABASE_ENTITY_TYPE_FUNCTION", + "DATABASE_ENTITY_TYPE_SYNONYM", + "DATABASE_ENTITY_TYPE_DATABASE_PACKAGE", + "DATABASE_ENTITY_TYPE_UDT", + "DATABASE_ENTITY_TYPE_MATERIALIZED_VIEW", + "DATABASE_ENTITY_TYPE_DATABASE" + ], + "enumDescriptions": [ + "Unspecified database entity type.", + "Schema.", + "Table.", + "Column.", + "Constraint.", + "Index.", + "Trigger.", + "View.", + "Sequence.", + "Stored Procedure.", + "Function.", + "Synonym.", + "Package.", + "UDT.", + "Materialized View.", + "Database." + ], + "type": "string" + }, + "setTablePrimaryKey": { + "$ref": "SetTablePrimaryKey", + "description": "Optional. Rule to specify the primary key for a table" + }, + "singleColumnChange": { + "$ref": "SingleColumnChange", + "description": "Optional. Rule to specify how a single column is converted." + }, + "singleEntityRename": { + "$ref": "SingleEntityRename", + "description": "Optional. Rule to specify how a single entity should be renamed." + }, + "singlePackageChange": { + "$ref": "SinglePackageChange", + "description": "Optional. Rule to specify how a single package is converted." + }, + "sourceSqlChange": { + "$ref": "SourceSqlChange", + "description": "Optional. Rule to change the sql code for an entity, for example, function, procedure." + }, + "state": { + "description": "Optional. The mapping rule state", + "enum": [ + "STATE_UNSPECIFIED", + "ENABLED", + "DISABLED", + "DELETED" + ], + "enumDescriptions": [ + "The state of the mapping rule is unknown.", + "The rule is enabled.", + "The rule is disabled.", + "The rule is logically deleted." + ], + "type": "string" + } + }, + "type": "object" + }, + "MappingRuleFilter": { + "description": "A filter defining the entities that a mapping rule should be applied to. When more than one field is specified, the rule is applied only to entities which match all the fields.", + "id": "MappingRuleFilter", + "properties": { + "entities": { + "description": "Optional. The rule should be applied to specific entities defined by their fully qualified names.", + "items": { + "type": "string" + }, + "type": "array" + }, + "entityNameContains": { + "description": "Optional. The rule should be applied to entities whose non-qualified name contains the given string.", + "type": "string" + }, + "entityNamePrefix": { + "description": "Optional. The rule should be applied to entities whose non-qualified name starts with the given prefix.", + "type": "string" + }, + "entityNameSuffix": { + "description": "Optional. The rule should be applied to entities whose non-qualified name ends with the given suffix.", + "type": "string" + }, + "parentEntity": { + "description": "Optional. The rule should be applied to entities whose parent entity (fully qualified name) matches the given value. For example, if the rule applies to a table entity, the expected value should be a schema (schema). If the rule applies to a column or index entity, the expected value can be either a schema (schema) or a table (schema.table)", + "type": "string" + } + }, + "type": "object" + }, + "MaterializedViewEntity": { + "description": "MaterializedView's parent is a schema.", + "id": "MaterializedViewEntity", + "properties": { + "customFeatures": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Custom engine specific features.", + "type": "object" + }, + "sqlCode": { + "description": "The SQL code which creates the view.", + "type": "string" + } + }, + "type": "object" + }, "MigrationJob": { "description": "Represents a Database Migration Service migration job object.", "id": "MigrationJob", @@ -3751,11 +4481,13 @@ "UNSUPPORTED_TABLE_DEFINITION", "UNSUPPORTED_DEFINER", "CANT_RESTART_RUNNING_MIGRATION", + "SOURCE_ALREADY_SETUP", "TABLES_WITH_LIMITED_SUPPORT", "UNSUPPORTED_DATABASE_LOCALE", "UNSUPPORTED_DATABASE_FDW_CONFIG", "ERROR_RDBMS", - "SOURCE_SIZE_EXCEEDS_THRESHOLD" + "SOURCE_SIZE_EXCEEDS_THRESHOLD", + "EXISTING_CONFLICTING_DATABASES" ], "enumDescriptions": [ "An unknown error occurred", @@ -3778,11 +4510,13 @@ "The table definition is not support due to missing primary key or replica identity.", "The definer is not supported.", "Migration is already running at the time of restart request.", + "The source already has a replication setup.", "The source has tables with limited support. E.g. PostgreSQL tables without primary keys.", "The source uses an unsupported locale.", "The source uses an unsupported Foreign Data Wrapper configuration.", "There was an underlying RDBMS error.", - "The source DB size in Bytes exceeds a certain threshold. The migration might require an increase of quota, or might not be supported." + "The source DB size in Bytes exceeds a certain threshold. The migration might require an increase of quota, or might not be supported.", + "The destination DB contains existing databases that are conflicting with those in the source DB." ], "readOnly": true, "type": "string" @@ -3800,6 +4534,86 @@ }, "type": "object" }, + "MultiColumnDatatypeChange": { + "description": "Options to configure rule type MultiColumnDatatypeChange. The rule is used to change the data type and associated properties of multiple columns at once. The rule filter field can refer to one or more entities. The rule scope can be one of:Column. This rule requires additional filters to be specified beyond the basic rule filter field, which is the source data type, but the rule supports additional filtering capabilities such as the minimum and maximum field length. All additional filters which are specified are required to be met in order for the rule to be applied (logical AND between the fields).", + "id": "MultiColumnDatatypeChange", + "properties": { + "customFeatures": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Custom engine specific features.", + "type": "object" + }, + "newDataType": { + "description": "Required. New data type.", + "type": "string" + }, + "overrideFractionalSecondsPrecision": { + "description": "Optional. Column fractional seconds precision - used only for timestamp based datatypes - if not specified and relevant uses the source column fractional seconds precision.", + "format": "int32", + "type": "integer" + }, + "overrideLength": { + "description": "Optional. Column length - e.g. varchar (50) - if not specified and relevant uses the source column length.", + "format": "int64", + "type": "string" + }, + "overridePrecision": { + "description": "Optional. Column precision - when relevant - if not specified and relevant uses the source column precision.", + "format": "int32", + "type": "integer" + }, + "overrideScale": { + "description": "Optional. Column scale - when relevant - if not specified and relevant uses the source column scale.", + "format": "int32", + "type": "integer" + }, + "sourceDataTypeFilter": { + "description": "Required. Filter on source data type.", + "type": "string" + }, + "sourceNumericFilter": { + "$ref": "SourceNumericFilter", + "description": "Optional. Filter for fixed point number data types such as NUMERIC/NUMBER." + }, + "sourceTextFilter": { + "$ref": "SourceTextFilter", + "description": "Optional. Filter for text-based data types like varchar." + } + }, + "type": "object" + }, + "MultiEntityRename": { + "description": "Options to configure rule type MultiEntityRename. The rule is used to rename multiple entities. The rule filter field can refer to one or more entities. The rule scope can be one of: Database, Schema, Table, Column, Constraint, Index, View, Function, Stored Procedure, Materialized View, Sequence, UDT", + "id": "MultiEntityRename", + "properties": { + "newNamePattern": { + "description": "Optional. The pattern used to generate the new entity's name. This pattern must include the characters '{name}', which will be replaced with the name of the original entity. For example, the pattern 't_{name}' for an entity name jobs would be converted to 't_jobs'. If unspecified, the default value for this field is '{name}'", + "type": "string" + }, + "sourceNameTransformation": { + "description": "Optional. Additional transformation that can be done on the source entity name before it is being used by the new_name_pattern, for example lower case. If no transformation is desired, use NO_TRANSFORMATION", + "enum": [ + "ENTITY_NAME_TRANSFORMATION_UNSPECIFIED", + "ENTITY_NAME_TRANSFORMATION_NO_TRANSFORMATION", + "ENTITY_NAME_TRANSFORMATION_LOWER_CASE", + "ENTITY_NAME_TRANSFORMATION_UPPER_CASE", + "ENTITY_NAME_TRANSFORMATION_CAPITALIZED_CASE" + ], + "enumDescriptions": [ + "Entity name transformation unspecified.", + "No transformation.", + "Transform to lower case.", + "Transform to upper case.", + "Transform to capitalized case." + ], + "type": "string" + } + }, + "type": "object" + }, "MySqlConnectionProfile": { "description": "Specifies connection parameters required specifically for MySQL databases.", "id": "MySqlConnectionProfile", @@ -3975,6 +4789,33 @@ }, "type": "object" }, + "Position": { + "description": "Issue position.", + "id": "Position", + "properties": { + "column": { + "description": "Issue column number", + "format": "int32", + "type": "integer" + }, + "length": { + "description": "Issue length", + "format": "int32", + "type": "integer" + }, + "line": { + "description": "Issue line number", + "format": "int32", + "type": "integer" + }, + "offset": { + "description": "Issue offset", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "PostgreSqlConnectionProfile": { "description": "Specifies connection parameters required specifically for PostgreSQL databases.", "id": "PostgreSqlConnectionProfile", @@ -4205,16 +5046,28 @@ "properties": {}, "type": "object" }, + "RoundToScale": { + "description": "This allows the data to change scale, for example if the source is 2 digits after the decimal point, specify round to scale value = 2. If for example the value needs to be converted to an integer, use round to scale value = 0.", + "id": "RoundToScale", + "properties": { + "scale": { + "description": "Required. Scale value to be used", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "RulesFile": { "description": "Details of a single rules file.", "id": "RulesFile", "properties": { "rulesContent": { - "description": "The text content of the rules that needs to be converted.", + "description": "Required. The text content of the rules that needs to be converted.", "type": "string" }, "rulesSourceFilename": { - "description": "The filename of the rules that needs to be converted. The filename is used mainly so that future logs of the import rules job contain it, and can therefore be searched by it.", + "description": "Required. The filename of the rules that needs to be converted. The filename is used mainly so that future logs of the import rules job contain it, and can therefore be searched by it.", "type": "string" } }, @@ -4258,11 +5111,11 @@ "type": "boolean" }, "destinationConnectionProfile": { - "description": "Fully qualified (Uri) name of the destination connection profile.", + "description": "Optional. Fully qualified (Uri) name of the destination connection profile.", "type": "string" }, "sourceConnectionProfile": { - "description": "Fully qualified (Uri) name of the source connection profile.", + "description": "Optional. Fully qualified (Uri) name of the source connection profile.", "type": "string" } }, @@ -4273,7 +5126,8 @@ "id": "SeedJobDetails", "properties": { "connectionProfile": { - "description": "The connection profile which was used for the seed job.", + "description": "Output only. The connection profile which was used for the seed job.", + "readOnly": true, "type": "string" } }, @@ -4339,6 +5193,200 @@ }, "type": "object" }, + "SetTablePrimaryKey": { + "description": "Options to configure rule type SetTablePrimaryKey. The rule is used to specify the columns and name to configure/alter the primary key of a table. The rule filter field can refer to one entity. The rule scope can be one of: Table.", + "id": "SetTablePrimaryKey", + "properties": { + "primaryKey": { + "description": "Optional. Name for the primary key", + "type": "string" + }, + "primaryKeyColumns": { + "description": "Required. List of column names for the primary key", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "SingleColumnChange": { + "description": "Options to configure rule type SingleColumnChange. The rule is used to change the properties of a column. The rule filter field can refer to one entity. The rule scope can be one of: Column. When using this rule, if a field is not specified than the destination column's configuration will be the same as the one in the source column..", + "id": "SingleColumnChange", + "properties": { + "array": { + "description": "Optional. Is the column of array type.", + "type": "boolean" + }, + "arrayLength": { + "description": "Optional. The length of the array, only relevant if the column type is an array.", + "format": "int32", + "type": "integer" + }, + "autoGenerated": { + "description": "Optional. Is the column auto-generated/identity.", + "type": "boolean" + }, + "charset": { + "description": "Optional. Charset override - instead of table level charset.", + "type": "string" + }, + "collation": { + "description": "Optional. Collation override - instead of table level collation.", + "type": "string" + }, + "comment": { + "description": "Optional. Comment associated with the column.", + "type": "string" + }, + "customFeatures": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Custom engine specific features.", + "type": "object" + }, + "dataType": { + "description": "Optional. Column data type name.", + "type": "string" + }, + "fractionalSecondsPrecision": { + "description": "Optional. Column fractional seconds precision - e.g. 2 as in timestamp (2) - when relevant.", + "format": "int32", + "type": "integer" + }, + "length": { + "description": "Optional. Column length - e.g. 50 as in varchar (50) - when relevant.", + "format": "int64", + "type": "string" + }, + "nullable": { + "description": "Optional. Is the column nullable.", + "type": "boolean" + }, + "precision": { + "description": "Optional. Column precision - e.g. 8 as in double (8,2) - when relevant.", + "format": "int32", + "type": "integer" + }, + "scale": { + "description": "Optional. Column scale - e.g. 2 as in double (8,2) - when relevant.", + "format": "int32", + "type": "integer" + }, + "setValues": { + "description": "Optional. Specifies the list of values allowed in the column.", + "items": { + "type": "string" + }, + "type": "array" + }, + "udt": { + "description": "Optional. Is the column a UDT (User-defined Type).", + "type": "boolean" + } + }, + "type": "object" + }, + "SingleEntityRename": { + "description": "Options to configure rule type SingleEntityRename. The rule is used to rename an entity. The rule filter field can refer to only one entity. The rule scope can be one of: Database, Schema, Table, Column, Constraint, Index, View, Function, Stored Procedure, Materialized View, Sequence, UDT, Synonym", + "id": "SingleEntityRename", + "properties": { + "newName": { + "description": "Required. The new name of the destination entity", + "type": "string" + } + }, + "type": "object" + }, + "SinglePackageChange": { + "description": "Options to configure rule type SinglePackageChange. The rule is used to alter the sql code for a package entities. The rule filter field can refer to one entity. The rule scope can be: Package", + "id": "SinglePackageChange", + "properties": { + "packageBody": { + "description": "Optional. Sql code for package body", + "type": "string" + }, + "packageDescription": { + "description": "Optional. Sql code for package description", + "type": "string" + } + }, + "type": "object" + }, + "SourceNumericFilter": { + "description": "Filter for fixed point number data types such as NUMERIC/NUMBER", + "id": "SourceNumericFilter", + "properties": { + "numericFilterOption": { + "description": "Required. Enum to set the option defining the datatypes numeric filter has to be applied to", + "enum": [ + "NUMERIC_FILTER_OPTION_UNSPECIFIED", + "NUMERIC_FILTER_OPTION_ALL", + "NUMERIC_FILTER_OPTION_LIMIT", + "NUMERIC_FILTER_OPTION_LIMITLESS" + ], + "enumDescriptions": [ + "Numeric filter option unspecified", + "Numeric filter option that matches all numeric columns.", + "Numeric filter option that matches columns having numeric datatypes with specified precision and scale within the limited range of filter.", + "Numeric filter option that matches only the numeric columns with no precision and scale specified." + ], + "type": "string" + }, + "sourceMaxPrecisionFilter": { + "description": "Optional. The filter will match columns with precision smaller than or equal to this number.", + "format": "int32", + "type": "integer" + }, + "sourceMaxScaleFilter": { + "description": "Optional. The filter will match columns with scale smaller than or equal to this number.", + "format": "int32", + "type": "integer" + }, + "sourceMinPrecisionFilter": { + "description": "Optional. The filter will match columns with precision greater than or equal to this number.", + "format": "int32", + "type": "integer" + }, + "sourceMinScaleFilter": { + "description": "Optional. The filter will match columns with scale greater than or equal to this number.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "SourceSqlChange": { + "description": "Options to configure rule type SourceSqlChange. The rule is used to alter the sql code for database entities. The rule filter field can refer to one entity. The rule scope can be: StoredProcedure, Function, Trigger, View", + "id": "SourceSqlChange", + "properties": { + "sqlCode": { + "description": "Required. Sql code for source (stored procedure, function, trigger or view)", + "type": "string" + } + }, + "type": "object" + }, + "SourceTextFilter": { + "description": "Filter for text-based data types like varchar.", + "id": "SourceTextFilter", + "properties": { + "sourceMaxLengthFilter": { + "description": "Optional. The filter will match columns with length smaller than or equal to this number.", + "format": "int64", + "type": "string" + }, + "sourceMinLengthFilter": { + "description": "Optional. The filter will match columns with length greater than or equal to this number.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "SqlAclEntry": { "description": "An entry for an Access Control list.", "id": "SqlAclEntry", @@ -4688,6 +5736,29 @@ }, "type": "object" }, + "UDTEntity": { + "description": "UDT's parent is a schema.", + "id": "UDTEntity", + "properties": { + "customFeatures": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Custom engine specific features.", + "type": "object" + }, + "udtBody": { + "description": "The SQL code which creates the udt body.", + "type": "string" + }, + "udtSqlCode": { + "description": "The SQL code which creates the udt.", + "type": "string" + } + }, + "type": "object" + }, "UserPassword": { "description": "The username/password for a database user. Used for specifying initial users at cluster creation time.", "id": "UserPassword", @@ -4708,10 +5779,99 @@ }, "type": "object" }, + "ValueListFilter": { + "description": "A list of values to filter by in ConditionalColumnSetValue", + "id": "ValueListFilter", + "properties": { + "ignoreCase": { + "description": "Required. Whether to ignore case when filtering by values. Defaults to false", + "type": "boolean" + }, + "valuePresentList": { + "description": "Required. Indicates whether the filter matches rows with values that are present in the list or those with values not present in it.", + "enum": [ + "VALUE_PRESENT_IN_LIST_UNSPECIFIED", + "VALUE_PRESENT_IN_LIST_IF_VALUE_LIST", + "VALUE_PRESENT_IN_LIST_IF_VALUE_NOT_LIST" + ], + "enumDescriptions": [ + "Value present in list unspecified", + "If the source value is in the supplied list at value_list", + "If the source value is not in the supplied list at value_list" + ], + "type": "string" + }, + "values": { + "description": "Required. The list to be used to filter by", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ValueTransformation": { + "description": "Description of data transformation during migration as part of the ConditionalColumnSetValue.", + "id": "ValueTransformation", + "properties": { + "applyHash": { + "$ref": "ApplyHash", + "description": "Optional. Applies a hash function on the data" + }, + "assignMaxValue": { + "$ref": "Empty", + "description": "Optional. Set to max_value - if integer or numeric, will use int.maxvalue, etc" + }, + "assignMinValue": { + "$ref": "Empty", + "description": "Optional. Set to min_value - if integer or numeric, will use int.minvalue, etc" + }, + "assignNull": { + "$ref": "Empty", + "description": "Optional. Set to null" + }, + "assignSpecificValue": { + "$ref": "AssignSpecificValue", + "description": "Optional. Set to a specific value (value is converted to fit the target data type)" + }, + "doubleComparison": { + "$ref": "DoubleComparisonFilter", + "description": "Optional. Filter on relation between source value and compare value of type double." + }, + "intComparison": { + "$ref": "IntComparisonFilter", + "description": "Optional. Filter on relation between source value and compare value of type integer." + }, + "isNull": { + "$ref": "Empty", + "description": "Optional. Value is null" + }, + "roundScale": { + "$ref": "RoundToScale", + "description": "Optional. Allows the data to change scale" + }, + "valueList": { + "$ref": "ValueListFilter", + "description": "Optional. Value is found in the specified list." + } + }, + "type": "object" + }, "VerifyMigrationJobRequest": { "description": "Request message for 'VerifyMigrationJob' request.", "id": "VerifyMigrationJobRequest", - "properties": {}, + "properties": { + "migrationJob": { + "$ref": "MigrationJob", + "description": "Optional. The changed migration job parameters to verify. It will not update the migration job." + }, + "updateMask": { + "description": "Optional. Field mask is used to specify the changed fields to be verified. It will not update the migration job.", + "format": "google-fieldmask", + "type": "string" + } + }, "type": "object" }, "ViewEntity": { diff --git a/googleapiclient/discovery_cache/documents/datamigration.v1beta1.json b/googleapiclient/discovery_cache/documents/datamigration.v1beta1.json index df705a493e1..0d42f596f47 100644 --- a/googleapiclient/discovery_cache/documents/datamigration.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/datamigration.v1beta1.json @@ -1049,7 +1049,7 @@ } } }, - "revision": "20230622", + "revision": "20230703", "rootUrl": "https://datamigration.googleapis.com/", "schemas": { "AuditConfig": { @@ -1771,7 +1771,8 @@ "UNSUPPORTED_DATABASE_LOCALE", "UNSUPPORTED_DATABASE_FDW_CONFIG", "ERROR_RDBMS", - "SOURCE_SIZE_EXCEEDS_THRESHOLD" + "SOURCE_SIZE_EXCEEDS_THRESHOLD", + "EXISTING_CONFLICTING_DATABASES" ], "enumDescriptions": [ "An unknown error occurred", @@ -1787,7 +1788,8 @@ "The source uses an unsupported locale.", "The source uses an unsupported Foreign Data Wrapper configuration.", "There was an underlying RDBMS error.", - "The source DB size in Bytes exceeds a certain threshold. The migration might require an increase of quota, or might not be supported." + "The source DB size in Bytes exceeds a certain threshold. The migration might require an increase of quota, or might not be supported.", + "The destination DB contains existing databases that are conflicting with those in the source DB." ], "readOnly": true, "type": "string" diff --git a/googleapiclient/discovery_cache/documents/datapipelines.v1.json b/googleapiclient/discovery_cache/documents/datapipelines.v1.json index affa4ca31e4..b258842c046 100644 --- a/googleapiclient/discovery_cache/documents/datapipelines.v1.json +++ b/googleapiclient/discovery_cache/documents/datapipelines.v1.json @@ -369,7 +369,7 @@ } } }, - "revision": "20230625", + "revision": "20230702", "rootUrl": "https://datapipelines.googleapis.com/", "schemas": { "GoogleCloudDatapipelinesV1DataflowJobDetails": { diff --git a/googleapiclient/discovery_cache/documents/dataplex.v1.json b/googleapiclient/discovery_cache/documents/dataplex.v1.json index 3d5e03e475c..8f46a8c793d 100644 --- a/googleapiclient/discovery_cache/documents/dataplex.v1.json +++ b/googleapiclient/discovery_cache/documents/dataplex.v1.json @@ -4269,7 +4269,7 @@ } } }, - "revision": "20230626", + "revision": "20230628", "rootUrl": "https://dataplex.googleapis.com/", "schemas": { "Empty": { @@ -5629,6 +5629,107 @@ "properties": {}, "type": "object" }, + "GoogleCloudDataplexV1DataQualityScanRuleResult": { + "description": "Information about the result of a data quality rule for data quality scan. The monitored resource is 'DataScan'.", + "id": "GoogleCloudDataplexV1DataQualityScanRuleResult", + "properties": { + "column": { + "description": "The column which this rule is evaluated against.", + "type": "string" + }, + "dataSource": { + "description": "The data source of the data scan (e.g. BigQuery table name).", + "type": "string" + }, + "evaluatedRowCount": { + "description": "The number of rows evaluated against the data quality rule. This field is only valid for rules of PER_ROW evaluation type.", + "format": "int64", + "type": "string" + }, + "evalutionType": { + "description": "The evaluation type of the data quality rule.", + "enum": [ + "EVALUATION_TYPE_UNSPECIFIED", + "PER_ROW", + "AGGREGATE" + ], + "enumDescriptions": [ + "An unspecified evaluation type.", + "The rule evaluation is done at per row level.", + "The rule evaluation is done for an aggregate of rows." + ], + "type": "string" + }, + "jobId": { + "description": "Identifier of the specific data scan job this log entry is for.", + "type": "string" + }, + "nullRowCount": { + "description": "The number of rows with null values in the specified column.", + "format": "int64", + "type": "string" + }, + "passedRowCount": { + "description": "The number of rows which passed a rule evaluation. This field is only valid for rules of PER_ROW evaluation type.", + "format": "int64", + "type": "string" + }, + "result": { + "description": "The result of the data quality rule.", + "enum": [ + "RESULT_UNSPECIFIED", + "PASSED", + "FAILED" + ], + "enumDescriptions": [ + "An unspecified result.", + "The data quality rule passed.", + "The data quality rule failed." + ], + "type": "string" + }, + "ruleDimension": { + "description": "The dimension of the data quality rule.", + "type": "string" + }, + "ruleName": { + "description": "The name of the data quality rule.", + "type": "string" + }, + "ruleType": { + "description": "The type of the data quality rule.", + "enum": [ + "RULE_TYPE_UNSPECIFIED", + "NON_NULL_EXPECTATION", + "RANGE_EXPECTATION", + "REGEX_EXPECTATION", + "ROW_CONDITION_EXPECTATION", + "SET_EXPECTATION", + "STATISTIC_RANGE_EXPECTATION", + "TABLE_CONDITION_EXPECTATION", + "UNIQUENESS_EXPECTATION" + ], + "enumDescriptions": [ + "An unspecified rule type.", + "Please see https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualityRule#nonnullexpectation.", + "Please see https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualityRule#rangeexpectation.", + "Please see https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualityRule#regexexpectation.", + "Please see https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualityRule#rowconditionexpectation.", + "Please see https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualityRule#setexpectation.", + "Please see https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualityRule#statisticrangeexpectation.", + "Please see https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualityRule#tableconditionexpectation.", + "Please see https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualityRule#uniquenessexpectation." + ], + "type": "string" + }, + "thresholdPercent": { + "description": "The passing threshold (0.0, 100.0) of the data quality rule.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, "GoogleCloudDataplexV1DataQualitySpec": { "description": "DataQualityScan related setting.", "id": "GoogleCloudDataplexV1DataQualitySpec", @@ -6472,7 +6573,7 @@ "type": "object" }, "GoogleCloudDataplexV1Environment": { - "description": "Environment represents a user-visible compute infrastructure for analytics within a lake. LINT.IfChange", + "description": "Environment represents a user-visible compute infrastructure for analytics within a lake.", "id": "GoogleCloudDataplexV1Environment", "properties": { "createTime": { diff --git a/googleapiclient/discovery_cache/documents/dataproc.v1.json b/googleapiclient/discovery_cache/documents/dataproc.v1.json index f89051657ca..e5f0efa34cc 100644 --- a/googleapiclient/discovery_cache/documents/dataproc.v1.json +++ b/googleapiclient/discovery_cache/documents/dataproc.v1.json @@ -2671,7 +2671,7 @@ } } }, - "revision": "20230622", + "revision": "20230630", "rootUrl": "https://dataproc.googleapis.com/", "schemas": { "AcceleratorConfig": { diff --git a/googleapiclient/discovery_cache/documents/datastream.v1.json b/googleapiclient/discovery_cache/documents/datastream.v1.json index 7db2154b3a5..6687c7abcd3 100644 --- a/googleapiclient/discovery_cache/documents/datastream.v1.json +++ b/googleapiclient/discovery_cache/documents/datastream.v1.json @@ -1233,7 +1233,7 @@ } } }, - "revision": "20230611", + "revision": "20230620", "rootUrl": "https://datastream.googleapis.com/", "schemas": { "AvroFileFormat": { diff --git a/googleapiclient/discovery_cache/documents/datastream.v1alpha1.json b/googleapiclient/discovery_cache/documents/datastream.v1alpha1.json index 402f0136dde..edef3315d76 100644 --- a/googleapiclient/discovery_cache/documents/datastream.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/datastream.v1alpha1.json @@ -1224,7 +1224,7 @@ } } }, - "revision": "20230611", + "revision": "20230620", "rootUrl": "https://datastream.googleapis.com/", "schemas": { "AvroFileFormat": { @@ -1576,6 +1576,7 @@ "type": "integer" }, "gcsFileFormat": { + "deprecated": true, "description": "File format that data should be written in. Deprecated field (b/169501737) - use file_format instead.", "enum": [ "GCS_FILE_FORMAT_UNSPECIFIED", diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v2.json b/googleapiclient/discovery_cache/documents/dialogflow.v2.json index 0a645032bd9..e660f0f226b 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v2.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v2.json @@ -8211,7 +8211,7 @@ } } }, - "revision": "20230630", + "revision": "20230707", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AudioInput": { @@ -8606,13 +8606,17 @@ "id": "GoogleCloudDialogflowCxV3ExportAgentResponse", "properties": { "agentContent": { - "description": "Uncompressed raw byte content for agent.", + "description": "Uncompressed raw byte content for agent. This field is populated if none of `agent_uri` and `git_destination` are specified in ExportAgentRequest.", "format": "byte", "type": "string" }, "agentUri": { "description": "The URI to a file containing the exported agent. This field is populated if `agent_uri` is specified in ExportAgentRequest.", "type": "string" + }, + "commitSha": { + "description": "Commit SHA of the git push. This field is populated if `git_destination` are specified in ExportAgentRequest.", + "type": "string" } }, "type": "object" @@ -9883,6 +9887,7 @@ "type": "object" }, "password": { + "deprecated": true, "description": "The password for HTTP Basic authentication.", "type": "string" }, @@ -9902,6 +9907,7 @@ "type": "string" }, "username": { + "deprecated": true, "description": "The user name for HTTP Basic authentication.", "type": "string" }, @@ -10532,13 +10538,17 @@ "id": "GoogleCloudDialogflowCxV3beta1ExportAgentResponse", "properties": { "agentContent": { - "description": "Uncompressed raw byte content for agent.", + "description": "Uncompressed raw byte content for agent. This field is populated if none of `agent_uri` and `git_destination` are specified in ExportAgentRequest.", "format": "byte", "type": "string" }, "agentUri": { "description": "The URI to a file containing the exported agent. This field is populated if `agent_uri` is specified in ExportAgentRequest.", "type": "string" + }, + "commitSha": { + "description": "Commit SHA of the git push. This field is populated if `git_destination` are specified in ExportAgentRequest.", + "type": "string" } }, "type": "object" @@ -11809,6 +11819,7 @@ "type": "object" }, "password": { + "deprecated": true, "description": "The password for HTTP Basic authentication.", "type": "string" }, @@ -11828,6 +11839,7 @@ "type": "string" }, "username": { + "deprecated": true, "description": "The user name for HTTP Basic authentication.", "type": "string" }, @@ -12112,6 +12124,7 @@ "type": "boolean" }, "matchMode": { + "deprecated": true, "description": "Optional. Determines how intents are detected from user queries.", "enum": [ "MATCH_MODE_UNSPECIFIED", @@ -12144,6 +12157,12 @@ "TIER_ENTERPRISE", "TIER_ENTERPRISE_PLUS" ], + "enumDeprecated": [ + false, + false, + false, + true + ], "enumDescriptions": [ "Not specified. This value should never be used.", "Trial Edition, previously known as Standard Edition.", @@ -13885,6 +13904,7 @@ "id": "GoogleCloudDialogflowV2FulfillmentGenericWebService", "properties": { "isCloudFunction": { + "deprecated": true, "description": "Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now.", "type": "boolean" }, @@ -14505,6 +14525,7 @@ "type": "string" }, "phraseHints": { + "deprecated": true, "description": "A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details. This field is deprecated. Please use [speech_contexts]() instead. If you specify both [phrase_hints]() and [speech_contexts](), Dialogflow will treat the [phrase_hints]() as a single additional [SpeechContext]().", "items": { "type": "string" @@ -15443,6 +15464,11 @@ "EXAMPLE", "TEMPLATE" ], + "enumDeprecated": [ + false, + false, + true + ], "enumDescriptions": [ "Not specified. This value should never be used.", "Examples do not contain @-prefixed entity type names, but example parts can be annotated with entity types.", @@ -17596,6 +17622,7 @@ "type": "boolean" }, "mlEnabled": { + "deprecated": true, "description": "Optional. Indicates whether Machine Learning is enabled for the intent. Note: If `ml_enabled` setting is set to false, then this intent is not taken into account during inference in `ML ONLY` match mode. Also, auto-markup in the UI is turned off. DEPRECATED! Please use `ml_disabled` field instead. NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false, then the default value is determined as follows: - Before April 15th, 2018 the default is: ml_enabled = false / ml_disabled = true. - After April 15th, 2018 the default is: ml_enabled = true / ml_disabled = false.", "type": "boolean" }, @@ -18697,6 +18724,11 @@ "EXAMPLE", "TEMPLATE" ], + "enumDeprecated": [ + false, + false, + true + ], "enumDescriptions": [ "Not specified. This value should never be used.", "Examples do not contain @-prefixed entity type names, but example parts can be annotated with entity types.", diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json b/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json index bf17b9f373c..2854dd3b88d 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json @@ -7579,7 +7579,7 @@ } } }, - "revision": "20230630", + "revision": "20230707", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AudioInput": { @@ -7974,13 +7974,17 @@ "id": "GoogleCloudDialogflowCxV3ExportAgentResponse", "properties": { "agentContent": { - "description": "Uncompressed raw byte content for agent.", + "description": "Uncompressed raw byte content for agent. This field is populated if none of `agent_uri` and `git_destination` are specified in ExportAgentRequest.", "format": "byte", "type": "string" }, "agentUri": { "description": "The URI to a file containing the exported agent. This field is populated if `agent_uri` is specified in ExportAgentRequest.", "type": "string" + }, + "commitSha": { + "description": "Commit SHA of the git push. This field is populated if `git_destination` are specified in ExportAgentRequest.", + "type": "string" } }, "type": "object" @@ -9251,6 +9255,7 @@ "type": "object" }, "password": { + "deprecated": true, "description": "The password for HTTP Basic authentication.", "type": "string" }, @@ -9270,6 +9275,7 @@ "type": "string" }, "username": { + "deprecated": true, "description": "The user name for HTTP Basic authentication.", "type": "string" }, @@ -9900,13 +9906,17 @@ "id": "GoogleCloudDialogflowCxV3beta1ExportAgentResponse", "properties": { "agentContent": { - "description": "Uncompressed raw byte content for agent.", + "description": "Uncompressed raw byte content for agent. This field is populated if none of `agent_uri` and `git_destination` are specified in ExportAgentRequest.", "format": "byte", "type": "string" }, "agentUri": { "description": "The URI to a file containing the exported agent. This field is populated if `agent_uri` is specified in ExportAgentRequest.", "type": "string" + }, + "commitSha": { + "description": "Commit SHA of the git push. This field is populated if `git_destination` are specified in ExportAgentRequest.", + "type": "string" } }, "type": "object" @@ -11177,6 +11187,7 @@ "type": "object" }, "password": { + "deprecated": true, "description": "The password for HTTP Basic authentication.", "type": "string" }, @@ -11196,6 +11207,7 @@ "type": "string" }, "username": { + "deprecated": true, "description": "The user name for HTTP Basic authentication.", "type": "string" }, @@ -12976,6 +12988,11 @@ "EXAMPLE", "TEMPLATE" ], + "enumDeprecated": [ + false, + false, + true + ], "enumDescriptions": [ "Not specified. This value should never be used.", "Examples do not contain @-prefixed entity type names, but example parts can be annotated with entity types.", @@ -13610,6 +13627,7 @@ "type": "boolean" }, "matchMode": { + "deprecated": true, "description": "Optional. Determines how intents are detected from user queries.", "enum": [ "MATCH_MODE_UNSPECIFIED", @@ -13642,6 +13660,12 @@ "TIER_ENTERPRISE", "TIER_ENTERPRISE_PLUS" ], + "enumDeprecated": [ + false, + false, + false, + true + ], "enumDescriptions": [ "Not specified. This value should never be used.", "Trial Edition, previously known as Standard Edition.", @@ -14043,6 +14067,7 @@ "description": "Properties of the object.", "type": "any" }, + "deprecated": true, "description": "The collection of current Dialogflow CX agent session parameters at the time of this response. Deprecated: Use `parameters` instead.", "type": "object" }, @@ -14397,6 +14422,7 @@ "type": "object" }, "GoogleCloudDialogflowV2beta1CompileSuggestionRequest": { + "deprecated": true, "description": "The request message for Participants.CompileSuggestion.", "id": "GoogleCloudDialogflowV2beta1CompileSuggestionRequest", "properties": { @@ -14413,6 +14439,7 @@ "type": "object" }, "GoogleCloudDialogflowV2beta1CompileSuggestionResponse": { + "deprecated": true, "description": "The response message for Participants.CompileSuggestion.", "id": "GoogleCloudDialogflowV2beta1CompileSuggestionResponse", "properties": { @@ -14749,6 +14776,7 @@ "id": "GoogleCloudDialogflowV2beta1Document", "properties": { "content": { + "deprecated": true, "description": "The raw content of the document. This field is only permitted for EXTRACTIVE_QA and FAQ knowledge types. Note: This field is in the process of being deprecated, please use raw_content instead.", "type": "string" }, @@ -15195,6 +15223,7 @@ "id": "GoogleCloudDialogflowV2beta1FulfillmentGenericWebService", "properties": { "isCloudFunction": { + "deprecated": true, "description": "Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now.", "type": "boolean" }, @@ -15797,6 +15826,7 @@ "type": "string" }, "phraseHints": { + "deprecated": true, "description": "A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details. This field is deprecated. Please use [speech_contexts]() instead. If you specify both [phrase_hints]() and [speech_contexts](), Dialogflow will treat the [phrase_hints]() as a single additional [SpeechContext]().", "items": { "type": "string" @@ -15913,6 +15943,7 @@ "type": "boolean" }, "mlEnabled": { + "deprecated": true, "description": "Optional. Indicates whether Machine Learning is enabled for the intent. Note: If `ml_enabled` setting is set to false, then this intent is not taken into account during inference in `ML ONLY` match mode. Also, auto-markup in the UI is turned off. DEPRECATED! Please use `ml_disabled` field instead. NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false, then the default value is determined as follows: - Before April 15th, 2018 the default is: ml_enabled = false / ml_disabled = true. - After April 15th, 2018 the default is: ml_enabled = true / ml_disabled = false.", "type": "boolean" }, @@ -17043,6 +17074,11 @@ "EXAMPLE", "TEMPLATE" ], + "enumDeprecated": [ + false, + false, + true + ], "enumDescriptions": [ "Not specified. This value should never be used.", "Examples do not contain @-prefixed entity type names, but example parts can be annotated with entity types.", @@ -17398,6 +17434,7 @@ "type": "object" }, "GoogleCloudDialogflowV2beta1ListSuggestionsResponse": { + "deprecated": true, "description": "The response message for Participants.ListSuggestions.", "id": "GoogleCloudDialogflowV2beta1ListSuggestionsResponse", "properties": { @@ -18460,6 +18497,7 @@ "type": "object" }, "GoogleCloudDialogflowV2beta1Suggestion": { + "deprecated": true, "description": "Represents a suggestion for a human agent.", "id": "GoogleCloudDialogflowV2beta1Suggestion", "properties": { diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v3.json b/googleapiclient/discovery_cache/documents/dialogflow.v3.json index f0a43ae46a4..6397c2ebaa3 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v3.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v3.json @@ -3820,7 +3820,7 @@ } } }, - "revision": "20230630", + "revision": "20230707", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -3882,9 +3882,14 @@ "type": "boolean" }, "enableStackdriverLogging": { + "deprecated": true, "description": "Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead.", "type": "boolean" }, + "gitIntegrationSettings": { + "$ref": "GoogleCloudDialogflowCxV3AgentGitIntegrationSettings", + "description": "Git integration settings for this agent." + }, "locked": { "description": "Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for RestoreAgent.", "type": "boolean" @@ -3923,6 +3928,47 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3AgentGitIntegrationSettings": { + "description": "Settings for connecting to Git repository for an agent.", + "id": "GoogleCloudDialogflowCxV3AgentGitIntegrationSettings", + "properties": { + "githubSettings": { + "$ref": "GoogleCloudDialogflowCxV3AgentGitIntegrationSettingsGithubSettings", + "description": "GitHub settings." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3AgentGitIntegrationSettingsGithubSettings": { + "description": "Settings of integration with GitHub.", + "id": "GoogleCloudDialogflowCxV3AgentGitIntegrationSettingsGithubSettings", + "properties": { + "accessToken": { + "description": "The access token used to authenticate the access to the GitHub repository.", + "type": "string" + }, + "branches": { + "description": "A list of branches configured to be used from Dialogflow.", + "items": { + "type": "string" + }, + "type": "array" + }, + "displayName": { + "description": "The unique repository display name for the GitHub repository.", + "type": "string" + }, + "repositoryUri": { + "description": "The GitHub repository URI related to the agent.", + "type": "string" + }, + "trackingBranch": { + "description": "The branch of GitHub repository tracked for this agent.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3AgentValidationResult": { "description": "The response message for Agents.GetAgentValidationResult.", "id": "GoogleCloudDialogflowCxV3AgentValidationResult", @@ -4939,6 +4985,10 @@ "description": "Optional. Environment name. If not set, draft environment is assumed. Format: `projects//locations//agents//environments/`.", "type": "string" }, + "gitDestination": { + "$ref": "GoogleCloudDialogflowCxV3ExportAgentRequestGitDestination", + "description": "Optional. The Git branch to export the agent to." + }, "includeBigqueryExportSettings": { "description": "Optional. Whether to include BigQuery Export setting.", "type": "boolean" @@ -4946,18 +4996,37 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3ExportAgentRequestGitDestination": { + "description": "Settings for exporting to a git branch.", + "id": "GoogleCloudDialogflowCxV3ExportAgentRequestGitDestination", + "properties": { + "commitMessage": { + "description": "Commit message for the git push.", + "type": "string" + }, + "trackingBranch": { + "description": "Tracking branch for the git push.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3ExportAgentResponse": { "description": "The response message for Agents.ExportAgent.", "id": "GoogleCloudDialogflowCxV3ExportAgentResponse", "properties": { "agentContent": { - "description": "Uncompressed raw byte content for agent.", + "description": "Uncompressed raw byte content for agent. This field is populated if none of `agent_uri` and `git_destination` are specified in ExportAgentRequest.", "format": "byte", "type": "string" }, "agentUri": { "description": "The URI to a file containing the exported agent. This field is populated if `agent_uri` is specified in ExportAgentRequest.", "type": "string" + }, + "commitSha": { + "description": "Commit SHA of the git push. This field is populated if `git_destination` are specified in ExportAgentRequest.", + "type": "string" } }, "type": "object" @@ -6454,9 +6523,11 @@ }, "intent": { "$ref": "GoogleCloudDialogflowCxV3Intent", + "deprecated": true, "description": "The Intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. This field is deprecated, please use QueryResult.match instead." }, "intentDetectionConfidence": { + "deprecated": true, "description": "The intent detection confidence. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. This field is deprecated, please use QueryResult.match instead.", "format": "float", "type": "number" @@ -6754,6 +6825,10 @@ "description": "The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to restore agent from. The format of this URI must be `gs:///`. Dialogflow performs a read operation for the Cloud Storage object on the caller's behalf, so your request authentication must have read permissions for the object. For more information, see [Dialogflow access control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).", "type": "string" }, + "gitSource": { + "$ref": "GoogleCloudDialogflowCxV3RestoreAgentRequestGitSource", + "description": "Setting for restoring from a git branch" + }, "restoreOption": { "description": "Agent restore mode. If not specified, `KEEP` is assumed.", "enum": [ @@ -6771,6 +6846,17 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3RestoreAgentRequestGitSource": { + "description": "Settings for restoring from a git branch", + "id": "GoogleCloudDialogflowCxV3RestoreAgentRequestGitSource", + "properties": { + "trackingBranch": { + "description": "tracking branch for the git pull", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3RolloutConfig": { "description": "The configuration for auto rollout.", "id": "GoogleCloudDialogflowCxV3RolloutConfig", @@ -7672,6 +7758,7 @@ "type": "string" }, "resources": { + "deprecated": true, "description": "The names of the resources where the message is found.", "items": { "type": "string" @@ -7897,6 +7984,7 @@ "type": "object" }, "password": { + "deprecated": true, "description": "The password for HTTP Basic authentication.", "type": "string" }, @@ -7916,6 +8004,7 @@ "type": "string" }, "username": { + "deprecated": true, "description": "The user name for HTTP Basic authentication.", "type": "string" }, @@ -8546,13 +8635,17 @@ "id": "GoogleCloudDialogflowCxV3beta1ExportAgentResponse", "properties": { "agentContent": { - "description": "Uncompressed raw byte content for agent.", + "description": "Uncompressed raw byte content for agent. This field is populated if none of `agent_uri` and `git_destination` are specified in ExportAgentRequest.", "format": "byte", "type": "string" }, "agentUri": { "description": "The URI to a file containing the exported agent. This field is populated if `agent_uri` is specified in ExportAgentRequest.", "type": "string" + }, + "commitSha": { + "description": "Commit SHA of the git push. This field is populated if `git_destination` are specified in ExportAgentRequest.", + "type": "string" } }, "type": "object" @@ -9823,6 +9916,7 @@ "type": "object" }, "password": { + "deprecated": true, "description": "The password for HTTP Basic authentication.", "type": "string" }, @@ -9842,6 +9936,7 @@ "type": "string" }, "username": { + "deprecated": true, "description": "The user name for HTTP Basic authentication.", "type": "string" }, @@ -11622,6 +11717,11 @@ "EXAMPLE", "TEMPLATE" ], + "enumDeprecated": [ + false, + false, + true + ], "enumDescriptions": [ "Not specified. This value should never be used.", "Examples do not contain @-prefixed entity type names, but example parts can be annotated with entity types.", @@ -12719,6 +12819,7 @@ "type": "boolean" }, "mlEnabled": { + "deprecated": true, "description": "Optional. Indicates whether Machine Learning is enabled for the intent. Note: If `ml_enabled` setting is set to false, then this intent is not taken into account during inference in `ML ONLY` match mode. Also, auto-markup in the UI is turned off. DEPRECATED! Please use `ml_disabled` field instead. NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false, then the default value is determined as follows: - Before April 15th, 2018 the default is: ml_enabled = false / ml_disabled = true. - After April 15th, 2018 the default is: ml_enabled = true / ml_disabled = false.", "type": "boolean" }, @@ -13820,6 +13921,11 @@ "EXAMPLE", "TEMPLATE" ], + "enumDeprecated": [ + false, + false, + true + ], "enumDescriptions": [ "Not specified. This value should never be used.", "Examples do not contain @-prefixed entity type names, but example parts can be annotated with entity types.", diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json b/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json index 07c4c67aafc..fec451ffdb6 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json @@ -3820,7 +3820,7 @@ } } }, - "revision": "20230630", + "revision": "20230707", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AudioInput": { @@ -4215,13 +4215,17 @@ "id": "GoogleCloudDialogflowCxV3ExportAgentResponse", "properties": { "agentContent": { - "description": "Uncompressed raw byte content for agent.", + "description": "Uncompressed raw byte content for agent. This field is populated if none of `agent_uri` and `git_destination` are specified in ExportAgentRequest.", "format": "byte", "type": "string" }, "agentUri": { "description": "The URI to a file containing the exported agent. This field is populated if `agent_uri` is specified in ExportAgentRequest.", "type": "string" + }, + "commitSha": { + "description": "Commit SHA of the git push. This field is populated if `git_destination` are specified in ExportAgentRequest.", + "type": "string" } }, "type": "object" @@ -5492,6 +5496,7 @@ "type": "object" }, "password": { + "deprecated": true, "description": "The password for HTTP Basic authentication.", "type": "string" }, @@ -5511,6 +5516,7 @@ "type": "string" }, "username": { + "deprecated": true, "description": "The user name for HTTP Basic authentication.", "type": "string" }, @@ -5808,9 +5814,14 @@ "type": "boolean" }, "enableStackdriverLogging": { + "deprecated": true, "description": "Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead.", "type": "boolean" }, + "gitIntegrationSettings": { + "$ref": "GoogleCloudDialogflowCxV3beta1AgentGitIntegrationSettings", + "description": "Git integration settings for this agent." + }, "locked": { "description": "Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for RestoreAgent.", "type": "boolean" @@ -5849,6 +5860,47 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1AgentGitIntegrationSettings": { + "description": "Settings for connecting to Git repository for an agent.", + "id": "GoogleCloudDialogflowCxV3beta1AgentGitIntegrationSettings", + "properties": { + "githubSettings": { + "$ref": "GoogleCloudDialogflowCxV3beta1AgentGitIntegrationSettingsGithubSettings", + "description": "GitHub settings." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1AgentGitIntegrationSettingsGithubSettings": { + "description": "Settings of integration with GitHub.", + "id": "GoogleCloudDialogflowCxV3beta1AgentGitIntegrationSettingsGithubSettings", + "properties": { + "accessToken": { + "description": "The access token used to authenticate the access to the GitHub repository.", + "type": "string" + }, + "branches": { + "description": "A list of branches configured to be used from Dialogflow.", + "items": { + "type": "string" + }, + "type": "array" + }, + "displayName": { + "description": "The unique repository display name for the GitHub repository.", + "type": "string" + }, + "repositoryUri": { + "description": "The GitHub repository URI related to the agent.", + "type": "string" + }, + "trackingBranch": { + "description": "The branch of GitHub repository tracked for this agent.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1AgentValidationResult": { "description": "The response message for Agents.GetAgentValidationResult.", "id": "GoogleCloudDialogflowCxV3beta1AgentValidationResult", @@ -6865,6 +6917,10 @@ "description": "Optional. Environment name. If not set, draft environment is assumed. Format: `projects//locations//agents//environments/`.", "type": "string" }, + "gitDestination": { + "$ref": "GoogleCloudDialogflowCxV3beta1ExportAgentRequestGitDestination", + "description": "Optional. The Git branch to export the agent to." + }, "includeBigqueryExportSettings": { "description": "Optional. Whether to include BigQuery Export setting.", "type": "boolean" @@ -6872,18 +6928,37 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1ExportAgentRequestGitDestination": { + "description": "Settings for exporting to a git branch.", + "id": "GoogleCloudDialogflowCxV3beta1ExportAgentRequestGitDestination", + "properties": { + "commitMessage": { + "description": "Commit message for the git push.", + "type": "string" + }, + "trackingBranch": { + "description": "Tracking branch for the git push.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1ExportAgentResponse": { "description": "The response message for Agents.ExportAgent.", "id": "GoogleCloudDialogflowCxV3beta1ExportAgentResponse", "properties": { "agentContent": { - "description": "Uncompressed raw byte content for agent.", + "description": "Uncompressed raw byte content for agent. This field is populated if none of `agent_uri` and `git_destination` are specified in ExportAgentRequest.", "format": "byte", "type": "string" }, "agentUri": { "description": "The URI to a file containing the exported agent. This field is populated if `agent_uri` is specified in ExportAgentRequest.", "type": "string" + }, + "commitSha": { + "description": "Commit SHA of the git push. This field is populated if `git_destination` are specified in ExportAgentRequest.", + "type": "string" } }, "type": "object" @@ -8380,9 +8455,11 @@ }, "intent": { "$ref": "GoogleCloudDialogflowCxV3beta1Intent", + "deprecated": true, "description": "The Intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. This field is deprecated, please use QueryResult.match instead." }, "intentDetectionConfidence": { + "deprecated": true, "description": "The intent detection confidence. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. This field is deprecated, please use QueryResult.match instead.", "format": "float", "type": "number" @@ -8680,6 +8757,10 @@ "description": "The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to restore agent from. The format of this URI must be `gs:///`. Dialogflow performs a read operation for the Cloud Storage object on the caller's behalf, so your request authentication must have read permissions for the object. For more information, see [Dialogflow access control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).", "type": "string" }, + "gitSource": { + "$ref": "GoogleCloudDialogflowCxV3beta1RestoreAgentRequestGitSource", + "description": "Setting for restoring from a git branch" + }, "restoreOption": { "description": "Agent restore mode. If not specified, `KEEP` is assumed.", "enum": [ @@ -8697,6 +8778,17 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1RestoreAgentRequestGitSource": { + "description": "Settings for restoring from a git branch", + "id": "GoogleCloudDialogflowCxV3beta1RestoreAgentRequestGitSource", + "properties": { + "trackingBranch": { + "description": "tracking branch for the git pull", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1RolloutConfig": { "description": "The configuration for auto rollout.", "id": "GoogleCloudDialogflowCxV3beta1RolloutConfig", @@ -9598,6 +9690,7 @@ "type": "string" }, "resources": { + "deprecated": true, "description": "The names of the resources where the message is found.", "items": { "type": "string" @@ -9823,6 +9916,7 @@ "type": "object" }, "password": { + "deprecated": true, "description": "The password for HTTP Basic authentication.", "type": "string" }, @@ -9842,6 +9936,7 @@ "type": "string" }, "username": { + "deprecated": true, "description": "The user name for HTTP Basic authentication.", "type": "string" }, @@ -11622,6 +11717,11 @@ "EXAMPLE", "TEMPLATE" ], + "enumDeprecated": [ + false, + false, + true + ], "enumDescriptions": [ "Not specified. This value should never be used.", "Examples do not contain @-prefixed entity type names, but example parts can be annotated with entity types.", @@ -12719,6 +12819,7 @@ "type": "boolean" }, "mlEnabled": { + "deprecated": true, "description": "Optional. Indicates whether Machine Learning is enabled for the intent. Note: If `ml_enabled` setting is set to false, then this intent is not taken into account during inference in `ML ONLY` match mode. Also, auto-markup in the UI is turned off. DEPRECATED! Please use `ml_disabled` field instead. NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false, then the default value is determined as follows: - Before April 15th, 2018 the default is: ml_enabled = false / ml_disabled = true. - After April 15th, 2018 the default is: ml_enabled = true / ml_disabled = false.", "type": "boolean" }, @@ -13820,6 +13921,11 @@ "EXAMPLE", "TEMPLATE" ], + "enumDeprecated": [ + false, + false, + true + ], "enumDescriptions": [ "Not specified. This value should never be used.", "Examples do not contain @-prefixed entity type names, but example parts can be annotated with entity types.", diff --git a/googleapiclient/discovery_cache/documents/digitalassetlinks.v1.json b/googleapiclient/discovery_cache/documents/digitalassetlinks.v1.json index ff38314cbe9..1dc782b800c 100644 --- a/googleapiclient/discovery_cache/documents/digitalassetlinks.v1.json +++ b/googleapiclient/discovery_cache/documents/digitalassetlinks.v1.json @@ -199,7 +199,7 @@ } } }, - "revision": "20230627", + "revision": "20230704", "rootUrl": "https://digitalassetlinks.googleapis.com/", "schemas": { "AndroidAppAsset": { diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json index 89ef3ea1098..58d42786ac8 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json @@ -1666,7 +1666,7 @@ } } }, - "revision": "20230623", + "revision": "20230629", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -2014,7 +2014,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaBigQuerySource", "properties": { "dataSchema": { - "description": "The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical.", + "description": "The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by Gen App Builder.", "type": "string" }, "datasetId": { @@ -2225,7 +2225,7 @@ "FULL" ], "enumDescriptions": [ - "Defaults to INCREMENTAL.", + "Defaults to `INCREMENTAL`.", "Inserts new documents or updates existing documents.", "Calculates diff and replaces the entire document dataset. Existing documents may be deleted if they are not present in the source location." ], diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json index 4aadb0ff3c6..a1705cb2ec2 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json @@ -1610,7 +1610,7 @@ } } }, - "revision": "20230623", + "revision": "20230629", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -2222,7 +2222,7 @@ "id": "GoogleCloudDiscoveryengineV1betaBigQuerySource", "properties": { "dataSchema": { - "description": "The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical.", + "description": "The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by Gen App Builder.", "type": "string" }, "datasetId": { @@ -2433,7 +2433,7 @@ "FULL" ], "enumDescriptions": [ - "Defaults to INCREMENTAL.", + "Defaults to `INCREMENTAL`.", "Inserts new documents or updates existing documents.", "Calculates diff and replaces the entire document dataset. Existing documents may be deleted if they are not present in the source location." ], diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v1.json b/googleapiclient/discovery_cache/documents/displayvideo.v1.json index 0341567e189..a6dcd9a0d89 100644 --- a/googleapiclient/discovery_cache/documents/displayvideo.v1.json +++ b/googleapiclient/discovery_cache/documents/displayvideo.v1.json @@ -8152,7 +8152,7 @@ } } }, - "revision": "20230627", + "revision": "20230707", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActivateManualTriggerRequest": { diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v2.json b/googleapiclient/discovery_cache/documents/displayvideo.v2.json index 4b3f1ff559b..77bda2e5f5c 100644 --- a/googleapiclient/discovery_cache/documents/displayvideo.v2.json +++ b/googleapiclient/discovery_cache/documents/displayvideo.v2.json @@ -9178,7 +9178,7 @@ } } }, - "revision": "20230627", + "revision": "20230707", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActivateManualTriggerRequest": { diff --git a/googleapiclient/discovery_cache/documents/dlp.v2.json b/googleapiclient/discovery_cache/documents/dlp.v2.json index 4972fa26132..aa0e916017a 100644 --- a/googleapiclient/discovery_cache/documents/dlp.v2.json +++ b/googleapiclient/discovery_cache/documents/dlp.v2.json @@ -3412,7 +3412,7 @@ } } }, - "revision": "20230625", + "revision": "20230702", "rootUrl": "https://dlp.googleapis.com/", "schemas": { "GooglePrivacyDlpV2Action": { @@ -6037,6 +6037,7 @@ "id": "GooglePrivacyDlpV2InfoTypeSummary", "properties": { "estimatedPrevalence": { + "deprecated": true, "description": "Not populated for predicted infotypes.", "format": "int32", "type": "integer" diff --git a/googleapiclient/discovery_cache/documents/dns.v1.json b/googleapiclient/discovery_cache/documents/dns.v1.json index c5eb4906ede..2c89fad2ddf 100644 --- a/googleapiclient/discovery_cache/documents/dns.v1.json +++ b/googleapiclient/discovery_cache/documents/dns.v1.json @@ -1824,7 +1824,7 @@ } } }, - "revision": "20230628", + "revision": "20230708", "rootUrl": "https://dns.googleapis.com/", "schemas": { "Change": { diff --git a/googleapiclient/discovery_cache/documents/dns.v1beta2.json b/googleapiclient/discovery_cache/documents/dns.v1beta2.json index 611e997c7c0..0d6f87c7771 100644 --- a/googleapiclient/discovery_cache/documents/dns.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/dns.v1beta2.json @@ -1821,7 +1821,7 @@ } } }, - "revision": "20230628", + "revision": "20230708", "rootUrl": "https://dns.googleapis.com/", "schemas": { "Change": { @@ -3023,7 +3023,8 @@ "$ref": "RRSetRoutingPolicyGeoPolicy" }, "geoPolicy": { - "$ref": "RRSetRoutingPolicyGeoPolicy" + "$ref": "RRSetRoutingPolicyGeoPolicy", + "deprecated": true }, "kind": { "default": "dns#rRSetRoutingPolicy", @@ -3036,7 +3037,8 @@ "$ref": "RRSetRoutingPolicyWrrPolicy" }, "wrrPolicy": { - "$ref": "RRSetRoutingPolicyWrrPolicy" + "$ref": "RRSetRoutingPolicyWrrPolicy", + "deprecated": true } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/docs.v1.json b/googleapiclient/discovery_cache/documents/docs.v1.json index fe07c1a601d..a8a89a05517 100644 --- a/googleapiclient/discovery_cache/documents/docs.v1.json +++ b/googleapiclient/discovery_cache/documents/docs.v1.json @@ -216,7 +216,7 @@ } } }, - "revision": "20230620", + "revision": "20230707", "rootUrl": "https://docs.googleapis.com/", "schemas": { "AutoText": { diff --git a/googleapiclient/discovery_cache/documents/documentai.v1.json b/googleapiclient/discovery_cache/documents/documentai.v1.json index 4c875f44cc2..2cbdb366857 100644 --- a/googleapiclient/discovery_cache/documents/documentai.v1.json +++ b/googleapiclient/discovery_cache/documents/documentai.v1.json @@ -1042,7 +1042,7 @@ } } }, - "revision": "20230627", + "revision": "20230705", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata": { diff --git a/googleapiclient/discovery_cache/documents/documentai.v1beta2.json b/googleapiclient/discovery_cache/documents/documentai.v1beta2.json index f07dc1118e9..32e05e1f9a5 100644 --- a/googleapiclient/discovery_cache/documents/documentai.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/documentai.v1beta2.json @@ -292,7 +292,7 @@ } } }, - "revision": "20230627", + "revision": "20230705", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata": { diff --git a/googleapiclient/discovery_cache/documents/documentai.v1beta3.json b/googleapiclient/discovery_cache/documents/documentai.v1beta3.json index 5c07950da4f..d6fcc366099 100644 --- a/googleapiclient/discovery_cache/documents/documentai.v1beta3.json +++ b/googleapiclient/discovery_cache/documents/documentai.v1beta3.json @@ -1114,7 +1114,7 @@ } } }, - "revision": "20230627", + "revision": "20230705", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata": { diff --git a/googleapiclient/discovery_cache/documents/domainsrdap.v1.json b/googleapiclient/discovery_cache/documents/domainsrdap.v1.json index 76de22e26a4..6cad308e771 100644 --- a/googleapiclient/discovery_cache/documents/domainsrdap.v1.json +++ b/googleapiclient/discovery_cache/documents/domainsrdap.v1.json @@ -289,7 +289,7 @@ } } }, - "revision": "20230629", + "revision": "20230710", "rootUrl": "https://domainsrdap.googleapis.com/", "schemas": { "HttpBody": { diff --git a/googleapiclient/discovery_cache/documents/doubleclicksearch.v2.json b/googleapiclient/discovery_cache/documents/doubleclicksearch.v2.json index 1c2f37242a8..1cadabc8ccd 100644 --- a/googleapiclient/discovery_cache/documents/doubleclicksearch.v2.json +++ b/googleapiclient/discovery_cache/documents/doubleclicksearch.v2.json @@ -543,7 +543,7 @@ } } }, - "revision": "20230626", + "revision": "20230705", "rootUrl": "https://doubleclicksearch.googleapis.com/", "schemas": { "Availability": { diff --git a/googleapiclient/discovery_cache/documents/drive.v2.json b/googleapiclient/discovery_cache/documents/drive.v2.json index 9d22c33407b..e42bcf6fb04 100644 --- a/googleapiclient/discovery_cache/documents/drive.v2.json +++ b/googleapiclient/discovery_cache/documents/drive.v2.json @@ -3842,7 +3842,7 @@ } } }, - "revision": "20230626", + "revision": "20230629", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { diff --git a/googleapiclient/discovery_cache/documents/drive.v3.json b/googleapiclient/discovery_cache/documents/drive.v3.json index 28b920862f0..772199187a1 100644 --- a/googleapiclient/discovery_cache/documents/drive.v3.json +++ b/googleapiclient/discovery_cache/documents/drive.v3.json @@ -2433,7 +2433,7 @@ } } }, - "revision": "20230626", + "revision": "20230629", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { diff --git a/googleapiclient/discovery_cache/documents/driveactivity.v2.json b/googleapiclient/discovery_cache/documents/driveactivity.v2.json index 0c6e53d83d1..c7809f7e7b9 100644 --- a/googleapiclient/discovery_cache/documents/driveactivity.v2.json +++ b/googleapiclient/discovery_cache/documents/driveactivity.v2.json @@ -132,7 +132,7 @@ } } }, - "revision": "20230625", + "revision": "20230708", "rootUrl": "https://driveactivity.googleapis.com/", "schemas": { "Action": { @@ -625,10 +625,12 @@ }, "file": { "$ref": "File", + "deprecated": true, "description": "This field is deprecated; please use the `driveFile` field instead." }, "folder": { "$ref": "Folder", + "deprecated": true, "description": "This field is deprecated; please use the `driveFolder` field instead." }, "mimeType": { @@ -664,10 +666,12 @@ }, "file": { "$ref": "File", + "deprecated": true, "description": "This field is deprecated; please use the `driveFile` field instead." }, "folder": { "$ref": "Folder", + "deprecated": true, "description": "This field is deprecated; please use the `driveFolder` field instead." }, "name": { @@ -765,6 +769,7 @@ "type": "object" }, "File": { + "deprecated": true, "description": "This item is deprecated; please see `DriveFile` instead.", "id": "File", "properties": {}, @@ -794,6 +799,7 @@ "type": "object" }, "Folder": { + "deprecated": true, "description": "This item is deprecated; please see `DriveFolder` instead.", "id": "Folder", "properties": { @@ -922,6 +928,7 @@ }, "teamDrive": { "$ref": "TeamDriveReference", + "deprecated": true, "description": "This field is deprecated; please use the `drive` field instead." }, "user": { @@ -1283,6 +1290,7 @@ }, "teamDrive": { "$ref": "TeamDrive", + "deprecated": true, "description": "This field is deprecated; please use the `drive` field instead." } }, @@ -1302,12 +1310,14 @@ }, "teamDrive": { "$ref": "TeamDriveReference", + "deprecated": true, "description": "This field is deprecated; please use the `drive` field instead." } }, "type": "object" }, "TeamDrive": { + "deprecated": true, "description": "This item is deprecated; please see `Drive` instead.", "id": "TeamDrive", "properties": { @@ -1327,6 +1337,7 @@ "type": "object" }, "TeamDriveReference": { + "deprecated": true, "description": "This item is deprecated; please see `DriveReference` instead.", "id": "TeamDriveReference", "properties": { diff --git a/googleapiclient/discovery_cache/documents/drivelabels.v2.json b/googleapiclient/discovery_cache/documents/drivelabels.v2.json index 9a34aee16e6..fd6c247634d 100644 --- a/googleapiclient/discovery_cache/documents/drivelabels.v2.json +++ b/googleapiclient/discovery_cache/documents/drivelabels.v2.json @@ -898,7 +898,7 @@ } } }, - "revision": "20230621", + "revision": "20230705", "rootUrl": "https://drivelabels.googleapis.com/", "schemas": { "GoogleAppsDriveLabelsV2BadgeColors": { diff --git a/googleapiclient/discovery_cache/documents/drivelabels.v2beta.json b/googleapiclient/discovery_cache/documents/drivelabels.v2beta.json index 883aa1b3bcd..1d2909382c3 100644 --- a/googleapiclient/discovery_cache/documents/drivelabels.v2beta.json +++ b/googleapiclient/discovery_cache/documents/drivelabels.v2beta.json @@ -898,7 +898,7 @@ } } }, - "revision": "20230621", + "revision": "20230705", "rootUrl": "https://drivelabels.googleapis.com/", "schemas": { "GoogleAppsDriveLabelsV2betaBadgeColors": { diff --git a/googleapiclient/discovery_cache/documents/essentialcontacts.v1.json b/googleapiclient/discovery_cache/documents/essentialcontacts.v1.json index 19afc92b26c..ca98e04f400 100644 --- a/googleapiclient/discovery_cache/documents/essentialcontacts.v1.json +++ b/googleapiclient/discovery_cache/documents/essentialcontacts.v1.json @@ -850,7 +850,7 @@ } } }, - "revision": "20230703", + "revision": "20230708", "rootUrl": "https://essentialcontacts.googleapis.com/", "schemas": { "GoogleCloudEssentialcontactsV1ComputeContactsResponse": { diff --git a/googleapiclient/discovery_cache/documents/factchecktools.v1alpha1.json b/googleapiclient/discovery_cache/documents/factchecktools.v1alpha1.json index 22ce1ed5014..5a249c2d12b 100644 --- a/googleapiclient/discovery_cache/documents/factchecktools.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/factchecktools.v1alpha1.json @@ -304,7 +304,7 @@ } } }, - "revision": "20230702", + "revision": "20230708", "rootUrl": "https://factchecktools.googleapis.com/", "schemas": { "GoogleFactcheckingFactchecktoolsV1alpha1Claim": { diff --git a/googleapiclient/discovery_cache/documents/fcm.v1.json b/googleapiclient/discovery_cache/documents/fcm.v1.json index c72310128f1..710320f1dda 100644 --- a/googleapiclient/discovery_cache/documents/fcm.v1.json +++ b/googleapiclient/discovery_cache/documents/fcm.v1.json @@ -146,7 +146,7 @@ } } }, - "revision": "20230626", + "revision": "20230707", "rootUrl": "https://fcm.googleapis.com/", "schemas": { "AndroidConfig": { diff --git a/googleapiclient/discovery_cache/documents/fcmdata.v1beta1.json b/googleapiclient/discovery_cache/documents/fcmdata.v1beta1.json index 71314e2ff1a..bbb83b6c0d3 100644 --- a/googleapiclient/discovery_cache/documents/fcmdata.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/fcmdata.v1beta1.json @@ -154,7 +154,7 @@ } } }, - "revision": "20230703", + "revision": "20230708", "rootUrl": "https://fcmdata.googleapis.com/", "schemas": { "GoogleFirebaseFcmDataV1beta1AndroidDeliveryData": { diff --git a/googleapiclient/discovery_cache/documents/firebase.v1beta1.json b/googleapiclient/discovery_cache/documents/firebase.v1beta1.json index f49cb32b49e..a103cdf2cba 100644 --- a/googleapiclient/discovery_cache/documents/firebase.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/firebase.v1beta1.json @@ -1320,7 +1320,7 @@ } } }, - "revision": "20230703", + "revision": "20230707", "rootUrl": "https://firebase.googleapis.com/", "schemas": { "AddFirebaseRequest": { diff --git a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1.json b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1.json index 33715ac6b8c..a079b954f8d 100644 --- a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1.json +++ b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1.json @@ -941,7 +941,7 @@ } } }, - "revision": "20230705", + "revision": "20230711", "rootUrl": "https://firebaseappdistribution.googleapis.com/", "schemas": { "GdataBlobstore2Info": { diff --git a/googleapiclient/discovery_cache/documents/firebasedatabase.v1beta.json b/googleapiclient/discovery_cache/documents/firebasedatabase.v1beta.json index 7228b5a069b..3ab6b238e7b 100644 --- a/googleapiclient/discovery_cache/documents/firebasedatabase.v1beta.json +++ b/googleapiclient/discovery_cache/documents/firebasedatabase.v1beta.json @@ -351,7 +351,7 @@ } } }, - "revision": "20230703", + "revision": "20230708", "rootUrl": "https://firebasedatabase.googleapis.com/", "schemas": { "DatabaseInstance": { diff --git a/googleapiclient/discovery_cache/documents/firebasehosting.v1.json b/googleapiclient/discovery_cache/documents/firebasehosting.v1.json index 1ec8a6825bd..b79d6bc84a3 100644 --- a/googleapiclient/discovery_cache/documents/firebasehosting.v1.json +++ b/googleapiclient/discovery_cache/documents/firebasehosting.v1.json @@ -186,7 +186,7 @@ } } }, - "revision": "20230627", + "revision": "20230708", "rootUrl": "https://firebasehosting.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/googleapiclient/discovery_cache/documents/firebasehosting.v1beta1.json b/googleapiclient/discovery_cache/documents/firebasehosting.v1beta1.json index 66eaa41750a..bc9e06ba9ab 100644 --- a/googleapiclient/discovery_cache/documents/firebasehosting.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/firebasehosting.v1beta1.json @@ -2109,7 +2109,7 @@ } } }, - "revision": "20230627", + "revision": "20230708", "rootUrl": "https://firebasehosting.googleapis.com/", "schemas": { "ActingUser": { @@ -2282,6 +2282,13 @@ "DOMAIN_VERIFICATION_REQUIRED", "DOMAIN_VERIFICATION_LOST" ], + "enumDeprecated": [ + false, + true, + false, + false, + false + ], "enumDescriptions": [ "Unspecified domain association status.", "An external operation is in progress on the domain association and no further operations can be performed until it is complete. Formerly used for metabase updates. Not currently used", diff --git a/googleapiclient/discovery_cache/documents/firebaseml.v1.json b/googleapiclient/discovery_cache/documents/firebaseml.v1.json index c7456ce2b8d..52dce915335 100644 --- a/googleapiclient/discovery_cache/documents/firebaseml.v1.json +++ b/googleapiclient/discovery_cache/documents/firebaseml.v1.json @@ -204,7 +204,7 @@ } } }, - "revision": "20230703", + "revision": "20230705", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/googleapiclient/discovery_cache/documents/firebaseml.v1beta2.json b/googleapiclient/discovery_cache/documents/firebaseml.v1beta2.json index f9bf0563a5d..30653a3980f 100644 --- a/googleapiclient/discovery_cache/documents/firebaseml.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/firebaseml.v1beta2.json @@ -318,7 +318,7 @@ } } }, - "revision": "20230703", + "revision": "20230705", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "DownloadModelResponse": { diff --git a/googleapiclient/discovery_cache/documents/firebaserules.v1.json b/googleapiclient/discovery_cache/documents/firebaserules.v1.json index 684fec85806..3a5485a48a3 100644 --- a/googleapiclient/discovery_cache/documents/firebaserules.v1.json +++ b/googleapiclient/discovery_cache/documents/firebaserules.v1.json @@ -477,7 +477,7 @@ } } }, - "revision": "20230608", + "revision": "20230626", "rootUrl": "https://firebaserules.googleapis.com/", "schemas": { "Arg": { diff --git a/googleapiclient/discovery_cache/documents/fitness.v1.json b/googleapiclient/discovery_cache/documents/fitness.v1.json index ada59dcf13a..59b532d8705 100644 --- a/googleapiclient/discovery_cache/documents/fitness.v1.json +++ b/googleapiclient/discovery_cache/documents/fitness.v1.json @@ -831,7 +831,7 @@ } } }, - "revision": "20230703", + "revision": "20230707", "rootUrl": "https://fitness.googleapis.com/", "schemas": { "AggregateBucket": { diff --git a/googleapiclient/discovery_cache/documents/forms.v1.json b/googleapiclient/discovery_cache/documents/forms.v1.json index b92b6938320..b208e063550 100644 --- a/googleapiclient/discovery_cache/documents/forms.v1.json +++ b/googleapiclient/discovery_cache/documents/forms.v1.json @@ -423,7 +423,7 @@ } } }, - "revision": "20230622", + "revision": "20230706", "rootUrl": "https://forms.googleapis.com/", "schemas": { "Answer": { diff --git a/googleapiclient/discovery_cache/documents/games.v1.json b/googleapiclient/discovery_cache/documents/games.v1.json index 7fb10fe40d7..3c467dce8a4 100644 --- a/googleapiclient/discovery_cache/documents/games.v1.json +++ b/googleapiclient/discovery_cache/documents/games.v1.json @@ -1266,7 +1266,7 @@ } } }, - "revision": "20230703", + "revision": "20230705", "rootUrl": "https://games.googleapis.com/", "schemas": { "AchievementDefinition": { diff --git a/googleapiclient/discovery_cache/documents/gamesConfiguration.v1configuration.json b/googleapiclient/discovery_cache/documents/gamesConfiguration.v1configuration.json index e93cfced131..36723343748 100644 --- a/googleapiclient/discovery_cache/documents/gamesConfiguration.v1configuration.json +++ b/googleapiclient/discovery_cache/documents/gamesConfiguration.v1configuration.json @@ -381,7 +381,7 @@ } } }, - "revision": "20230703", + "revision": "20230705", "rootUrl": "https://gamesconfiguration.googleapis.com/", "schemas": { "AchievementConfiguration": { diff --git a/googleapiclient/discovery_cache/documents/gamesManagement.v1management.json b/googleapiclient/discovery_cache/documents/gamesManagement.v1management.json index cd4c5cfd7cc..29281ee1c9c 100644 --- a/googleapiclient/discovery_cache/documents/gamesManagement.v1management.json +++ b/googleapiclient/discovery_cache/documents/gamesManagement.v1management.json @@ -471,7 +471,7 @@ } } }, - "revision": "20230703", + "revision": "20230705", "rootUrl": "https://gamesmanagement.googleapis.com/", "schemas": { "AchievementResetAllResponse": { diff --git a/googleapiclient/discovery_cache/documents/gkeonprem.v1.json b/googleapiclient/discovery_cache/documents/gkeonprem.v1.json index a60c18cbc02..58275feb3db 100644 --- a/googleapiclient/discovery_cache/documents/gkeonprem.v1.json +++ b/googleapiclient/discovery_cache/documents/gkeonprem.v1.json @@ -2996,7 +2996,7 @@ } } }, - "revision": "20230620", + "revision": "20230626", "rootUrl": "https://gkeonprem.googleapis.com/", "schemas": { "Authorization": { @@ -4733,6 +4733,63 @@ }, "type": "object" }, + "Metric": { + "description": "Progress metric is (string, int|float|string) pair.", + "id": "Metric", + "properties": { + "doubleValue": { + "description": "For metrics with floating point value.", + "format": "double", + "type": "number" + }, + "intValue": { + "description": "For metrics with integer value.", + "format": "int64", + "type": "string" + }, + "metric": { + "description": "Required. The metric name.", + "enum": [ + "METRIC_ID_UNSPECIFIED", + "NODES_TOTAL", + "NODES_DRAINING", + "NODES_UPGRADING", + "NODES_PENDING_UPGRADE", + "NODES_UPGRADED", + "NODES_FAILED", + "NODES_HEALTHY", + "NODES_RECONCILING", + "NODES_IN_MAINTENANCE", + "PREFLIGHTS_COMPLETED", + "PREFLIGHTS_RUNNING", + "PREFLIGHTS_FAILED", + "PREFLIGHTS_TOTAL" + ], + "enumDescriptions": [ + "Not set.", + "The total number of nodes being actuated.", + "The number of nodes draining.", + "The number of nodes actively upgrading.", + "The number of nodes to be upgraded.", + "The number of nodes upgraded.", + "The number of nodes to fail actuation.", + "The number of nodes healthy.", + "The number of nodes reconciling.", + "The number of nodes in maintenance mode.", + "The number of completed preflight checks.", + "The number of preflight checks running.", + "The number of preflight checks failed.", + "The total number of preflight checks." + ], + "type": "string" + }, + "stringValue": { + "description": "For metrics with custom values (ratios, visual progress, etc.).", + "type": "string" + } + }, + "type": "object" + }, "NodeTaint": { "description": "NodeTaint applied to every Kubernetes node in a node pool. Kubernetes taints can be used together with tolerations to control how workloads are scheduled to your nodes. Node taints are permanent.", "id": "NodeTaint", @@ -4825,6 +4882,11 @@ "readOnly": true, "type": "string" }, + "progress": { + "$ref": "OperationProgress", + "description": "Output only. Detailed progress information for the operation.", + "readOnly": true + }, "requestedCancellation": { "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have [Operation.error] value with a [google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`.", "readOnly": true, @@ -4867,6 +4929,83 @@ }, "type": "object" }, + "OperationProgress": { + "description": "Information about operation progress. LINT.IfChange", + "id": "OperationProgress", + "properties": { + "stages": { + "description": "The stages of the operation.", + "items": { + "$ref": "OperationStage" + }, + "type": "array" + } + }, + "type": "object" + }, + "OperationStage": { + "description": "Information about a particular stage of an operation.", + "id": "OperationStage", + "properties": { + "endTime": { + "description": "Time the stage ended.", + "format": "google-datetime", + "type": "string" + }, + "metrics": { + "description": "Progress metric bundle.", + "items": { + "$ref": "Metric" + }, + "type": "array" + }, + "stage": { + "description": "The high-level stage of the operation.", + "enum": [ + "STAGE_UNSPECIFIED", + "PREFLIGHT_CHECK", + "CONFIGURE", + "DEPLOY", + "HEALTH_CHECK", + "UPDATE" + ], + "enumDescriptions": [ + "Not set.", + "Preflight checks are running.", + "Resource is being configured.", + "Resource is being deployed.", + "Waiting for the resource to become healthy.", + "Resource is being updated." + ], + "type": "string" + }, + "startTime": { + "description": "Time the stage started.", + "format": "google-datetime", + "type": "string" + }, + "state": { + "description": "Output only. State of the stage.", + "enum": [ + "STATE_UNSPECIFIED", + "PENDING", + "RUNNING", + "SUCCEEDED", + "FAILED" + ], + "enumDescriptions": [ + "Not set.", + "The stage is pending.", + "The stage is running", + "The stage has completed successfully.", + "The stage has failed." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "Policy": { "description": "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: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/).", "id": "Policy", diff --git a/googleapiclient/discovery_cache/documents/gmail.v1.json b/googleapiclient/discovery_cache/documents/gmail.v1.json index 7ba567ed533..4f04afe113b 100644 --- a/googleapiclient/discovery_cache/documents/gmail.v1.json +++ b/googleapiclient/discovery_cache/documents/gmail.v1.json @@ -3077,7 +3077,7 @@ } } }, - "revision": "20230626", + "revision": "20230703", "rootUrl": "https://gmail.googleapis.com/", "schemas": { "AutoForwarding": { @@ -4348,6 +4348,7 @@ "id": "WatchRequest", "properties": { "labelFilterAction": { + "deprecated": true, "description": "Filtering behavior of `labelIds list` specified. This field is deprecated because it caused incorrect behavior in some cases; use `label_filter_behavior` instead.", "enum": [ "include", diff --git a/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1.json b/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1.json index 833232d6d63..12d55e46823 100644 --- a/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1.json +++ b/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1.json @@ -265,7 +265,7 @@ } } }, - "revision": "20230703", + "revision": "20230708", "rootUrl": "https://gmailpostmastertools.googleapis.com/", "schemas": { "DeliveryError": { diff --git a/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1beta1.json b/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1beta1.json index ebb18d6b3e8..a75e8c4de68 100644 --- a/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1beta1.json @@ -265,7 +265,7 @@ } } }, - "revision": "20230703", + "revision": "20230708", "rootUrl": "https://gmailpostmastertools.googleapis.com/", "schemas": { "DeliveryError": { diff --git a/googleapiclient/discovery_cache/documents/healthcare.v1.json b/googleapiclient/discovery_cache/documents/healthcare.v1.json index 915cdbe5e6a..f6e1fda1859 100644 --- a/googleapiclient/discovery_cache/documents/healthcare.v1.json +++ b/googleapiclient/discovery_cache/documents/healthcare.v1.json @@ -4078,7 +4078,7 @@ } } }, - "revision": "20230616", + "revision": "20230627", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "ActivateConsentRequest": { @@ -4802,6 +4802,13 @@ "notificationConfig": { "$ref": "NotificationConfig", "description": "Notification destination for new DICOM instances. Supplied by the client." + }, + "streamConfigs": { + "description": "Optional. A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination.", + "items": { + "$ref": "GoogleCloudHealthcareV1DicomStreamConfig" + }, + "type": "array" } }, "type": "object" @@ -4996,10 +5003,18 @@ "format": "google-datetime", "type": "string" }, + "filter": { + "description": "Restricts messages exported to those matching a filter, only applicable to PubsubDestination and GcsDestination. The following syntax is available: * A string field value can be written as text inside quotation marks, for example `\"query text\"`. The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, `\"Comment = great\"` returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in the `yyyy-mm-dd` format. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, and is just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. The following fields and functions are available for filtering: * `message_type`, from the MSH-9.1 field. For example, `NOT message_type = \"ADT\"`. * `send_date` or `sendDate`, the `yyyy-mm-dd` date the message was sent in the dataset's time_zone, from the MSH-7 segment. For example, `send_date < \"2017-01-02\"`. * `send_time`, the timestamp when the message was sent, using the RFC3339 time format for comparisons, from the MSH-7 segment. For example, `send_time < \"2017-01-02T00:00:00-05:00\"`. * `create_time`, the timestamp when the message was created in the HL7v2 store. Use the RFC3339 time format for comparisons. For example, `create_time < \"2017-01-02T00:00:00-05:00\"`. * `send_facility`, the care center that the message came from, from the MSH-4 segment. For example, `send_facility = \"ABC\"`. Note: The filter will be applied to every message in the HL7v2 store whose `send_time` lies in the range defined by the `start_time` and the `end_time`. Even if the filter only matches a small set of messages, the export operation can still take a long time to finish when a lot of messages are between the specified `start_time` and `end_time` range.", + "type": "string" + }, "gcsDestination": { "$ref": "GcsDestination", "description": "Export to a Cloud Storage destination." }, + "pubsubDestination": { + "$ref": "PubsubDestination", + "description": "Export messages to a Pub/Sub topic." + }, "startTime": { "description": "The start of the range in `send_time` (MSH.7, https://www.hl7.org/documentcenter/public_temp_2E58C1F9-1C23-BA17-0C6126475344DA9D/wg/conf/HL7MSH.htm) to process. If not specified, the UNIX epoch (1970-01-01T00:00:00Z) is used. This value has to come before the `end_time` defined below. Only messages whose `send_time` lies in the range `start_time` (inclusive) to `end_time` (exclusive) are exported.", "format": "google-datetime", @@ -5466,6 +5481,17 @@ }, "type": "object" }, + "GoogleCloudHealthcareV1DicomStreamConfig": { + "description": "StreamConfig specifies configuration for a streaming DICOM export.", + "id": "GoogleCloudHealthcareV1DicomStreamConfig", + "properties": { + "bigqueryDestination": { + "$ref": "GoogleCloudHealthcareV1DicomBigQueryDestination", + "description": "Results are appended to this table. The server creates a new table in the given BigQuery dataset if the specified table does not exist. To enable the Cloud Healthcare API to write to your BigQuery table, you must give the Cloud Healthcare API service account the bigquery.dataEditor role. The service account is: `service-{PROJECT_NUMBER}@gcp-sa-healthcare.iam.gserviceaccount.com`. The PROJECT_NUMBER identifies the project that the DICOM store resides in. To get the project number, go to the Cloud Console Dashboard. It is recommended to not have a custom schema in the destination table which could conflict with the schema created by the Cloud Healthcare API. Instance deletions are not applied to the destination table. The destination's table schema will be automatically updated in case a new instance's data is incompatible with the current schema. The schema should not be updated manually as this can cause incompatibilies that cannot be resolved automatically. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any instance that generates more than 1 MB of BigQuery data will not be streamed. If an instance cannot be streamed to BigQuery, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging))." + } + }, + "type": "object" + }, "GoogleCloudHealthcareV1FhirBigQueryDestination": { "description": "The configuration for exporting to BigQuery.", "id": "GoogleCloudHealthcareV1FhirBigQueryDestination", @@ -6176,6 +6202,10 @@ "pubsubTopic": { "description": "The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data contains the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. Cloud Healthcare API service account must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). If the number of errors exceeds a certain rate, some aren't submitted. Note that not all operations trigger notifications, see [Configuring Pub/Sub notifications](https://cloud.google.com/healthcare/docs/how-tos/pubsub) for specific details.", "type": "string" + }, + "sendForBulkImport": { + "description": "Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports.", + "type": "boolean" } }, "type": "object" @@ -6364,6 +6394,17 @@ }, "type": "object" }, + "PubsubDestination": { + "description": "The Pub/Sub output destination. The Cloud Healthcare Service Agent requires the `roles/pubsub.publisher` Cloud IAM role on the Pub/Sub topic.", + "id": "PubsubDestination", + "properties": { + "pubsubTopic": { + "description": "The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that Pub/Sub messages are published on. Supplied by the client. The `PubsubMessage` contains the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-PROJECT_NUMBER@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail.", + "type": "string" + } + }, + "type": "object" + }, "QueryAccessibleDataRequest": { "description": "Queries all data_ids that are consented for a given use in the given consent store and writes them to a specified destination. The returned Operation includes a progress counter for the number of User data mappings processed. Errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging] (https://cloud.google.com/healthcare/docs/how-tos/logging) and [QueryAccessibleData] for a sample log entry).", "id": "QueryAccessibleDataRequest", diff --git a/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json b/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json index 7e934fc2273..bacce0cf67a 100644 --- a/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json @@ -4941,7 +4941,7 @@ } } }, - "revision": "20230616", + "revision": "20230627", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "Action": { @@ -5940,7 +5940,7 @@ "description": "Notification destination for new DICOM instances. Supplied by the client." }, "streamConfigs": { - "description": "A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination.", + "description": "Optional. A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination.", "items": { "$ref": "GoogleCloudHealthcareV1beta1DicomStreamConfig" }, @@ -6245,10 +6245,18 @@ "format": "google-datetime", "type": "string" }, + "filter": { + "description": "Restricts messages exported to those matching a filter, only applicable to PubsubDestination and GcsDestination. The following syntax is available: * A string field value can be written as text inside quotation marks, for example `\"query text\"`. The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, `\"Comment = great\"` returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in the `yyyy-mm-dd` format. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, and is just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. The following fields and functions are available for filtering: * `message_type`, from the MSH-9.1 field. For example, `NOT message_type = \"ADT\"`. * `send_date` or `sendDate`, the YYYY-MM-DD date the message was sent in the dataset's time_zone, from the MSH-7 segment. For example, `send_date < \"2017-01-02\"`. * `send_time`, the timestamp when the message was sent, using the RFC3339 time format for comparisons, from the MSH-7 segment. For example, `send_time < \"2017-01-02T00:00:00-05:00\"`. * `create_time`, the timestamp when the message was created in the HL7v2 store. Use the RFC3339 time format for comparisons. For example, `create_time < \"2017-01-02T00:00:00-05:00\"`. * `send_facility`, the care center that the message came from, from the MSH-4 segment. For example, `send_facility = \"ABC\"`. Note: The filter will be applied to every message in the HL7v2 store whose `send_time` lies in the range defined by the `start_time` and the `end_time`. Even if the filter only matches a small set of messages, the export operation can still take a long time to finish when a lot of messages are between the specified `start_time` and `end_time` range.", + "type": "string" + }, "gcsDestination": { "$ref": "GcsDestination", "description": "Export to a Cloud Storage destination." }, + "pubsubDestination": { + "$ref": "PubsubDestination", + "description": "Export messages to a Pub/Sub topic." + }, "startTime": { "description": "The start of the range in `send_time` (MSH.7, https://www.hl7.org/documentcenter/public_temp_2E58C1F9-1C23-BA17-0C6126475344DA9D/wg/conf/HL7MSH.htm) to process. If not specified, the UNIX epoch (1970-01-01T00:00:00Z) is used. This value has to come before the `end_time` defined below. Only messages whose `send_time` lies in the range `start_time` (inclusive) to `end_time` (exclusive) are exported.", "format": "google-datetime", @@ -8000,6 +8008,17 @@ }, "type": "object" }, + "PubsubDestination": { + "description": "The Pub/Sub output destination. The Cloud Healthcare Service Agent requires the `roles/pubsub.publisher` Cloud IAM role on the Pub/Sub topic.", + "id": "PubsubDestination", + "properties": { + "pubsubTopic": { + "description": "The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that Pub/Sub messages are published on. Supplied by the client. The `PubsubMessage` contains the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-PROJECT_NUMBER@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail.", + "type": "string" + } + }, + "type": "object" + }, "QueryAccessibleDataRequest": { "description": "Queries all data_ids that are consented for a given use in the given consent store and writes them to a specified destination. The returned Operation includes a progress counter for the number of User data mappings processed. Errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging] (https://cloud.google.com/healthcare/docs/how-tos/logging) and [QueryAccessibleData] for a sample log entry).", "id": "QueryAccessibleDataRequest", diff --git a/googleapiclient/discovery_cache/documents/identitytoolkit.v2.json b/googleapiclient/discovery_cache/documents/identitytoolkit.v2.json index f1cf5b153bc..0c0f5a29034 100644 --- a/googleapiclient/discovery_cache/documents/identitytoolkit.v2.json +++ b/googleapiclient/discovery_cache/documents/identitytoolkit.v2.json @@ -1655,7 +1655,7 @@ } } }, - "revision": "20230627", + "revision": "20230707", "rootUrl": "https://identitytoolkit.googleapis.com/", "schemas": { "GoogleCloudIdentitytoolkitAdminV2AllowByDefault": { @@ -2477,6 +2477,7 @@ "type": "boolean" }, "token": { + "deprecated": true, "description": "Do not use. The `token` response type is not supported at the moment.", "type": "boolean" } @@ -3279,6 +3280,25 @@ "$ref": "GoogleCloudIdentitytoolkitV2CustomStrengthOptions", "description": "The custom strength options enforced by the password policy." }, + "enforcementState": { + "description": "Output only. Which enforcement mode to use for the password policy.", + "enum": [ + "ENFORCEMENT_STATE_UNSPECIFIED", + "OFF", + "ENFORCE" + ], + "enumDescriptions": [ + "Enforcement state has not been set.", + "Password Policy will not be used on the project.", + "Passwords non-compliant with the password policy will be rejected with an error thrown." + ], + "readOnly": true, + "type": "string" + }, + "forceUpgradeOnSignin": { + "description": "Users must have a password compliant with the password policy to sign-in.", + "type": "boolean" + }, "schemaVersion": { "description": "Output only. schema version number for the password policy", "format": "int32", diff --git a/googleapiclient/discovery_cache/documents/jobs.v3.json b/googleapiclient/discovery_cache/documents/jobs.v3.json index 9ae90dc548b..34c39e72a71 100644 --- a/googleapiclient/discovery_cache/documents/jobs.v3.json +++ b/googleapiclient/discovery_cache/documents/jobs.v3.json @@ -125,6 +125,7 @@ "type": "string" }, "languageCode": { + "deprecated": true, "description": "Deprecated. Use language_codes instead. Optional. The language of the query. This is the BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with the same language_code are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with the same language_code are returned. For CompletionType.COMBINED type, only open jobs with the same language_code or companies having open jobs with the same language_code are returned. The maximum number of allowed characters is 255.", "location": "query", "type": "string" @@ -651,7 +652,7 @@ } } }, - "revision": "20230531", + "revision": "20230705", "rootUrl": "https://jobs.googleapis.com/", "schemas": { "ApplicationInfo": { diff --git a/googleapiclient/discovery_cache/documents/jobs.v3p1beta1.json b/googleapiclient/discovery_cache/documents/jobs.v3p1beta1.json index 5410fbbc7ea..c0b2e80b722 100644 --- a/googleapiclient/discovery_cache/documents/jobs.v3p1beta1.json +++ b/googleapiclient/discovery_cache/documents/jobs.v3p1beta1.json @@ -125,6 +125,7 @@ "type": "string" }, "languageCode": { + "deprecated": true, "description": "Deprecated. Use language_codes instead. Optional. The language of the query. This is the BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with the same language_code are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with the same language_code are returned. For CompletionType.COMBINED type, only open jobs with the same language_code or companies having open jobs with the same language_code are returned. The maximum number of allowed characters is 255.", "location": "query", "type": "string" @@ -681,7 +682,7 @@ } } }, - "revision": "20230531", + "revision": "20230705", "rootUrl": "https://jobs.googleapis.com/", "schemas": { "ApplicationInfo": { diff --git a/googleapiclient/discovery_cache/documents/jobs.v4.json b/googleapiclient/discovery_cache/documents/jobs.v4.json index 1d4d8a050b7..cfd8ab16ba0 100644 --- a/googleapiclient/discovery_cache/documents/jobs.v4.json +++ b/googleapiclient/discovery_cache/documents/jobs.v4.json @@ -903,7 +903,7 @@ } } }, - "revision": "20230531", + "revision": "20230705", "rootUrl": "https://jobs.googleapis.com/", "schemas": { "ApplicationInfo": { diff --git a/googleapiclient/discovery_cache/documents/keep.v1.json b/googleapiclient/discovery_cache/documents/keep.v1.json index a0aa3894c06..6e160f64f40 100644 --- a/googleapiclient/discovery_cache/documents/keep.v1.json +++ b/googleapiclient/discovery_cache/documents/keep.v1.json @@ -314,7 +314,7 @@ } } }, - "revision": "20230620", + "revision": "20230627", "rootUrl": "https://keep.googleapis.com/", "schemas": { "Attachment": { diff --git a/googleapiclient/discovery_cache/documents/kmsinventory.v1.json b/googleapiclient/discovery_cache/documents/kmsinventory.v1.json index 4fcd79617d4..1d8bac25108 100644 --- a/googleapiclient/discovery_cache/documents/kmsinventory.v1.json +++ b/googleapiclient/discovery_cache/documents/kmsinventory.v1.json @@ -134,6 +134,12 @@ "location": "query", "type": "string" }, + "resourceTypes": { + "description": "Optional. A list of resource types that this request searches for. If empty, it will search all the [trackable resource types](https://cloud.google.com/kms/docs/view-key-usage#tracked-resource-types). Regular expressions are also supported. For example: * `compute.googleapis.com.*` snapshots resources whose type starts with `compute.googleapis.com`. * `.*Image` snapshots resources whose type ends with `Image`. * `.*Image.*` snapshots resources whose type contains `Image`. See [RE2](https://github.com/google/re2/wiki/Syntax) for all supported regular expression syntax. If the regular expression does not match any supported resource type, an INVALID_ARGUMENT error will be returned.", + "location": "query", + "repeated": true, + "type": "string" + }, "scope": { "description": "Required. Resource name of the organization. Example: organizations/123", "location": "path", @@ -236,7 +242,7 @@ } } }, - "revision": "20230702", + "revision": "20230708", "rootUrl": "https://kmsinventory.googleapis.com/", "schemas": { "GoogleCloudKmsInventoryV1ListCryptoKeysResponse": { diff --git a/googleapiclient/discovery_cache/documents/libraryagent.v1.json b/googleapiclient/discovery_cache/documents/libraryagent.v1.json index ab2b355b2ff..e9c27fab97c 100644 --- a/googleapiclient/discovery_cache/documents/libraryagent.v1.json +++ b/googleapiclient/discovery_cache/documents/libraryagent.v1.json @@ -279,7 +279,7 @@ } } }, - "revision": "20230703", + "revision": "20230708", "rootUrl": "https://libraryagent.googleapis.com/", "schemas": { "GoogleExampleLibraryagentV1Book": { diff --git a/googleapiclient/discovery_cache/documents/licensing.v1.json b/googleapiclient/discovery_cache/documents/licensing.v1.json index 657e976f59a..3e802940792 100644 --- a/googleapiclient/discovery_cache/documents/licensing.v1.json +++ b/googleapiclient/discovery_cache/documents/licensing.v1.json @@ -400,7 +400,7 @@ } } }, - "revision": "20230703", + "revision": "20230710", "rootUrl": "https://licensing.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/lifesciences.v2beta.json b/googleapiclient/discovery_cache/documents/lifesciences.v2beta.json index 7f7178f7766..636169a970f 100644 --- a/googleapiclient/discovery_cache/documents/lifesciences.v2beta.json +++ b/googleapiclient/discovery_cache/documents/lifesciences.v2beta.json @@ -312,7 +312,7 @@ } } }, - "revision": "20230623", + "revision": "20230630", "rootUrl": "https://lifesciences.googleapis.com/", "schemas": { "Accelerator": { diff --git a/googleapiclient/discovery_cache/documents/localservices.v1.json b/googleapiclient/discovery_cache/documents/localservices.v1.json index 1358f1f9c56..65d80a02d98 100644 --- a/googleapiclient/discovery_cache/documents/localservices.v1.json +++ b/googleapiclient/discovery_cache/documents/localservices.v1.json @@ -250,7 +250,7 @@ } } }, - "revision": "20230703", + "revision": "20230708", "rootUrl": "https://localservices.googleapis.com/", "schemas": { "GoogleAdsHomeservicesLocalservicesV1AccountReport": { diff --git a/googleapiclient/discovery_cache/documents/managedidentities.v1.json b/googleapiclient/discovery_cache/documents/managedidentities.v1.json index 609d3bbe029..74db08bc3c2 100644 --- a/googleapiclient/discovery_cache/documents/managedidentities.v1.json +++ b/googleapiclient/discovery_cache/documents/managedidentities.v1.json @@ -209,6 +209,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "checkMigrationPermission": { + "description": "CheckMigrationPermission API gets the current state of DomainMigration", + "flatPath": "v1/projects/{projectsId}/locations/global/domains/{domainsId}:checkMigrationPermission", + "httpMethod": "POST", + "id": "managedidentities.projects.locations.global.domains.checkMigrationPermission", + "parameterOrder": [ + "domain" + ], + "parameters": { + "domain": { + "description": "Required. The domain resource name using the form: `projects/{project_id}/locations/global/domains/{domain_name}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/global/domains/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+domain}:checkMigrationPermission", + "request": { + "$ref": "CheckMigrationPermissionRequest" + }, + "response": { + "$ref": "CheckMigrationPermissionResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "create": { "description": "Creates a Microsoft AD domain.", "flatPath": "v1/projects/{projectsId}/locations/global/domains", @@ -1487,7 +1515,7 @@ } } }, - "revision": "20230505", + "revision": "20230705", "rootUrl": "https://managedidentities.googleapis.com/", "schemas": { "AttachTrustRequest": { @@ -1630,6 +1658,42 @@ }, "type": "object" }, + "CheckMigrationPermissionRequest": { + "description": "CheckMigrationPermissionRequest is the request message for CheckMigrationPermission method.", + "id": "CheckMigrationPermissionRequest", + "properties": {}, + "type": "object" + }, + "CheckMigrationPermissionResponse": { + "description": "CheckMigrationPermissionResponse is the response message for CheckMigrationPermission method.", + "id": "CheckMigrationPermissionResponse", + "properties": { + "onpremDomains": { + "description": "The state of SID filtering of all the domains which has trust established.", + "items": { + "$ref": "OnPremDomainSIDDetails" + }, + "type": "array" + }, + "state": { + "description": "The state of DomainMigration.", + "enum": [ + "STATE_UNSPECIFIED", + "DISABLED", + "ENABLED", + "NEEDS_MAINTENANCE" + ], + "enumDescriptions": [ + "DomainMigration is in unspecified state.", + "Domain Migration is Disabled.", + "Domain Migration is Enabled.", + "Domain Migration is not in valid state." + ], + "type": "string" + } + }, + "type": "object" + }, "DailyCycle": { "description": "Time window specified for daily operations.", "id": "DailyCycle", @@ -2141,6 +2205,7 @@ "id": "GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule", "properties": { "canReschedule": { + "deprecated": true, "description": "This field is deprecated, and will be always set to true since reschedule can happen multiple times now. This field should not be removed until all service producers remove this for their customers.", "type": "boolean" }, @@ -2585,6 +2650,31 @@ }, "type": "object" }, + "OnPremDomainSIDDetails": { + "description": "OnPremDomainDetails is the message which contains details of on-prem domain which is trusted and needs to be migrated.", + "id": "OnPremDomainSIDDetails", + "properties": { + "name": { + "description": "FQDN of the on-prem domain being migrated.", + "type": "string" + }, + "sidFilteringState": { + "description": "Current SID filtering state.", + "enum": [ + "SID_FILTERING_STATE_UNSPECIFIED", + "ENABLED", + "DISABLED" + ], + "enumDescriptions": [ + "SID Filtering is in unspecified state.", + "SID Filtering is Enabled.", + "SID Filtering is Disabled." + ], + "type": "string" + } + }, + "type": "object" + }, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", diff --git a/googleapiclient/discovery_cache/documents/managedidentities.v1alpha1.json b/googleapiclient/discovery_cache/documents/managedidentities.v1alpha1.json index 705394b2503..2dcd58d16fa 100644 --- a/googleapiclient/discovery_cache/documents/managedidentities.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/managedidentities.v1alpha1.json @@ -1515,7 +1515,7 @@ } } }, - "revision": "20230505", + "revision": "20230705", "rootUrl": "https://managedidentities.googleapis.com/", "schemas": { "AttachTrustRequest": { @@ -1905,6 +1905,11 @@ "description": "EnableMigrationRequest is the request message for EnableMigration method.", "id": "EnableMigrationRequest", "properties": { + "enableDuration": { + "description": "Optional. Period after which the migration would be auto disabled. If unspecified, a default timeout of 48h is used.", + "format": "google-duration", + "type": "string" + }, "migratingDomains": { "description": "Required. List of the on-prem domains to be migrated.", "items": { @@ -2203,6 +2208,7 @@ "id": "GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule", "properties": { "canReschedule": { + "deprecated": true, "description": "This field is deprecated, and will be always set to true since reschedule can happen multiple times now. This field should not be removed until all service producers remove this for their customers.", "type": "boolean" }, diff --git a/googleapiclient/discovery_cache/documents/managedidentities.v1beta1.json b/googleapiclient/discovery_cache/documents/managedidentities.v1beta1.json index 25a7fe009a8..964db0661c0 100644 --- a/googleapiclient/discovery_cache/documents/managedidentities.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/managedidentities.v1beta1.json @@ -1515,7 +1515,7 @@ } } }, - "revision": "20230505", + "revision": "20230705", "rootUrl": "https://managedidentities.googleapis.com/", "schemas": { "AttachTrustRequest": { @@ -1914,6 +1914,11 @@ "description": "EnableMigrationRequest is the request message for EnableMigration method.", "id": "EnableMigrationRequest", "properties": { + "enableDuration": { + "description": "Optional. Period after which the migration would be auto disabled. If unspecified, a default timeout of 48h is used.", + "format": "google-duration", + "type": "string" + }, "migratingDomains": { "description": "Required. List of the on-prem domains to be migrated.", "items": { @@ -2212,6 +2217,7 @@ "id": "GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule", "properties": { "canReschedule": { + "deprecated": true, "description": "This field is deprecated, and will be always set to true since reschedule can happen multiple times now. This field should not be removed until all service producers remove this for their customers.", "type": "boolean" }, diff --git a/googleapiclient/discovery_cache/documents/metastore.v1.json b/googleapiclient/discovery_cache/documents/metastore.v1.json index 9e478abd4df..55abddbc82c 100644 --- a/googleapiclient/discovery_cache/documents/metastore.v1.json +++ b/googleapiclient/discovery_cache/documents/metastore.v1.json @@ -1339,7 +1339,7 @@ } } }, - "revision": "20230622", + "revision": "20230629", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AlterMetadataResourceLocationRequest": { diff --git a/googleapiclient/discovery_cache/documents/metastore.v1alpha.json b/googleapiclient/discovery_cache/documents/metastore.v1alpha.json index c9f24eca48a..17aa859971c 100644 --- a/googleapiclient/discovery_cache/documents/metastore.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/metastore.v1alpha.json @@ -1579,7 +1579,7 @@ } } }, - "revision": "20230622", + "revision": "20230629", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AlterMetadataResourceLocationRequest": { diff --git a/googleapiclient/discovery_cache/documents/metastore.v1beta.json b/googleapiclient/discovery_cache/documents/metastore.v1beta.json index f512d7beeaa..3b3abad89c1 100644 --- a/googleapiclient/discovery_cache/documents/metastore.v1beta.json +++ b/googleapiclient/discovery_cache/documents/metastore.v1beta.json @@ -1579,7 +1579,7 @@ } } }, - "revision": "20230622", + "revision": "20230629", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AlterMetadataResourceLocationRequest": { diff --git a/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json b/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json index ef9f5a743b3..df00579a9e9 100644 --- a/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json @@ -2102,7 +2102,7 @@ } } }, - "revision": "20230619", + "revision": "20230630", "rootUrl": "https://migrationcenter.googleapis.com/", "schemas": { "AddAssetsToGroupRequest": { @@ -3038,6 +3038,7 @@ "type": "integer" }, "jobErrors": { + "deprecated": true, "description": "List of job-level errors. Deprecated, use the job errors under execution_errors instead.", "items": { "$ref": "ImportError" @@ -3195,6 +3196,15 @@ "IMPORT_JOB_FORMAT_EXPORTED_AZURE_CSV", "IMPORT_JOB_FORMAT_MANUAL_CSV" ], + "enumDeprecated": [ + false, + true, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Default value.", "Configuration management DB format.", @@ -3448,6 +3458,15 @@ "IMPORT_JOB_FORMAT_EXPORTED_AZURE_CSV", "IMPORT_JOB_FORMAT_MANUAL_CSV" ], + "enumDeprecated": [ + false, + true, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Default value.", "Configuration management DB format.", @@ -3544,6 +3563,7 @@ }, "gcsPayload": { "$ref": "GCSPayloadInfo", + "deprecated": true, "description": "The payload is in Google Cloud Storage." }, "inlinePayload": { @@ -3613,6 +3633,7 @@ "type": "array" }, "rowNumber": { + "deprecated": true, "description": "The row number where the error was detected.", "format": "int32", "type": "integer" @@ -3643,6 +3664,15 @@ "IMPORT_JOB_FORMAT_EXPORTED_AZURE_CSV", "IMPORT_JOB_FORMAT_MANUAL_CSV" ], + "enumDeprecated": [ + false, + true, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Default value.", "Configuration management DB format.", @@ -4681,6 +4711,7 @@ "properties": { "assetAge": { "$ref": "ReportSummaryChartData", + "deprecated": true, "description": "Count of assets grouped by age." }, "coreCountHistogram": { @@ -4693,6 +4724,7 @@ }, "memoryUtilization": { "$ref": "ReportSummaryChartData", + "deprecated": true, "description": "Total memory split into Used/Free buckets." }, "memoryUtilizationChart": { @@ -4709,6 +4741,7 @@ }, "storageUtilization": { "$ref": "ReportSummaryChartData", + "deprecated": true, "description": "Total storage split into Used/Free buckets." }, "storageUtilizationChart": { @@ -4844,10 +4877,12 @@ "description": "Total monthly cost for this preference set." }, "preferredRegion": { + "deprecated": true, "description": "Target region for this Preference Set", "type": "string" }, "pricingTrack": { + "deprecated": true, "description": "Text describing the pricing track specified for this Preference Set", "type": "string" }, @@ -4856,6 +4891,7 @@ "description": "A set of findings that applies to Stole-Tenant machines in the input." }, "topPriority": { + "deprecated": true, "description": "Text describing the business priority specified for this Preference Set", "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/monitoring.v1.json b/googleapiclient/discovery_cache/documents/monitoring.v1.json index fc717974769..4e7dfff12c3 100644 --- a/googleapiclient/discovery_cache/documents/monitoring.v1.json +++ b/googleapiclient/discovery_cache/documents/monitoring.v1.json @@ -806,7 +806,7 @@ } } }, - "revision": "20230618", + "revision": "20230703", "rootUrl": "https://monitoring.googleapis.com/", "schemas": { "Aggregation": { @@ -1949,6 +1949,7 @@ "id": "TableDisplayOptions", "properties": { "shownColumns": { + "deprecated": true, "description": "Optional. This field is unused and has been replaced by TimeSeriesTable.column_settings", "items": { "type": "string" @@ -2094,6 +2095,7 @@ }, "statisticalTimeSeriesFilter": { "$ref": "StatisticalTimeSeriesFilter", + "deprecated": true, "description": "Statistics based time series filter. Note: This field is deprecated and completely ignored by the API." } }, @@ -2121,6 +2123,7 @@ }, "statisticalTimeSeriesFilter": { "$ref": "StatisticalTimeSeriesFilter", + "deprecated": true, "description": "Statistics based time series filter. Note: This field is deprecated and completely ignored by the API." } }, diff --git a/googleapiclient/discovery_cache/documents/monitoring.v3.json b/googleapiclient/discovery_cache/documents/monitoring.v3.json index c24855146e5..103f89fe147 100644 --- a/googleapiclient/discovery_cache/documents/monitoring.v3.json +++ b/googleapiclient/discovery_cache/documents/monitoring.v3.json @@ -2714,7 +2714,7 @@ } } }, - "revision": "20230618", + "revision": "20230703", "rootUrl": "https://monitoring.googleapis.com/", "schemas": { "Aggregation": { @@ -3206,6 +3206,10 @@ "$ref": "MonitoringQueryLanguageCondition", "description": "A condition that uses the Monitoring Query Language to define alerts." }, + "conditionPrometheusQueryLanguage": { + "$ref": "PrometheusQueryLanguageCondition", + "description": "A condition that uses the Prometheus query language to define alerts." + }, "conditionThreshold": { "$ref": "MetricThreshold", "description": "A condition that compares a time series against a threshold." @@ -3427,6 +3431,10 @@ "mimeType": { "description": "The format of the content field. Presently, only the value \"text/markdown\" is supported. See Markdown (https://en.wikipedia.org/wiki/Markdown) for more information.", "type": "string" + }, + "subject": { + "description": "Optional. The subject line of the notification. The subject line may not exceed 10,240 bytes. In notifications generated by this policy, the contents of the subject line after variable expansion will be truncated to 255 bytes or shorter at the latest UTF-8 character boundary. The 255-byte limit is recommended by this thread (https://stackoverflow.com/questions/1592291/what-is-the-email-subject-length-limit). It is both the limit imposed by some third-party ticketing products and it is common to define textual fields in databases as VARCHAR(255).The contents of the subject line can be templatized by using variables (https://cloud.google.com/monitoring/alerts/doc-variables). If this field is missing or empty, a default subject line will be generated.", + "type": "string" } }, "type": "object" @@ -3894,6 +3902,7 @@ "type": "object" }, "InternalChecker": { + "deprecated": true, "description": "An internal checker allows Uptime checks to run on private/internal GCP resources.", "id": "InternalChecker", "properties": { @@ -4525,6 +4534,7 @@ "type": "string" }, "launchStage": { + "deprecated": true, "description": "Deprecated. Must use the MetricDescriptor.launch_stage instead.", "enum": [ "LAUNCH_STAGE_UNSPECIFIED", @@ -4916,6 +4926,7 @@ "type": "string" }, "supportedTiers": { + "deprecated": true, "description": "The tiers that support this notification channel; the project service tier must be one of the supported_tiers.", "items": { "enum": [ @@ -5089,6 +5100,42 @@ }, "type": "object" }, + "PrometheusQueryLanguageCondition": { + "description": "A condition type that allows alert policies to be defined using Prometheus Query Language (PromQL) (https://prometheus.io/docs/prometheus/latest/querying/basics/).The PrometheusQueryLanguageCondition message contains information from a Prometheus alerting rule and its associated rule group.A Prometheus alerting rule is described here (https://prometheus.io/docs/prometheus/latest/configuration/alerting_rules/). The semantics of a Prometheus alerting rule is described here (https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/#rule).A Prometheus rule group is described here (https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/). The semantics of a Prometheus rule group is described here (https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/#rule_group).Because Cloud Alerting has no representation of a Prometheus rule group resource, we must embed the information of the parent rule group inside each of the conditions that refer to it. We must also update the contents of all Prometheus alerts in case the information of their rule group changes.The PrometheusQueryLanguageCondition protocol buffer combines the information of the corresponding rule group and alerting rule. The structure of the PrometheusQueryLanguageCondition protocol buffer does NOT mimic the structure of the Prometheus rule group and alerting rule YAML declarations. The PrometheusQueryLanguageCondition protocol buffer may change in the future to support future rule group and/or alerting rule features. There are no new such features at the present time (2023-06-26).", + "id": "PrometheusQueryLanguageCondition", + "properties": { + "alertRule": { + "description": "Optional. The alerting rule name of this alert in the corresponding Prometheus configuration file.Some external tools may require this field to be populated correctly in order to refer to the original Prometheus configuration file. The rule group name and the alert name are necessary to update the relevant AlertPolicies in case the definition of the rule group changes in the future.This field is optional. If this field is not empty, then it must be a valid Prometheus label name (https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels).", + "type": "string" + }, + "duration": { + "description": "Optional. Alerts are considered firing once their PromQL expression was evaluated to be \"true\" for this long. Alerts whose PromQL expression was not evaluated to be \"true\" for long enough are considered pending. The default value is zero. Must be zero or positive.", + "format": "google-duration", + "type": "string" + }, + "evaluationInterval": { + "description": "Required. How often this rule should be evaluated. Must be a positive multiple of 30 seconds or missing. The default value is 30 seconds. If this PrometheusQueryLanguageCondition was generated from a Prometheus alerting rule, then this value should be taken from the enclosing rule group.", + "format": "google-duration", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels to add to or overwrite in the PromQL query result. Label names must be valid (https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels). Label values can be templatized by using variables (https://cloud.google.com/monitoring/alerts/doc-variables). The only available variable names are the names of the labels in the PromQL result, including \"__name__\" and \"value\". \"labels\" may be empty.", + "type": "object" + }, + "query": { + "description": "Required. The PromQL expression to evaluate. Every evaluation cycle this expression is evaluated at the current time, and all resultant time series become pending/firing alerts. This field must not be empty.", + "type": "string" + }, + "ruleGroup": { + "description": "Optional. The rule group name of this alert in the corresponding Prometheus configuration file.Some external tools may require this field to be populated correctly in order to refer to the original Prometheus configuration file. The rule group name and the alert name are necessary to update the relevant AlertPolicies in case the definition of the rule group changes in the future.This field is optional. If this field is not empty, then it must be a valid Prometheus label name (https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels).", + "type": "string" + } + }, + "type": "object" + }, "QueryTimeSeriesRequest": { "description": "The QueryTimeSeries request.", "id": "QueryTimeSeriesRequest", @@ -5763,6 +5810,7 @@ "description": "Contains information needed to make an HTTP or HTTPS check." }, "internalCheckers": { + "deprecated": true, "description": "The internal checkers that this check will egress from. If is_internal is true and this list is empty, the check will egress from all the InternalCheckers configured for the project that owns this UptimeCheckConfig.", "items": { "$ref": "InternalChecker" @@ -5770,6 +5818,7 @@ "type": "array" }, "isInternal": { + "deprecated": true, "description": "If this is true, then checks are made only from the 'internal_checkers'. If it is false, then checks are made only from the 'selected_regions'. It is an error to provide 'selected_regions' when is_internal is true, or to provide 'internal_checkers' when is_internal is false.", "type": "boolean" }, diff --git a/googleapiclient/discovery_cache/documents/mybusinessaccountmanagement.v1.json b/googleapiclient/discovery_cache/documents/mybusinessaccountmanagement.v1.json index c0a8e93996e..00cd0e45c20 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessaccountmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessaccountmanagement.v1.json @@ -530,7 +530,7 @@ } } }, - "revision": "20230703", + "revision": "20230708", "rootUrl": "https://mybusinessaccountmanagement.googleapis.com/", "schemas": { "AcceptInvitationRequest": { diff --git a/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json b/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json index 1eea719f52c..165d1d11b60 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json @@ -612,7 +612,7 @@ } } }, - "revision": "20230703", + "revision": "20230708", "rootUrl": "https://mybusinessbusinessinformation.googleapis.com/", "schemas": { "AdWordsLocationExtensions": { diff --git a/googleapiclient/discovery_cache/documents/mybusinesslodging.v1.json b/googleapiclient/discovery_cache/documents/mybusinesslodging.v1.json index 813f349858d..cda3b6a3363 100644 --- a/googleapiclient/discovery_cache/documents/mybusinesslodging.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinesslodging.v1.json @@ -194,7 +194,7 @@ } } }, - "revision": "20230703", + "revision": "20230708", "rootUrl": "https://mybusinesslodging.googleapis.com/", "schemas": { "Accessibility": { diff --git a/googleapiclient/discovery_cache/documents/mybusinessnotifications.v1.json b/googleapiclient/discovery_cache/documents/mybusinessnotifications.v1.json index 6cdd72d0c99..02cb05f6774 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessnotifications.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessnotifications.v1.json @@ -154,7 +154,7 @@ } } }, - "revision": "20230703", + "revision": "20230708", "rootUrl": "https://mybusinessnotifications.googleapis.com/", "schemas": { "NotificationSetting": { diff --git a/googleapiclient/discovery_cache/documents/mybusinessplaceactions.v1.json b/googleapiclient/discovery_cache/documents/mybusinessplaceactions.v1.json index 94f6039c708..227deb0f536 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessplaceactions.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessplaceactions.v1.json @@ -281,7 +281,7 @@ } } }, - "revision": "20230703", + "revision": "20230708", "rootUrl": "https://mybusinessplaceactions.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/mybusinessqanda.v1.json b/googleapiclient/discovery_cache/documents/mybusinessqanda.v1.json index ba725a901e2..f45095fda10 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessqanda.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessqanda.v1.json @@ -323,7 +323,7 @@ } } }, - "revision": "20230703", + "revision": "20230708", "rootUrl": "https://mybusinessqanda.googleapis.com/", "schemas": { "Answer": { diff --git a/googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json b/googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json index 66bdaf70e9d..03498bf84c2 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json @@ -256,7 +256,7 @@ } } }, - "revision": "20230703", + "revision": "20230708", "rootUrl": "https://mybusinessverifications.googleapis.com/", "schemas": { "AddressVerificationData": { diff --git a/googleapiclient/discovery_cache/documents/networkmanagement.v1.json b/googleapiclient/discovery_cache/documents/networkmanagement.v1.json index d3ec5d87a2e..1dc8ed0f185 100644 --- a/googleapiclient/discovery_cache/documents/networkmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/networkmanagement.v1.json @@ -591,7 +591,7 @@ } } }, - "revision": "20230607", + "revision": "20230621", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -1417,6 +1417,7 @@ "type": "string" }, "serviceAccount": { + "deprecated": true, "description": "Service account authorized for the instance.", "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json b/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json index 4c2f599074c..1919c91fb50 100644 --- a/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json @@ -591,7 +591,7 @@ } } }, - "revision": "20230607", + "revision": "20230621", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -827,6 +827,7 @@ "type": "string" }, "serviceName": { + "deprecated": true, "description": "ID of Cloud Run Service this revision belongs to.", "type": "string" }, @@ -1502,6 +1503,7 @@ "type": "string" }, "serviceAccount": { + "deprecated": true, "description": "Service account authorized for the instance.", "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/networkservices.v1.json b/googleapiclient/discovery_cache/documents/networkservices.v1.json index 29f8edf2bf3..c485a1b7ba1 100644 --- a/googleapiclient/discovery_cache/documents/networkservices.v1.json +++ b/googleapiclient/discovery_cache/documents/networkservices.v1.json @@ -2148,7 +2148,7 @@ } } }, - "revision": "20230626", + "revision": "20230630", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json b/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json index 80d24a2d473..5e4ced9cfcf 100644 --- a/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json @@ -2119,7 +2119,7 @@ } } }, - "revision": "20230626", + "revision": "20230630", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/notebooks.v1.json b/googleapiclient/discovery_cache/documents/notebooks.v1.json index 5c8eb3be682..53465dd7f7e 100644 --- a/googleapiclient/discovery_cache/documents/notebooks.v1.json +++ b/googleapiclient/discovery_cache/documents/notebooks.v1.json @@ -1932,7 +1932,7 @@ } } }, - "revision": "20230613", + "revision": "20230627", "rootUrl": "https://notebooks.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2380,6 +2380,7 @@ "type": "string" }, "scaleTier": { + "deprecated": true, "description": "Required. Scale tier of the hardware used for notebook execution. DEPRECATED Will be discontinued. As right now only CUSTOM is supported.", "enum": [ "SCALE_TIER_UNSPECIFIED", @@ -3466,7 +3467,7 @@ "type": "object" }, "RuntimeAcceleratorConfig": { - "description": "Definition of the types of hardware accelerators that can be used. Definition of the types of hardware accelerators that can be used. See [Compute Engine AcceleratorTypes](https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes). Examples: * `nvidia-tesla-k80` * `nvidia-tesla-p100` * `nvidia-tesla-v100` * `nvidia-tesla-p4` * `nvidia-tesla-t4` * `nvidia-tesla-a100`", + "description": "Definition of the types of hardware accelerators that can be used. See [Compute Engine AcceleratorTypes](https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes). Examples: * `nvidia-tesla-k80` * `nvidia-tesla-p100` * `nvidia-tesla-v100` * `nvidia-tesla-p4` * `nvidia-tesla-t4` * `nvidia-tesla-a100`", "id": "RuntimeAcceleratorConfig", "properties": { "coreCount": { @@ -3484,12 +3485,28 @@ "NVIDIA_TESLA_P4", "NVIDIA_TESLA_T4", "NVIDIA_TESLA_A100", + "NVIDIA_L4", "TPU_V2", "TPU_V3", "NVIDIA_TESLA_T4_VWS", "NVIDIA_TESLA_P100_VWS", "NVIDIA_TESLA_P4_VWS" ], + "enumDeprecated": [ + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Accelerator type is not specified.", "Accelerator type is Nvidia Tesla K80.", @@ -3498,6 +3515,7 @@ "Accelerator type is Nvidia Tesla P4.", "Accelerator type is Nvidia Tesla T4.", "Accelerator type is Nvidia Tesla A100 - 40GB.", + "Accelerator type is Nvidia L4.", "(Coming soon) Accelerator type is TPU V2.", "(Coming soon) Accelerator type is TPU V3.", "Accelerator type is NVIDIA Tesla T4 Virtual Workstations.", @@ -4086,6 +4104,7 @@ "type": "string" }, "targetImage": { + "deprecated": true, "description": "Target VM Image. Format: `ainotebooks-vm/project/image-name/name`.", "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/notebooks.v2.json b/googleapiclient/discovery_cache/documents/notebooks.v2.json index 83d1898baab..52a00c114f6 100644 --- a/googleapiclient/discovery_cache/documents/notebooks.v2.json +++ b/googleapiclient/discovery_cache/documents/notebooks.v2.json @@ -396,7 +396,7 @@ } } }, - "revision": "20230613", + "revision": "20230627", "rootUrl": "https://notebooks.googleapis.com/", "schemas": { "Binding": { diff --git a/googleapiclient/discovery_cache/documents/orgpolicy.v2.json b/googleapiclient/discovery_cache/documents/orgpolicy.v2.json index 0b2c782cc7b..733619500f9 100644 --- a/googleapiclient/discovery_cache/documents/orgpolicy.v2.json +++ b/googleapiclient/discovery_cache/documents/orgpolicy.v2.json @@ -915,7 +915,7 @@ } } }, - "revision": "20230628", + "revision": "20230708", "rootUrl": "https://orgpolicy.googleapis.com/", "schemas": { "GoogleCloudOrgpolicyV2AlternatePolicySpec": { @@ -1128,6 +1128,7 @@ "properties": { "alternate": { "$ref": "GoogleCloudOrgpolicyV2AlternatePolicySpec", + "deprecated": true, "description": "Deprecated." }, "dryRunSpec": { diff --git a/googleapiclient/discovery_cache/documents/pagespeedonline.v5.json b/googleapiclient/discovery_cache/documents/pagespeedonline.v5.json index 8b786a55a50..21b3019e042 100644 --- a/googleapiclient/discovery_cache/documents/pagespeedonline.v5.json +++ b/googleapiclient/discovery_cache/documents/pagespeedonline.v5.json @@ -193,7 +193,7 @@ } } }, - "revision": "20230629", + "revision": "20230707", "rootUrl": "https://pagespeedonline.googleapis.com/", "schemas": { "AuditRefs": { @@ -300,6 +300,7 @@ "type": "string" }, "emulatedFormFactor": { + "deprecated": true, "description": "The form factor the emulation should use. This field is deprecated, form_factor should be used instead.", "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json b/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json index 4c2848694b0..45f0abc0e76 100644 --- a/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json +++ b/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json @@ -396,7 +396,7 @@ } } }, - "revision": "20230629", + "revision": "20230709", "rootUrl": "https://paymentsresellersubscription.googleapis.com/", "schemas": { "GoogleCloudPaymentsResellerSubscriptionV1Amount": { diff --git a/googleapiclient/discovery_cache/documents/people.v1.json b/googleapiclient/discovery_cache/documents/people.v1.json index b0b743312e3..58d09c4b24d 100644 --- a/googleapiclient/discovery_cache/documents/people.v1.json +++ b/googleapiclient/discovery_cache/documents/people.v1.json @@ -1172,7 +1172,7 @@ } } }, - "revision": "20230629", + "revision": "20230706", "rootUrl": "https://people.googleapis.com/", "schemas": { "Address": { diff --git a/googleapiclient/discovery_cache/documents/playcustomapp.v1.json b/googleapiclient/discovery_cache/documents/playcustomapp.v1.json index 2c503791025..17f60bf4d0c 100644 --- a/googleapiclient/discovery_cache/documents/playcustomapp.v1.json +++ b/googleapiclient/discovery_cache/documents/playcustomapp.v1.json @@ -158,7 +158,7 @@ } } }, - "revision": "20230704", + "revision": "20230710", "rootUrl": "https://playcustomapp.googleapis.com/", "schemas": { "CustomApp": { diff --git a/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1alpha1.json b/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1alpha1.json index 14d73dd41e5..6fb3186842a 100644 --- a/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1alpha1.json @@ -941,7 +941,7 @@ } } }, - "revision": "20230704", + "revision": "20230710", "rootUrl": "https://playdeveloperreporting.googleapis.com/", "schemas": { "GooglePlayDeveloperReportingV1alpha1Anomaly": { diff --git a/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1beta1.json b/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1beta1.json index ba74d2426fa..9da02e83f0c 100644 --- a/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1beta1.json @@ -941,7 +941,7 @@ } } }, - "revision": "20230704", + "revision": "20230710", "rootUrl": "https://playdeveloperreporting.googleapis.com/", "schemas": { "GooglePlayDeveloperReportingV1beta1Anomaly": { diff --git a/googleapiclient/discovery_cache/documents/playintegrity.v1.json b/googleapiclient/discovery_cache/documents/playintegrity.v1.json index 9b1f18775dc..64615a10b06 100644 --- a/googleapiclient/discovery_cache/documents/playintegrity.v1.json +++ b/googleapiclient/discovery_cache/documents/playintegrity.v1.json @@ -138,7 +138,7 @@ } } }, - "revision": "20230704", + "revision": "20230710", "rootUrl": "https://playintegrity.googleapis.com/", "schemas": { "AccountActivity": { diff --git a/googleapiclient/discovery_cache/documents/policyanalyzer.v1.json b/googleapiclient/discovery_cache/documents/policyanalyzer.v1.json index cfeb49a9db5..19806f5969e 100644 --- a/googleapiclient/discovery_cache/documents/policyanalyzer.v1.json +++ b/googleapiclient/discovery_cache/documents/policyanalyzer.v1.json @@ -163,7 +163,7 @@ } } }, - "revision": "20230703", + "revision": "20230708", "rootUrl": "https://policyanalyzer.googleapis.com/", "schemas": { "GoogleCloudPolicyanalyzerV1Activity": { diff --git a/googleapiclient/discovery_cache/documents/policyanalyzer.v1beta1.json b/googleapiclient/discovery_cache/documents/policyanalyzer.v1beta1.json index fc6206ad690..5322a308c44 100644 --- a/googleapiclient/discovery_cache/documents/policyanalyzer.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/policyanalyzer.v1beta1.json @@ -163,7 +163,7 @@ } } }, - "revision": "20230703", + "revision": "20230708", "rootUrl": "https://policyanalyzer.googleapis.com/", "schemas": { "GoogleCloudPolicyanalyzerV1beta1Activity": { diff --git a/googleapiclient/discovery_cache/documents/policysimulator.v1.json b/googleapiclient/discovery_cache/documents/policysimulator.v1.json index 016396111e3..c632e0034bc 100644 --- a/googleapiclient/discovery_cache/documents/policysimulator.v1.json +++ b/googleapiclient/discovery_cache/documents/policysimulator.v1.json @@ -707,7 +707,7 @@ } } }, - "revision": "20230625", + "revision": "20230708", "rootUrl": "https://policysimulator.googleapis.com/", "schemas": { "GoogleCloudPolicysimulatorV1AccessStateDiff": { diff --git a/googleapiclient/discovery_cache/documents/policysimulator.v1alpha.json b/googleapiclient/discovery_cache/documents/policysimulator.v1alpha.json index 834e2341b0f..133c33917ca 100644 --- a/googleapiclient/discovery_cache/documents/policysimulator.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/policysimulator.v1alpha.json @@ -521,7 +521,7 @@ } } }, - "revision": "20230625", + "revision": "20230708", "rootUrl": "https://policysimulator.googleapis.com/", "schemas": { "GoogleCloudPolicysimulatorV1Replay": { diff --git a/googleapiclient/discovery_cache/documents/policysimulator.v1beta.json b/googleapiclient/discovery_cache/documents/policysimulator.v1beta.json index 7beec46e9f5..8c062808ff6 100644 --- a/googleapiclient/discovery_cache/documents/policysimulator.v1beta.json +++ b/googleapiclient/discovery_cache/documents/policysimulator.v1beta.json @@ -521,7 +521,7 @@ } } }, - "revision": "20230625", + "revision": "20230708", "rootUrl": "https://policysimulator.googleapis.com/", "schemas": { "GoogleCloudPolicysimulatorV1Replay": { diff --git a/googleapiclient/discovery_cache/documents/prod_tt_sasportal.v1alpha1.json b/googleapiclient/discovery_cache/documents/prod_tt_sasportal.v1alpha1.json index ce60c040561..acfd3646ca1 100644 --- a/googleapiclient/discovery_cache/documents/prod_tt_sasportal.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/prod_tt_sasportal.v1alpha1.json @@ -2618,7 +2618,7 @@ } } }, - "revision": "20230628", + "revision": "20230708", "rootUrl": "https://prod-tt-sasportal.googleapis.com/", "schemas": { "SasPortalAssignment": { @@ -2758,6 +2758,7 @@ "description": "Output only. Current configuration of the device as registered to the SAS." }, "currentChannels": { + "deprecated": true, "description": "Output only. Current channels with scores.", "items": { "$ref": "SasPortalChannelWithScore" @@ -3035,6 +3036,7 @@ "type": "string" }, "nrqzValidated": { + "deprecated": true, "description": "Output only. Set to `true` if a CPI has validated that they have coordinated with the National Quiet Zone office.", "readOnly": true, "type": "boolean" diff --git a/googleapiclient/discovery_cache/documents/pubsub.v1.json b/googleapiclient/discovery_cache/documents/pubsub.v1.json index 9064111f336..4f3860ea748 100644 --- a/googleapiclient/discovery_cache/documents/pubsub.v1.json +++ b/googleapiclient/discovery_cache/documents/pubsub.v1.json @@ -1566,7 +1566,7 @@ } } }, - "revision": "20230620", + "revision": "20230627", "rootUrl": "https://pubsub.googleapis.com/", "schemas": { "AcknowledgeRequest": { @@ -1675,7 +1675,7 @@ "type": "string" }, "filenameSuffix": { - "description": "Optional. User-provided suffix for Cloud Storage filename. See the [object naming requirements](https://cloud.google.com/storage/docs/objects#naming).", + "description": "Optional. User-provided suffix for Cloud Storage filename. See the [object naming requirements](https://cloud.google.com/storage/docs/objects#naming). Must not end in \"/\".", "type": "string" }, "maxBytes": { diff --git a/googleapiclient/discovery_cache/documents/pubsub.v1beta1a.json b/googleapiclient/discovery_cache/documents/pubsub.v1beta1a.json index 078faacf03b..28b37553e2f 100644 --- a/googleapiclient/discovery_cache/documents/pubsub.v1beta1a.json +++ b/googleapiclient/discovery_cache/documents/pubsub.v1beta1a.json @@ -457,7 +457,7 @@ } } }, - "revision": "20230620", + "revision": "20230627", "rootUrl": "https://pubsub.googleapis.com/", "schemas": { "AcknowledgeRequest": { diff --git a/googleapiclient/discovery_cache/documents/pubsub.v1beta2.json b/googleapiclient/discovery_cache/documents/pubsub.v1beta2.json index 9141fee27b2..a15d01522ce 100644 --- a/googleapiclient/discovery_cache/documents/pubsub.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/pubsub.v1beta2.json @@ -724,7 +724,7 @@ } } }, - "revision": "20230620", + "revision": "20230627", "rootUrl": "https://pubsub.googleapis.com/", "schemas": { "AcknowledgeRequest": { diff --git a/googleapiclient/discovery_cache/documents/pubsublite.v1.json b/googleapiclient/discovery_cache/documents/pubsublite.v1.json index 6ac93288a3d..a5a616fb5d1 100644 --- a/googleapiclient/discovery_cache/documents/pubsublite.v1.json +++ b/googleapiclient/discovery_cache/documents/pubsublite.v1.json @@ -1040,7 +1040,7 @@ } } }, - "revision": "20230623", + "revision": "20230630", "rootUrl": "https://pubsublite.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/googleapiclient/discovery_cache/documents/readerrevenuesubscriptionlinking.v1.json b/googleapiclient/discovery_cache/documents/readerrevenuesubscriptionlinking.v1.json index 3e98b5d0b69..fe04c1826fd 100644 --- a/googleapiclient/discovery_cache/documents/readerrevenuesubscriptionlinking.v1.json +++ b/googleapiclient/discovery_cache/documents/readerrevenuesubscriptionlinking.v1.json @@ -207,7 +207,7 @@ } } }, - "revision": "20230703", + "revision": "20230708", "rootUrl": "https://readerrevenuesubscriptionlinking.googleapis.com/", "schemas": { "DeleteReaderResponse": { diff --git a/googleapiclient/discovery_cache/documents/realtimebidding.v1.json b/googleapiclient/discovery_cache/documents/realtimebidding.v1.json index b276191a5e7..21a3a835a8b 100644 --- a/googleapiclient/discovery_cache/documents/realtimebidding.v1.json +++ b/googleapiclient/discovery_cache/documents/realtimebidding.v1.json @@ -1305,7 +1305,7 @@ } } }, - "revision": "20230628", + "revision": "20230710", "rootUrl": "https://realtimebidding.googleapis.com/", "schemas": { "ActivatePretargetingConfigRequest": { @@ -1809,6 +1809,7 @@ "type": "string" }, "restrictedCategories": { + "deprecated": true, "description": "All restricted categories for the ads that may be shown from this creative.", "items": { "enum": [ @@ -1824,6 +1825,7 @@ "type": "array" }, "version": { + "deprecated": true, "description": "Output only. The version of the creative. Version for a new creative is 1 and it increments during subsequent creative updates.", "format": "int32", "readOnly": true, diff --git a/googleapiclient/discovery_cache/documents/recommendationengine.v1beta1.json b/googleapiclient/discovery_cache/documents/recommendationengine.v1beta1.json index 7ef44608f0a..9067cc04832 100644 --- a/googleapiclient/discovery_cache/documents/recommendationengine.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/recommendationengine.v1beta1.json @@ -841,7 +841,7 @@ } } }, - "revision": "20230622", + "revision": "20230710", "rootUrl": "https://recommendationengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { diff --git a/googleapiclient/discovery_cache/documents/recommender.v1.json b/googleapiclient/discovery_cache/documents/recommender.v1.json index f6ae0e48d30..c69dc22528f 100644 --- a/googleapiclient/discovery_cache/documents/recommender.v1.json +++ b/googleapiclient/discovery_cache/documents/recommender.v1.json @@ -1686,7 +1686,7 @@ } } }, - "revision": "20230622", + "revision": "20230706", "rootUrl": "https://recommender.googleapis.com/", "schemas": { "GoogleCloudRecommenderV1CostProjection": { diff --git a/googleapiclient/discovery_cache/documents/recommender.v1beta1.json b/googleapiclient/discovery_cache/documents/recommender.v1beta1.json index ac5123f2b9f..8193116bee5 100644 --- a/googleapiclient/discovery_cache/documents/recommender.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/recommender.v1beta1.json @@ -1748,7 +1748,7 @@ } } }, - "revision": "20230622", + "revision": "20230706", "rootUrl": "https://recommender.googleapis.com/", "schemas": { "GoogleCloudRecommenderV1beta1CostProjection": { @@ -1953,7 +1953,7 @@ "type": "object" }, "GoogleCloudRecommenderV1beta1InsightType": { - "description": "The type of insight. See google3/googledata/devsite/site-cloud/en/recommender/docs/insights/insight-types.md for more info.", + "description": "The type of insight.", "id": "GoogleCloudRecommenderV1beta1InsightType", "properties": { "name": { @@ -2439,7 +2439,7 @@ "type": "object" }, "GoogleCloudRecommenderV1beta1RecommenderType": { - "description": "The type of a recommender. See google3/googledata/devsite/site-cloud/en/recommender/docs/recommenders.md for more info.", + "description": "The type of a recommender.", "id": "GoogleCloudRecommenderV1beta1RecommenderType", "properties": { "name": { diff --git a/googleapiclient/discovery_cache/documents/reseller.v1.json b/googleapiclient/discovery_cache/documents/reseller.v1.json index f7e1dc01fed..0f344a3270e 100644 --- a/googleapiclient/discovery_cache/documents/reseller.v1.json +++ b/googleapiclient/discovery_cache/documents/reseller.v1.json @@ -651,7 +651,7 @@ } } }, - "revision": "20230630", + "revision": "20230709", "rootUrl": "https://reseller.googleapis.com/", "schemas": { "Address": { diff --git a/googleapiclient/discovery_cache/documents/resourcesettings.v1.json b/googleapiclient/discovery_cache/documents/resourcesettings.v1.json index c33d7a9c99f..948a2ab6991 100644 --- a/googleapiclient/discovery_cache/documents/resourcesettings.v1.json +++ b/googleapiclient/discovery_cache/documents/resourcesettings.v1.json @@ -499,7 +499,7 @@ } } }, - "revision": "20230628", + "revision": "20230708", "rootUrl": "https://resourcesettings.googleapis.com/", "schemas": { "GoogleCloudResourcesettingsV1ListSettingsResponse": { diff --git a/googleapiclient/discovery_cache/documents/retail.v2.json b/googleapiclient/discovery_cache/documents/retail.v2.json index 198f5733b9a..e3247898eb9 100644 --- a/googleapiclient/discovery_cache/documents/retail.v2.json +++ b/googleapiclient/discovery_cache/documents/retail.v2.json @@ -2059,7 +2059,7 @@ } } }, - "revision": "20230622", + "revision": "20230706", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -2555,6 +2555,7 @@ "type": "array" }, "recentSearchResults": { + "deprecated": true, "description": "Deprecated. Matched recent searches of this user. The maximum number of recent searches is 10. This field is a restricted feature. If you want to enable it, contact Retail Search support. This feature is only available when CompleteQueryRequest.visitor_id field is set and UserEvent is imported. The recent searches satisfy the follow rules: * They are ordered from latest to oldest. * They are matched with CompleteQueryRequest.query case insensitively. * They are transformed to lower case. * They are UTF-8 safe. Recent searches are deduplicated. More recent searches will be reserved when duplication happens.", "items": { "$ref": "GoogleCloudRetailV2CompleteQueryResponseRecentSearchResult" @@ -2583,6 +2584,7 @@ "type": "object" }, "GoogleCloudRetailV2CompleteQueryResponseRecentSearchResult": { + "deprecated": true, "description": "Recent search of this user.", "id": "GoogleCloudRetailV2CompleteQueryResponseRecentSearchResult", "properties": { @@ -2813,6 +2815,7 @@ "id": "GoogleCloudRetailV2CustomAttribute", "properties": { "indexable": { + "deprecated": true, "description": "This field is normally ignored unless AttributesConfig.attribute_config_level of the Catalog is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about product-level attribute configuration, see [Configuration modes](https://cloud.google.com/retail/docs/attribute-config#config-modes). If true, custom attribute values are indexed, so that they can be filtered, faceted or boosted in SearchService.Search. This field is ignored in a UserEvent. See SearchRequest.filter, SearchRequest.facet_specs and SearchRequest.boost_spec for more details.", "type": "boolean" }, @@ -2825,6 +2828,7 @@ "type": "array" }, "searchable": { + "deprecated": true, "description": "This field is normally ignored unless AttributesConfig.attribute_config_level of the Catalog is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about product-level attribute configuration, see [Configuration modes](https://cloud.google.com/retail/docs/attribute-config#config-modes). If true, custom attribute values are searchable by text queries in SearchService.Search. This field is ignored in a UserEvent. Only set if type text is set. Otherwise, a INVALID_ARGUMENT error is returned.", "type": "boolean" }, @@ -3004,6 +3008,7 @@ "type": "string" }, "requestId": { + "deprecated": true, "description": "Deprecated. This field is never set.", "type": "string" }, @@ -3051,6 +3056,7 @@ "type": "string" }, "requestId": { + "deprecated": true, "description": "Deprecated. This field has no effect.", "type": "string" }, @@ -3470,6 +3476,7 @@ "type": "integer" }, "pageToken": { + "deprecated": true, "description": "This field is not used; leave it unset.", "type": "string" }, @@ -3755,6 +3762,7 @@ "description": "The rating of this product." }, "retrievableFields": { + "deprecated": true, "description": "Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form \"attributes.key\" where \"key\" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info The maximum number of paths is 30. Otherwise, an INVALID_ARGUMENT error is returned. Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead.", "format": "google-fieldmask", "type": "string" @@ -4399,6 +4407,7 @@ }, "dynamicFacetSpec": { "$ref": "GoogleCloudRetailV2SearchRequestDynamicFacetSpec", + "deprecated": true, "description": "Deprecated. Refer to https://cloud.google.com/retail/docs/configs#dynamic to enable dynamic facets. Do not set this field. The specification for dynamically generated facets. Notice that only textual facets can be dynamically generated." }, "entity": { @@ -5334,6 +5343,47 @@ }, "type": "object" }, + "GoogleCloudRetailV2alphaEnrollSolutionMetadata": { + "description": "Metadata related to the EnrollSolution method. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudRetailV2alphaEnrollSolutionMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudRetailV2alphaEnrollSolutionResponse": { + "description": "Response for EnrollSolution method.", + "id": "GoogleCloudRetailV2alphaEnrollSolutionResponse", + "properties": { + "enrolledSolution": { + "description": "Retail API solution that the project has enrolled.", + "enum": [ + "SOLUTION_TYPE_UNSPECIFIED", + "SOLUTION_TYPE_RECOMMENDATION", + "SOLUTION_TYPE_SEARCH" + ], + "enumDescriptions": [ + "Default value.", + "Used for Recommendations AI.", + "Used for Retail Search." + ], + "type": "string" + }, + "searchSolutionUseCase": { + "description": "Search solution use case that the project has enrolled.", + "enum": [ + "SEARCH_SOLUTION_USE_CASE_UNSPECIFIED", + "SEARCH_SOLUTION_USE_CASE_SEARCH", + "SEARCH_SOLUTION_USE_CASE_BROWSE" + ], + "enumDescriptions": [ + "The value when it's unspecified. In this case, server behavior defaults to SEARCH_SOLUTION_USE_CASE_SEARCH.", + "Search use case. Expects the traffic has a non-empty query.", + "Browse use case. Expects the traffic has an empty query." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudRetailV2alphaExportErrorsConfig": { "description": "Configuration of destination for Export related errors.", "id": "GoogleCloudRetailV2alphaExportErrorsConfig", @@ -5461,6 +5511,7 @@ "type": "string" }, "requestId": { + "deprecated": true, "description": "Deprecated. This field is never set.", "type": "string" }, @@ -6241,6 +6292,7 @@ "type": "string" }, "requestId": { + "deprecated": true, "description": "Deprecated. This field is never set.", "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/retail.v2alpha.json b/googleapiclient/discovery_cache/documents/retail.v2alpha.json index 8e518e409aa..0a15a56e22c 100644 --- a/googleapiclient/discovery_cache/documents/retail.v2alpha.json +++ b/googleapiclient/discovery_cache/documents/retail.v2alpha.json @@ -106,6 +106,86 @@ "protocol": "rest", "resources": { "projects": { + "methods": { + "enrollSolution": { + "description": "Enrolls retail API solution for the project. Recommendation solution is enrolled by default when your project enables Retail API. You don't need to call this API for the recommendation solution.", + "flatPath": "v2alpha/projects/{projectsId}:enrollSolution", + "httpMethod": "POST", + "id": "retail.projects.enrollSolution", + "parameterOrder": [ + "project" + ], + "parameters": { + "project": { + "description": "Required. Full resource name of parent. Format: `projects/{project_number_or_id}`", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2alpha/{+project}:enrollSolution", + "request": { + "$ref": "GoogleCloudRetailV2alphaEnrollSolutionRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getRetailProject": { + "description": "Gets the project. Throws NOT_FOUND if the project wasn't initialized for Retail API Service.", + "flatPath": "v2alpha/projects/{projectsId}/retailProject", + "httpMethod": "GET", + "id": "retail.projects.getRetailProject", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Full resource name of the project. Format: `projects/{project_number_or_id}/retailProject`", + "location": "path", + "pattern": "^projects/[^/]+/retailProject$", + "required": true, + "type": "string" + } + }, + "path": "v2alpha/{+name}", + "response": { + "$ref": "GoogleCloudRetailV2alphaProject" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "listEnrolledSolutions": { + "description": "Lists all the retail API solutions the project has enrolled.", + "flatPath": "v2alpha/projects/{projectsId}:enrolledSolutions", + "httpMethod": "GET", + "id": "retail.projects.listEnrolledSolutions", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Full resource name of parent. Format: `projects/{project_number_or_id}`", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2alpha/{+parent}:enrolledSolutions", + "response": { + "$ref": "GoogleCloudRetailV2alphaListEnrolledSolutionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, "resources": { "locations": { "resources": { @@ -2213,11 +2293,43 @@ ] } } + }, + "retailProject": { + "methods": { + "acceptTerms": { + "description": "Accepts service terms for this project. By making requests to this API, you agree to the terms of service linked below. https://cloud.google.com/retail/data-use-terms", + "flatPath": "v2alpha/projects/{projectsId}/retailProject:acceptTerms", + "httpMethod": "POST", + "id": "retail.projects.retailProject.acceptTerms", + "parameterOrder": [ + "project" + ], + "parameters": { + "project": { + "description": "Required. Full resource name of the project. Format: `projects/{project_number_or_id}/retailProject`", + "location": "path", + "pattern": "^projects/[^/]+/retailProject$", + "required": true, + "type": "string" + } + }, + "path": "v2alpha/{+project}:acceptTerms", + "request": { + "$ref": "GoogleCloudRetailV2alphaAcceptTermsRequest" + }, + "response": { + "$ref": "GoogleCloudRetailV2alphaProject" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } } } }, - "revision": "20230622", + "revision": "20230706", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -2449,6 +2561,7 @@ "type": "string" }, "requestId": { + "deprecated": true, "description": "Deprecated. This field is never set.", "type": "string" }, @@ -2837,6 +2950,12 @@ }, "type": "object" }, + "GoogleCloudRetailV2alphaAcceptTermsRequest": { + "description": "Request for AcceptTerms method.", + "id": "GoogleCloudRetailV2alphaAcceptTermsRequest", + "properties": {}, + "type": "object" + }, "GoogleCloudRetailV2alphaAddCatalogAttributeRequest": { "description": "Request for CatalogService.AddCatalogAttribute method.", "id": "GoogleCloudRetailV2alphaAddCatalogAttributeRequest", @@ -3255,6 +3374,7 @@ "type": "array" }, "recentSearchResults": { + "deprecated": true, "description": "Deprecated. Matched recent searches of this user. The maximum number of recent searches is 10. This field is a restricted feature. If you want to enable it, contact Retail Search support. This feature is only available when CompleteQueryRequest.visitor_id field is set and UserEvent is imported. The recent searches satisfy the follow rules: * They are ordered from latest to oldest. * They are matched with CompleteQueryRequest.query case insensitively. * They are transformed to lower case. * They are UTF-8 safe. Recent searches are deduplicated. More recent searches will be reserved when duplication happens.", "items": { "$ref": "GoogleCloudRetailV2alphaCompleteQueryResponseRecentSearchResult" @@ -3309,6 +3429,7 @@ "type": "object" }, "GoogleCloudRetailV2alphaCompleteQueryResponseRecentSearchResult": { + "deprecated": true, "description": "Recent search of this user.", "id": "GoogleCloudRetailV2alphaCompleteQueryResponseRecentSearchResult", "properties": { @@ -3480,6 +3601,7 @@ }, "facetSpec": { "$ref": "GoogleCloudRetailV2alphaSearchRequestFacetSpec", + "deprecated": true, "description": "A facet specification to perform faceted search. Note that this field is deprecated and will throw NOT_IMPLEMENTED if used for creating a control." }, "name": { @@ -3560,6 +3682,7 @@ "id": "GoogleCloudRetailV2alphaCustomAttribute", "properties": { "indexable": { + "deprecated": true, "description": "This field is normally ignored unless AttributesConfig.attribute_config_level of the Catalog is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about product-level attribute configuration, see [Configuration modes](https://cloud.google.com/retail/docs/attribute-config#config-modes). If true, custom attribute values are indexed, so that they can be filtered, faceted or boosted in SearchService.Search. This field is ignored in a UserEvent. See SearchRequest.filter, SearchRequest.facet_specs and SearchRequest.boost_spec for more details.", "type": "boolean" }, @@ -3572,6 +3695,7 @@ "type": "array" }, "searchable": { + "deprecated": true, "description": "This field is normally ignored unless AttributesConfig.attribute_config_level of the Catalog is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about product-level attribute configuration, see [Configuration modes](https://cloud.google.com/retail/docs/attribute-config#config-modes). If true, custom attribute values are searchable by text queries in SearchService.Search. This field is ignored in a UserEvent. Only set if type text is set. Otherwise, a INVALID_ARGUMENT error is returned.", "type": "boolean" }, @@ -3585,6 +3709,82 @@ }, "type": "object" }, + "GoogleCloudRetailV2alphaEnrollSolutionMetadata": { + "description": "Metadata related to the EnrollSolution method. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudRetailV2alphaEnrollSolutionMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudRetailV2alphaEnrollSolutionRequest": { + "description": "Request for EnrollSolution method.", + "id": "GoogleCloudRetailV2alphaEnrollSolutionRequest", + "properties": { + "searchSolutionUseCase": { + "description": "Solution use case to enroll. Currently settable for Browse to enroll. It should be only set when [solution] is set as SolutionType.SOLUTION_TYPE_SEARCH or an INVALID_ARGUMENT error is thrown.", + "enum": [ + "SEARCH_SOLUTION_USE_CASE_UNSPECIFIED", + "SEARCH_SOLUTION_USE_CASE_SEARCH", + "SEARCH_SOLUTION_USE_CASE_BROWSE" + ], + "enumDescriptions": [ + "The value when it's unspecified. In this case, server behavior defaults to SEARCH_SOLUTION_USE_CASE_SEARCH.", + "Search use case. Expects the traffic has a non-empty query.", + "Browse use case. Expects the traffic has an empty query." + ], + "type": "string" + }, + "solution": { + "description": "Required. Solution to enroll.", + "enum": [ + "SOLUTION_TYPE_UNSPECIFIED", + "SOLUTION_TYPE_RECOMMENDATION", + "SOLUTION_TYPE_SEARCH" + ], + "enumDescriptions": [ + "Default value.", + "Used for Recommendations AI.", + "Used for Retail Search." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2alphaEnrollSolutionResponse": { + "description": "Response for EnrollSolution method.", + "id": "GoogleCloudRetailV2alphaEnrollSolutionResponse", + "properties": { + "enrolledSolution": { + "description": "Retail API solution that the project has enrolled.", + "enum": [ + "SOLUTION_TYPE_UNSPECIFIED", + "SOLUTION_TYPE_RECOMMENDATION", + "SOLUTION_TYPE_SEARCH" + ], + "enumDescriptions": [ + "Default value.", + "Used for Recommendations AI.", + "Used for Retail Search." + ], + "type": "string" + }, + "searchSolutionUseCase": { + "description": "Search solution use case that the project has enrolled.", + "enum": [ + "SEARCH_SOLUTION_USE_CASE_UNSPECIFIED", + "SEARCH_SOLUTION_USE_CASE_SEARCH", + "SEARCH_SOLUTION_USE_CASE_BROWSE" + ], + "enumDescriptions": [ + "The value when it's unspecified. In this case, server behavior defaults to SEARCH_SOLUTION_USE_CASE_SEARCH.", + "Search use case. Expects the traffic has a non-empty query.", + "Browse use case. Expects the traffic has an empty query." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudRetailV2alphaExperimentInfo": { "description": "Metadata for active A/B testing Experiment.", "id": "GoogleCloudRetailV2alphaExperimentInfo", @@ -3834,6 +4034,7 @@ "type": "string" }, "requestId": { + "deprecated": true, "description": "Deprecated. This field is never set.", "type": "string" }, @@ -3885,6 +4086,7 @@ "type": "string" }, "requestId": { + "deprecated": true, "description": "Deprecated. This field has no effect.", "type": "string" }, @@ -4018,6 +4220,30 @@ }, "type": "object" }, + "GoogleCloudRetailV2alphaListEnrolledSolutionsResponse": { + "description": "Response for ListEnrolledSolutions method.", + "id": "GoogleCloudRetailV2alphaListEnrolledSolutionsResponse", + "properties": { + "enrolledSolutions": { + "description": "Retail API solutions that the project has enrolled.", + "items": { + "enum": [ + "SOLUTION_TYPE_UNSPECIFIED", + "SOLUTION_TYPE_RECOMMENDATION", + "SOLUTION_TYPE_SEARCH" + ], + "enumDescriptions": [ + "Default value.", + "Used for Recommendations AI.", + "Used for Retail Search." + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudRetailV2alphaListMerchantCenterAccountLinksResponse": { "description": "Response for MerchantCenterAccountLinkService.ListMerchantCenterAccountLinks method.", "id": "GoogleCloudRetailV2alphaListMerchantCenterAccountLinksResponse", @@ -4572,6 +4798,7 @@ "type": "integer" }, "pageToken": { + "deprecated": true, "description": "This field is not used; leave it unset.", "type": "string" }, @@ -4857,6 +5084,7 @@ "description": "The rating of this product." }, "retrievableFields": { + "deprecated": true, "description": "Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form \"attributes.key\" where \"key\" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info The maximum number of paths is 30. Otherwise, an INVALID_ARGUMENT error is returned. Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead.", "format": "google-fieldmask", "type": "string" @@ -4979,6 +5207,36 @@ }, "type": "object" }, + "GoogleCloudRetailV2alphaProject": { + "description": "Metadata that describes a Cloud Retail Project.", + "id": "GoogleCloudRetailV2alphaProject", + "properties": { + "enrolledSolutions": { + "description": "Output only. Retail API solutions that the project has enrolled.", + "items": { + "enum": [ + "SOLUTION_TYPE_UNSPECIFIED", + "SOLUTION_TYPE_RECOMMENDATION", + "SOLUTION_TYPE_SEARCH" + ], + "enumDescriptions": [ + "Default value.", + "Used for Recommendations AI.", + "Used for Retail Search." + ], + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "name": { + "description": "Output only. Full resource name of the retail project, such as `projects/{project_id_or_number}/retailProject`.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudRetailV2alphaPromotion": { "description": "Promotion specification.", "id": "GoogleCloudRetailV2alphaPromotion", @@ -5501,6 +5759,7 @@ }, "dynamicFacetSpec": { "$ref": "GoogleCloudRetailV2alphaSearchRequestDynamicFacetSpec", + "deprecated": true, "description": "Deprecated. Refer to https://cloud.google.com/retail/docs/configs#dynamic to enable dynamic facets. Do not set this field. The specification for dynamically generated facets. Notice that only textual facets can be dynamically generated." }, "entity": { @@ -6598,6 +6857,7 @@ "type": "string" }, "requestId": { + "deprecated": true, "description": "Deprecated. This field is never set.", "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/retail.v2beta.json b/googleapiclient/discovery_cache/documents/retail.v2beta.json index 780efffef0b..e9927d5b11e 100644 --- a/googleapiclient/discovery_cache/documents/retail.v2beta.json +++ b/googleapiclient/discovery_cache/documents/retail.v2beta.json @@ -2087,7 +2087,7 @@ } } }, - "revision": "20230622", + "revision": "20230706", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -2319,6 +2319,7 @@ "type": "string" }, "requestId": { + "deprecated": true, "description": "Deprecated. This field is never set.", "type": "string" }, @@ -2774,6 +2775,47 @@ }, "type": "object" }, + "GoogleCloudRetailV2alphaEnrollSolutionMetadata": { + "description": "Metadata related to the EnrollSolution method. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudRetailV2alphaEnrollSolutionMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudRetailV2alphaEnrollSolutionResponse": { + "description": "Response for EnrollSolution method.", + "id": "GoogleCloudRetailV2alphaEnrollSolutionResponse", + "properties": { + "enrolledSolution": { + "description": "Retail API solution that the project has enrolled.", + "enum": [ + "SOLUTION_TYPE_UNSPECIFIED", + "SOLUTION_TYPE_RECOMMENDATION", + "SOLUTION_TYPE_SEARCH" + ], + "enumDescriptions": [ + "Default value.", + "Used for Recommendations AI.", + "Used for Retail Search." + ], + "type": "string" + }, + "searchSolutionUseCase": { + "description": "Search solution use case that the project has enrolled.", + "enum": [ + "SEARCH_SOLUTION_USE_CASE_UNSPECIFIED", + "SEARCH_SOLUTION_USE_CASE_SEARCH", + "SEARCH_SOLUTION_USE_CASE_BROWSE" + ], + "enumDescriptions": [ + "The value when it's unspecified. In this case, server behavior defaults to SEARCH_SOLUTION_USE_CASE_SEARCH.", + "Search use case. Expects the traffic has a non-empty query.", + "Browse use case. Expects the traffic has an empty query." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudRetailV2alphaExportErrorsConfig": { "description": "Configuration of destination for Export related errors.", "id": "GoogleCloudRetailV2alphaExportErrorsConfig", @@ -2901,6 +2943,7 @@ "type": "string" }, "requestId": { + "deprecated": true, "description": "Deprecated. This field is never set.", "type": "string" }, @@ -3898,6 +3941,7 @@ "type": "array" }, "recentSearchResults": { + "deprecated": true, "description": "Deprecated. Matched recent searches of this user. The maximum number of recent searches is 10. This field is a restricted feature. If you want to enable it, contact Retail Search support. This feature is only available when CompleteQueryRequest.visitor_id field is set and UserEvent is imported. The recent searches satisfy the follow rules: * They are ordered from latest to oldest. * They are matched with CompleteQueryRequest.query case insensitively. * They are transformed to lower case. * They are UTF-8 safe. Recent searches are deduplicated. More recent searches will be reserved when duplication happens.", "items": { "$ref": "GoogleCloudRetailV2betaCompleteQueryResponseRecentSearchResult" @@ -3926,6 +3970,7 @@ "type": "object" }, "GoogleCloudRetailV2betaCompleteQueryResponseRecentSearchResult": { + "deprecated": true, "description": "Recent search of this user.", "id": "GoogleCloudRetailV2betaCompleteQueryResponseRecentSearchResult", "properties": { @@ -4097,6 +4142,7 @@ }, "facetSpec": { "$ref": "GoogleCloudRetailV2betaSearchRequestFacetSpec", + "deprecated": true, "description": "A facet specification to perform faceted search. Note that this field is deprecated and will throw NOT_IMPLEMENTED if used for creating a control." }, "name": { @@ -4177,6 +4223,7 @@ "id": "GoogleCloudRetailV2betaCustomAttribute", "properties": { "indexable": { + "deprecated": true, "description": "This field is normally ignored unless AttributesConfig.attribute_config_level of the Catalog is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about product-level attribute configuration, see [Configuration modes](https://cloud.google.com/retail/docs/attribute-config#config-modes). If true, custom attribute values are indexed, so that they can be filtered, faceted or boosted in SearchService.Search. This field is ignored in a UserEvent. See SearchRequest.filter, SearchRequest.facet_specs and SearchRequest.boost_spec for more details.", "type": "boolean" }, @@ -4189,6 +4236,7 @@ "type": "array" }, "searchable": { + "deprecated": true, "description": "This field is normally ignored unless AttributesConfig.attribute_config_level of the Catalog is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about product-level attribute configuration, see [Configuration modes](https://cloud.google.com/retail/docs/attribute-config#config-modes). If true, custom attribute values are searchable by text queries in SearchService.Search. This field is ignored in a UserEvent. Only set if type text is set. Otherwise, a INVALID_ARGUMENT error is returned.", "type": "boolean" }, @@ -4451,6 +4499,7 @@ "type": "string" }, "requestId": { + "deprecated": true, "description": "Deprecated. This field is never set.", "type": "string" }, @@ -4498,6 +4547,7 @@ "type": "string" }, "requestId": { + "deprecated": true, "description": "Deprecated. This field has no effect.", "type": "string" }, @@ -5089,6 +5139,7 @@ "type": "integer" }, "pageToken": { + "deprecated": true, "description": "This field is not used; leave it unset.", "type": "string" }, @@ -5374,6 +5425,7 @@ "description": "The rating of this product." }, "retrievableFields": { + "deprecated": true, "description": "Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form \"attributes.key\" where \"key\" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info The maximum number of paths is 30. Otherwise, an INVALID_ARGUMENT error is returned. Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead.", "format": "google-fieldmask", "type": "string" @@ -6018,6 +6070,7 @@ }, "dynamicFacetSpec": { "$ref": "GoogleCloudRetailV2betaSearchRequestDynamicFacetSpec", + "deprecated": true, "description": "Deprecated. Refer to https://cloud.google.com/retail/docs/configs#dynamic to enable dynamic facets. Do not set this field. The specification for dynamically generated facets. Notice that only textual facets can be dynamically generated." }, "entity": { diff --git a/googleapiclient/discovery_cache/documents/run.v2.json b/googleapiclient/discovery_cache/documents/run.v2.json index 33cb022d60c..522d768c856 100644 --- a/googleapiclient/discovery_cache/documents/run.v2.json +++ b/googleapiclient/discovery_cache/documents/run.v2.json @@ -1087,7 +1087,7 @@ } } }, - "revision": "20230625", + "revision": "20230702", "rootUrl": "https://run.googleapis.com/", "schemas": { "GoogleCloudRunV2BinaryAuthorization": { @@ -2405,7 +2405,7 @@ "type": "string" }, "customAudiences": { - "description": "Custom audiences that can be used in the audience field of ID token for authenticated requests.", + "description": "One or more custom audiences that you want this service to support. Specify each custom audience as the full URL in a string. The custom audiences are encoded in the token and used to authenticate requests. For more information, see https://cloud.google.com/run/docs/configuring/custom-audiences.", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/runtimeconfig.v1.json b/googleapiclient/discovery_cache/documents/runtimeconfig.v1.json index 4867b1fc85f..800fc62baa1 100644 --- a/googleapiclient/discovery_cache/documents/runtimeconfig.v1.json +++ b/googleapiclient/discovery_cache/documents/runtimeconfig.v1.json @@ -210,7 +210,7 @@ } } }, - "revision": "20230628", + "revision": "20230710", "rootUrl": "https://runtimeconfig.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/googleapiclient/discovery_cache/documents/runtimeconfig.v1beta1.json b/googleapiclient/discovery_cache/documents/runtimeconfig.v1beta1.json index c12e88d0ba8..f7a16962728 100644 --- a/googleapiclient/discovery_cache/documents/runtimeconfig.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/runtimeconfig.v1beta1.json @@ -805,7 +805,7 @@ } } }, - "revision": "20230628", + "revision": "20230710", "rootUrl": "https://runtimeconfig.googleapis.com/", "schemas": { "Binding": { diff --git a/googleapiclient/discovery_cache/documents/safebrowsing.v4.json b/googleapiclient/discovery_cache/documents/safebrowsing.v4.json index 78ed15cbf84..4fb8d7ab220 100644 --- a/googleapiclient/discovery_cache/documents/safebrowsing.v4.json +++ b/googleapiclient/discovery_cache/documents/safebrowsing.v4.json @@ -261,7 +261,7 @@ } } }, - "revision": "20230619", + "revision": "20230704", "rootUrl": "https://safebrowsing.googleapis.com/", "schemas": { "GoogleProtobufEmpty": { diff --git a/googleapiclient/discovery_cache/documents/script.v1.json b/googleapiclient/discovery_cache/documents/script.v1.json index 835cda8031c..9d3f49a029c 100644 --- a/googleapiclient/discovery_cache/documents/script.v1.json +++ b/googleapiclient/discovery_cache/documents/script.v1.json @@ -887,7 +887,7 @@ } } }, - "revision": "20230618", + "revision": "20230707", "rootUrl": "https://script.googleapis.com/", "schemas": { "Content": { diff --git a/googleapiclient/discovery_cache/documents/searchconsole.v1.json b/googleapiclient/discovery_cache/documents/searchconsole.v1.json index 9d215d06310..0f5aacae5c5 100644 --- a/googleapiclient/discovery_cache/documents/searchconsole.v1.json +++ b/googleapiclient/discovery_cache/documents/searchconsole.v1.json @@ -400,7 +400,7 @@ } } }, - "revision": "20230704", + "revision": "20230710", "rootUrl": "https://searchconsole.googleapis.com/", "schemas": { "AmpInspectionResult": { diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1.json b/googleapiclient/discovery_cache/documents/securitycenter.v1.json index dd634db5b8f..fdd35a000e5 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1.json @@ -4150,7 +4150,7 @@ } } }, - "revision": "20230626", + "revision": "20230706", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -4400,6 +4400,7 @@ "type": "string" }, "muteAnnotation": { + "deprecated": true, "description": "This can be a mute configuration name or any identifier for mute/unmute of findings based on the filter.", "type": "string" } @@ -4736,7 +4737,7 @@ "type": "object" }, "Database": { - "description": "Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided.", + "description": "Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided.", "id": "Database", "properties": { "displayName": { @@ -4751,7 +4752,7 @@ "type": "array" }, "name": { - "description": "The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory.", + "description": "Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory.", "type": "string" }, "query": { @@ -4761,6 +4762,10 @@ "userName": { "description": "The username used to connect to the database. The username might not be an IAM principal and does not have a set format.", "type": "string" + }, + "version": { + "description": "The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion).", + "type": "string" } }, "type": "object" @@ -5411,6 +5416,7 @@ "type": "string" }, "displayName": { + "deprecated": true, "description": "The human readable name to be displayed for the mute config.", "type": "string" }, @@ -6526,7 +6532,8 @@ "NETWORK_SERVICE_DISCOVERY", "ACCESS_TOKEN_MANIPULATION", "ABUSE_ELEVATION_CONTROL_MECHANISM", - "DEFAULT_ACCOUNTS" + "DEFAULT_ACCOUNTS", + "INHIBIT_SYSTEM_RECOVERY" ], "enumDescriptions": [ "Unspecified value.", @@ -6564,7 +6571,8 @@ "T1046", "T1134", "T1548", - "T1078.001" + "T1078.001", + "T1490" ], "type": "string" }, @@ -6647,7 +6655,8 @@ "NETWORK_SERVICE_DISCOVERY", "ACCESS_TOKEN_MANIPULATION", "ABUSE_ELEVATION_CONTROL_MECHANISM", - "DEFAULT_ACCOUNTS" + "DEFAULT_ACCOUNTS", + "INHIBIT_SYSTEM_RECOVERY" ], "enumDescriptions": [ "Unspecified value.", @@ -6685,7 +6694,8 @@ "T1046", "T1134", "T1548", - "T1078.001" + "T1078.001", + "T1490" ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json b/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json index 96d9572984c..970d11ddb3f 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json @@ -896,7 +896,7 @@ } } }, - "revision": "20230626", + "revision": "20230706", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -1458,7 +1458,7 @@ "type": "object" }, "Database": { - "description": "Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided.", + "description": "Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided.", "id": "Database", "properties": { "displayName": { @@ -1473,7 +1473,7 @@ "type": "array" }, "name": { - "description": "The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory.", + "description": "Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory.", "type": "string" }, "query": { @@ -1483,6 +1483,10 @@ "userName": { "description": "The username used to connect to the database. The username might not be an IAM principal and does not have a set format.", "type": "string" + }, + "version": { + "description": "The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion).", + "type": "string" } }, "type": "object" @@ -2133,6 +2137,7 @@ "type": "string" }, "displayName": { + "deprecated": true, "description": "The human readable name to be displayed for the mute config.", "type": "string" }, @@ -3163,7 +3168,8 @@ "NETWORK_SERVICE_DISCOVERY", "ACCESS_TOKEN_MANIPULATION", "ABUSE_ELEVATION_CONTROL_MECHANISM", - "DEFAULT_ACCOUNTS" + "DEFAULT_ACCOUNTS", + "INHIBIT_SYSTEM_RECOVERY" ], "enumDescriptions": [ "Unspecified value.", @@ -3201,7 +3207,8 @@ "T1046", "T1134", "T1548", - "T1078.001" + "T1078.001", + "T1490" ], "type": "string" }, @@ -3284,7 +3291,8 @@ "NETWORK_SERVICE_DISCOVERY", "ACCESS_TOKEN_MANIPULATION", "ABUSE_ELEVATION_CONTROL_MECHANISM", - "DEFAULT_ACCOUNTS" + "DEFAULT_ACCOUNTS", + "INHIBIT_SYSTEM_RECOVERY" ], "enumDescriptions": [ "Unspecified value.", @@ -3322,7 +3330,8 @@ "T1046", "T1134", "T1548", - "T1078.001" + "T1078.001", + "T1490" ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json b/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json index 5f714c70336..c33bd3d84eb 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json @@ -1981,7 +1981,7 @@ } } }, - "revision": "20230626", + "revision": "20230706", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -2479,7 +2479,7 @@ "type": "object" }, "Database": { - "description": "Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided.", + "description": "Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided.", "id": "Database", "properties": { "displayName": { @@ -2494,7 +2494,7 @@ "type": "array" }, "name": { - "description": "The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory.", + "description": "Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory.", "type": "string" }, "query": { @@ -2504,6 +2504,10 @@ "userName": { "description": "The username used to connect to the database. The username might not be an IAM principal and does not have a set format.", "type": "string" + }, + "version": { + "description": "The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion).", + "type": "string" } }, "type": "object" @@ -3202,6 +3206,7 @@ "type": "string" }, "displayName": { + "deprecated": true, "description": "The human readable name to be displayed for the mute config.", "type": "string" }, @@ -3902,7 +3907,8 @@ "NETWORK_SERVICE_DISCOVERY", "ACCESS_TOKEN_MANIPULATION", "ABUSE_ELEVATION_CONTROL_MECHANISM", - "DEFAULT_ACCOUNTS" + "DEFAULT_ACCOUNTS", + "INHIBIT_SYSTEM_RECOVERY" ], "enumDescriptions": [ "Unspecified value.", @@ -3940,7 +3946,8 @@ "T1046", "T1134", "T1548", - "T1078.001" + "T1078.001", + "T1490" ], "type": "string" }, @@ -4023,7 +4030,8 @@ "NETWORK_SERVICE_DISCOVERY", "ACCESS_TOKEN_MANIPULATION", "ABUSE_ELEVATION_CONTROL_MECHANISM", - "DEFAULT_ACCOUNTS" + "DEFAULT_ACCOUNTS", + "INHIBIT_SYSTEM_RECOVERY" ], "enumDescriptions": [ "Unspecified value.", @@ -4061,7 +4069,8 @@ "T1046", "T1134", "T1548", - "T1078.001" + "T1078.001", + "T1490" ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json index bd0b2950539..3e4129c671a 100644 --- a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json @@ -542,7 +542,7 @@ } } }, - "revision": "20230627", + "revision": "20230708", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "AddTenantProjectRequest": { @@ -780,6 +780,7 @@ "type": "string" }, "minDeadline": { + "deprecated": true, "description": "Deprecated, do not use.", "format": "double", "type": "number" @@ -962,6 +963,7 @@ "type": "array" }, "referenceDocsUri": { + "deprecated": true, "description": "Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest", "type": "string" } @@ -1240,6 +1242,7 @@ "id": "Endpoint", "properties": { "aliases": { + "deprecated": true, "description": "Unimplemented. Dot not use. DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on.", "items": { "type": "string" @@ -1898,6 +1901,7 @@ "type": "string" }, "launchStage": { + "deprecated": true, "description": "Deprecated. Must use the MetricDescriptor.launch_stage instead.", "enum": [ "LAUNCH_STAGE_UNSPECIFIED", @@ -3170,6 +3174,7 @@ "type": "string" }, "iamAccountName": { + "deprecated": true, "description": "Deprecated. See b/136209818.", "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json index 6fb7e14a85e..d824ae5fc08 100644 --- a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json @@ -500,7 +500,7 @@ } } }, - "revision": "20230627", + "revision": "20230708", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "Api": { @@ -689,6 +689,7 @@ "type": "string" }, "minDeadline": { + "deprecated": true, "description": "Deprecated, do not use.", "format": "double", "type": "number" @@ -854,6 +855,7 @@ "type": "array" }, "referenceDocsUri": { + "deprecated": true, "description": "Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest", "type": "string" } @@ -1110,6 +1112,7 @@ "id": "Endpoint", "properties": { "aliases": { + "deprecated": true, "description": "Unimplemented. Dot not use. DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on.", "items": { "type": "string" @@ -1732,6 +1735,7 @@ "type": "string" }, "launchStage": { + "deprecated": true, "description": "Deprecated. Must use the MetricDescriptor.launch_stage instead.", "enum": [ "LAUNCH_STAGE_UNSPECIFIED", @@ -2999,6 +3003,7 @@ "type": "string" }, "iamAccountName": { + "deprecated": true, "description": "Deprecated. See b/136209818.", "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/servicenetworking.v1.json b/googleapiclient/discovery_cache/documents/servicenetworking.v1.json index 1a672d250fe..1b3fd940bb2 100644 --- a/googleapiclient/discovery_cache/documents/servicenetworking.v1.json +++ b/googleapiclient/discovery_cache/documents/servicenetworking.v1.json @@ -865,7 +865,7 @@ } } }, - "revision": "20230703", + "revision": "20230708", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { diff --git a/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json b/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json index a755b77a009..f03602b8d87 100644 --- a/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json +++ b/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json @@ -307,7 +307,7 @@ } } }, - "revision": "20230703", + "revision": "20230708", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { diff --git a/googleapiclient/discovery_cache/documents/serviceusage.v1.json b/googleapiclient/discovery_cache/documents/serviceusage.v1.json index 1b56e881534..1a403b31c59 100644 --- a/googleapiclient/discovery_cache/documents/serviceusage.v1.json +++ b/googleapiclient/discovery_cache/documents/serviceusage.v1.json @@ -426,7 +426,7 @@ } } }, - "revision": "20230627", + "revision": "20230708", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -674,6 +674,7 @@ "type": "string" }, "minDeadline": { + "deprecated": true, "description": "Deprecated, do not use.", "format": "double", "type": "number" @@ -922,6 +923,7 @@ "type": "array" }, "referenceDocsUri": { + "deprecated": true, "description": "Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest", "type": "string" } @@ -1292,6 +1294,7 @@ "type": "string" }, "groups": { + "deprecated": true, "description": "DEPRECATED: Please use field `values`. Service group should have prefix `groups/`. The names of the service groups that are enabled (Not Implemented). go/predefined-service-groups. Example: `groups/googleServices`.", "items": { "type": "string" @@ -1299,6 +1302,7 @@ "type": "array" }, "services": { + "deprecated": true, "description": "DEPRECATED: Please use field `values`. Service should have prefix `services/`. The names of the services that are enabled. Example: `storage.googleapis.com`.", "items": { "type": "string" @@ -1337,6 +1341,7 @@ "id": "Endpoint", "properties": { "aliases": { + "deprecated": true, "description": "Unimplemented. Dot not use. DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on.", "items": { "type": "string" @@ -2369,6 +2374,7 @@ "type": "string" }, "launchStage": { + "deprecated": true, "description": "Deprecated. Must use the MetricDescriptor.launch_stage instead.", "enum": [ "LAUNCH_STAGE_UNSPECIFIED", @@ -2862,6 +2868,7 @@ "type": "string" }, "removedValues": { + "deprecated": true, "description": "The values removed from the parent consumer policy.", "items": { "type": "string" diff --git a/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json b/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json index ab325756c6e..b6d508bd192 100644 --- a/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json @@ -964,7 +964,7 @@ } } }, - "revision": "20230627", + "revision": "20230708", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -1212,6 +1212,7 @@ "type": "string" }, "minDeadline": { + "deprecated": true, "description": "Deprecated, do not use.", "format": "double", "type": "number" @@ -1440,6 +1441,7 @@ "type": "array" }, "referenceDocsUri": { + "deprecated": true, "description": "Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest", "type": "string" } @@ -1869,6 +1871,7 @@ "type": "string" }, "groups": { + "deprecated": true, "description": "DEPRECATED: Please use field `values`. Service group should have prefix `groups/`. The names of the service groups that are enabled (Not Implemented). go/predefined-service-groups. Example: `groups/googleServices`.", "items": { "type": "string" @@ -1876,6 +1879,7 @@ "type": "array" }, "services": { + "deprecated": true, "description": "DEPRECATED: Please use field `values`. Service should have prefix `services/`. The names of the services that are enabled. Example: `storage.googleapis.com`.", "items": { "type": "string" @@ -1914,6 +1918,7 @@ "id": "Endpoint", "properties": { "aliases": { + "deprecated": true, "description": "Unimplemented. Dot not use. DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on.", "items": { "type": "string" @@ -3064,6 +3069,7 @@ "type": "string" }, "launchStage": { + "deprecated": true, "description": "Deprecated. Must use the MetricDescriptor.launch_stage instead.", "enum": [ "LAUNCH_STAGE_UNSPECIFIED", @@ -3607,6 +3613,7 @@ "type": "string" }, "removedValues": { + "deprecated": true, "description": "The values removed from the parent consumer policy.", "items": { "type": "string" diff --git a/googleapiclient/discovery_cache/documents/sheets.v4.json b/googleapiclient/discovery_cache/documents/sheets.v4.json index b3a9cc38a53..e9df96f7ed4 100644 --- a/googleapiclient/discovery_cache/documents/sheets.v4.json +++ b/googleapiclient/discovery_cache/documents/sheets.v4.json @@ -870,7 +870,7 @@ } } }, - "revision": "20230620", + "revision": "20230627", "rootUrl": "https://sheets.googleapis.com/", "schemas": { "AddBandingRequest": { diff --git a/googleapiclient/discovery_cache/documents/slides.v1.json b/googleapiclient/discovery_cache/documents/slides.v1.json index 78049350576..9e57e1b86cc 100644 --- a/googleapiclient/discovery_cache/documents/slides.v1.json +++ b/googleapiclient/discovery_cache/documents/slides.v1.json @@ -313,7 +313,7 @@ } } }, - "revision": "20230620", + "revision": "20230627", "rootUrl": "https://slides.googleapis.com/", "schemas": { "AffineTransform": { diff --git a/googleapiclient/discovery_cache/documents/speech.v1.json b/googleapiclient/discovery_cache/documents/speech.v1.json index f23ebf720a0..942197071a5 100644 --- a/googleapiclient/discovery_cache/documents/speech.v1.json +++ b/googleapiclient/discovery_cache/documents/speech.v1.json @@ -524,7 +524,7 @@ } } }, - "revision": "20230608", + "revision": "20230705", "rootUrl": "https://speech.googleapis.com/", "schemas": { "ABNFGrammar": { diff --git a/googleapiclient/discovery_cache/documents/speech.v1p1beta1.json b/googleapiclient/discovery_cache/documents/speech.v1p1beta1.json index beb74138211..018283b4d30 100644 --- a/googleapiclient/discovery_cache/documents/speech.v1p1beta1.json +++ b/googleapiclient/discovery_cache/documents/speech.v1p1beta1.json @@ -524,7 +524,7 @@ } } }, - "revision": "20230608", + "revision": "20230705", "rootUrl": "https://speech.googleapis.com/", "schemas": { "ABNFGrammar": { diff --git a/googleapiclient/discovery_cache/documents/storage.v1.json b/googleapiclient/discovery_cache/documents/storage.v1.json index a19178ba819..529abcebea3 100644 --- a/googleapiclient/discovery_cache/documents/storage.v1.json +++ b/googleapiclient/discovery_cache/documents/storage.v1.json @@ -26,7 +26,7 @@ "description": "Stores and retrieves potentially large, immutable data objects.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/storage/docs/json_api/", - "etag": "\"37393831363834353739303933363430383634\"", + "etag": "\"32393333313736333836323230363033303430\"", "icons": { "x16": "https://www.google.com/images/icons/product/cloud_storage-16.png", "x32": "https://www.google.com/images/icons/product/cloud_storage-32.png" @@ -3010,7 +3010,7 @@ } } }, - "revision": "20230629", + "revision": "20230707", "rootUrl": "https://storage.googleapis.com/", "schemas": { "Bucket": { diff --git a/googleapiclient/discovery_cache/documents/streetviewpublish.v1.json b/googleapiclient/discovery_cache/documents/streetviewpublish.v1.json index 4306cd661e9..576f4a3ea04 100644 --- a/googleapiclient/discovery_cache/documents/streetviewpublish.v1.json +++ b/googleapiclient/discovery_cache/documents/streetviewpublish.v1.json @@ -534,7 +534,7 @@ } } }, - "revision": "20230703", + "revision": "20230708", "rootUrl": "https://streetviewpublish.googleapis.com/", "schemas": { "BatchDeletePhotosRequest": { diff --git a/googleapiclient/discovery_cache/documents/tagmanager.v1.json b/googleapiclient/discovery_cache/documents/tagmanager.v1.json index 4ec1c1fe218..781c63e49f7 100644 --- a/googleapiclient/discovery_cache/documents/tagmanager.v1.json +++ b/googleapiclient/discovery_cache/documents/tagmanager.v1.json @@ -1932,7 +1932,7 @@ } } }, - "revision": "20230628", + "revision": "20230705", "rootUrl": "https://tagmanager.googleapis.com/", "schemas": { "Account": { @@ -2430,6 +2430,7 @@ "type": "array" }, "macro": { + "deprecated": true, "description": "The macros in the container that this version was taken from.", "items": { "$ref": "Macro" @@ -2445,6 +2446,7 @@ "type": "string" }, "rule": { + "deprecated": true, "description": "The rules in the container that this version was taken from.", "items": { "$ref": "Rule" @@ -2500,10 +2502,12 @@ "type": "string" }, "numMacros": { + "deprecated": true, "description": "Number of macros in the container version.", "type": "string" }, "numRules": { + "deprecated": true, "description": "Number of rules in the container version.", "type": "string" }, @@ -3030,6 +3034,7 @@ "type": "string" }, "blockingRuleId": { + "deprecated": true, "description": "Blocking rule IDs. If any of the listed rules evaluate to true, the tag will not fire. @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update", "items": { "type": "string" @@ -3052,6 +3057,7 @@ "type": "string" }, "firingRuleId": { + "deprecated": true, "description": "Firing rule IDs. A tag will fire when any of the listed rules are true and all of its blockingRuleIds (if any specified) are false. @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update", "items": { "type": "string" diff --git a/googleapiclient/discovery_cache/documents/tagmanager.v2.json b/googleapiclient/discovery_cache/documents/tagmanager.v2.json index c4cc7196973..34f76462e24 100644 --- a/googleapiclient/discovery_cache/documents/tagmanager.v2.json +++ b/googleapiclient/discovery_cache/documents/tagmanager.v2.json @@ -3890,7 +3890,7 @@ } } }, - "revision": "20230628", + "revision": "20230705", "rootUrl": "https://tagmanager.googleapis.com/", "schemas": { "Account": { @@ -4710,10 +4710,12 @@ "type": "string" }, "numMacros": { + "deprecated": true, "description": "Number of macros in the container version.", "type": "string" }, "numRules": { + "deprecated": true, "description": "Number of rules in the container version.", "type": "string" }, @@ -5773,6 +5775,7 @@ "type": "string" }, "blockingRuleId": { + "deprecated": true, "description": "Blocking rule IDs. If any of the listed rules evaluate to true, the tag will not fire. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update", "items": { "type": "string" @@ -5799,6 +5802,7 @@ "type": "string" }, "firingRuleId": { + "deprecated": true, "description": "Firing rule IDs. A tag will fire when any of the listed rules are true and all of its blockingRuleIds (if any specified) are false. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update", "items": { "type": "string" diff --git a/googleapiclient/discovery_cache/documents/tasks.v1.json b/googleapiclient/discovery_cache/documents/tasks.v1.json index 03e1f45f442..6d4a0580632 100644 --- a/googleapiclient/discovery_cache/documents/tasks.v1.json +++ b/googleapiclient/discovery_cache/documents/tasks.v1.json @@ -566,7 +566,7 @@ } } }, - "revision": "20230704", + "revision": "20230708", "rootUrl": "https://tasks.googleapis.com/", "schemas": { "Task": { diff --git a/googleapiclient/discovery_cache/documents/testing.v1.json b/googleapiclient/discovery_cache/documents/testing.v1.json index 196d236a1bb..76a1ff5f1db 100644 --- a/googleapiclient/discovery_cache/documents/testing.v1.json +++ b/googleapiclient/discovery_cache/documents/testing.v1.json @@ -282,7 +282,7 @@ } } }, - "revision": "20230627", + "revision": "20230704", "rootUrl": "https://testing.googleapis.com/", "schemas": { "Account": { @@ -580,11 +580,13 @@ "type": "string" }, "maxDepth": { + "deprecated": true, "description": "The max depth of the traversal stack Robo can explore. Needs to be at least 2 to make Robo explore the app beyond the first activity. Default is 50.", "format": "int32", "type": "integer" }, "maxSteps": { + "deprecated": true, "description": "The max number of steps Robo can execute. Default is no limit.", "format": "int32", "type": "integer" @@ -1610,6 +1612,7 @@ "type": "string" }, "orchestratorVersion": { + "deprecated": true, "description": "Deprecated: Use AndroidX Test Orchestrator going forward. A string representing the current version of Android Test Orchestrator that is used in the environment. The package is available at https://maven.google.com/web/index.html#com.android.support.test:orchestrator.", "type": "string" } @@ -1814,6 +1817,7 @@ "id": "SystraceSetup", "properties": { "durationSeconds": { + "deprecated": true, "description": "Systrace duration in seconds. Should be between 1 and 30 seconds. 0 disables systrace.", "format": "int32", "type": "integer" @@ -2004,6 +2008,47 @@ "SERVICE_NOT_ACTIVATED", "UNKNOWN_PERMISSION_ERROR" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Do not use. For proto versioning only.", "The matrix is INVALID, but there are no further details available.", @@ -2172,6 +2217,7 @@ }, "systrace": { "$ref": "SystraceSetup", + "deprecated": true, "description": "Systrace configuration for the run. Deprecated: Systrace used Python 2 which was sunsetted on 2020-01-01. Systrace is no longer supported in the Cloud Testing API, and no Systrace file will be provided in the results." } }, diff --git a/googleapiclient/discovery_cache/documents/toolresults.v1beta3.json b/googleapiclient/discovery_cache/documents/toolresults.v1beta3.json index 9c425607bd4..fb1b06adced 100644 --- a/googleapiclient/discovery_cache/documents/toolresults.v1beta3.json +++ b/googleapiclient/discovery_cache/documents/toolresults.v1beta3.json @@ -1463,7 +1463,7 @@ } } }, - "revision": "20230704", + "revision": "20230710", "rootUrl": "https://toolresults.googleapis.com/", "schemas": { "ANR": { @@ -1905,7 +1905,7 @@ "type": "object" }, "Execution": { - "description": "An Execution represents a collection of Steps. For instance, it could represent: - a mobile test executed across a range of device configurations - a jenkins job with a build step followed by a test step The maximum size of an execution message is 1 MiB. An Execution can be updated until its state is set to COMPLETE at which point it becomes immutable. Next tag: 17", + "description": "An Execution represents a collection of Steps. For instance, it could represent: - a mobile test executed across a range of device configurations - a jenkins job with a build step followed by a test step The maximum size of an execution message is 1 MiB. An Execution can be updated until its state is set to COMPLETE at which point it becomes immutable.", "id": "Execution", "properties": { "completionTime": { @@ -3219,7 +3219,7 @@ "type": "object" }, "Step": { - "description": "A Step represents a single operation performed as part of Execution. A step can be used to represent the execution of a tool ( for example a test runner execution or an execution of a compiler). Steps can overlap (for instance two steps might have the same start time if some operations are done in parallel). Here is an example, let's consider that we have a continuous build is executing a test runner for each iteration. The workflow would look like: - user creates a Execution with id 1 - user creates a TestExecutionStep with id 100 for Execution 1 - user update TestExecutionStep with id 100 to add a raw xml log + the service parses the xml logs and returns a TestExecutionStep with updated TestResult(s). - user update the status of TestExecutionStep with id 100 to COMPLETE A Step can be updated until its state is set to COMPLETE at which points it becomes immutable. Next tag: 27", + "description": "A Step represents a single operation performed as part of Execution. A step can be used to represent the execution of a tool ( for example a test runner execution or an execution of a compiler). Steps can overlap (for instance two steps might have the same start time if some operations are done in parallel). Here is an example, let's consider that we have a continuous build is executing a test runner for each iteration. The workflow would look like: - user creates a Execution with id 1 - user creates a TestExecutionStep with id 100 for Execution 1 - user update TestExecutionStep with id 100 to add a raw xml log + the service parses the xml logs and returns a TestExecutionStep with updated TestResult(s). - user update the status of TestExecutionStep with id 100 to COMPLETE A Step can be updated until its state is set to COMPLETE at which points it becomes immutable.", "id": "Step", "properties": { "completionTime": { diff --git a/googleapiclient/discovery_cache/documents/trafficdirector.v2.json b/googleapiclient/discovery_cache/documents/trafficdirector.v2.json index 23c8758a7ee..055f226027a 100644 --- a/googleapiclient/discovery_cache/documents/trafficdirector.v2.json +++ b/googleapiclient/discovery_cache/documents/trafficdirector.v2.json @@ -128,7 +128,7 @@ } } }, - "revision": "20230526", + "revision": "20230622", "rootUrl": "https://trafficdirector.googleapis.com/", "schemas": { "Address": { diff --git a/googleapiclient/discovery_cache/documents/travelimpactmodel.v1.json b/googleapiclient/discovery_cache/documents/travelimpactmodel.v1.json index 9ae3b2858f6..b134509dba5 100644 --- a/googleapiclient/discovery_cache/documents/travelimpactmodel.v1.json +++ b/googleapiclient/discovery_cache/documents/travelimpactmodel.v1.json @@ -116,7 +116,7 @@ } } }, - "revision": "20230704", + "revision": "20230710", "rootUrl": "https://travelimpactmodel.googleapis.com/", "schemas": { "ComputeFlightEmissionsRequest": { diff --git a/googleapiclient/discovery_cache/documents/vault.v1.json b/googleapiclient/discovery_cache/documents/vault.v1.json index 7dc4207bf78..78ec74d4ac0 100644 --- a/googleapiclient/discovery_cache/documents/vault.v1.json +++ b/googleapiclient/discovery_cache/documents/vault.v1.json @@ -1193,7 +1193,7 @@ } } }, - "revision": "20230626", + "revision": "20230628", "rootUrl": "https://vault.googleapis.com/", "schemas": { "AccountCount": { diff --git a/googleapiclient/discovery_cache/documents/versionhistory.v1.json b/googleapiclient/discovery_cache/documents/versionhistory.v1.json index facf7a2c15e..836e46cf1df 100644 --- a/googleapiclient/discovery_cache/documents/versionhistory.v1.json +++ b/googleapiclient/discovery_cache/documents/versionhistory.v1.json @@ -271,7 +271,7 @@ } } }, - "revision": "20230703", + "revision": "20230708", "rootUrl": "https://versionhistory.googleapis.com/", "schemas": { "Channel": { diff --git a/googleapiclient/discovery_cache/documents/vmmigration.v1.json b/googleapiclient/discovery_cache/documents/vmmigration.v1.json index 4b636edf5e9..7d0b2d9f3ca 100644 --- a/googleapiclient/discovery_cache/documents/vmmigration.v1.json +++ b/googleapiclient/discovery_cache/documents/vmmigration.v1.json @@ -1972,7 +1972,7 @@ } } }, - "revision": "20230622", + "revision": "20230629", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AccessKeyCredentials": { diff --git a/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json b/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json index c840f891279..6f35acac59c 100644 --- a/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json @@ -1972,7 +1972,7 @@ } } }, - "revision": "20230622", + "revision": "20230629", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AccessKeyCredentials": { diff --git a/googleapiclient/discovery_cache/documents/webrisk.v1.json b/googleapiclient/discovery_cache/documents/webrisk.v1.json index cc5821387e5..5595878b39a 100644 --- a/googleapiclient/discovery_cache/documents/webrisk.v1.json +++ b/googleapiclient/discovery_cache/documents/webrisk.v1.json @@ -420,7 +420,7 @@ } } }, - "revision": "20230625", + "revision": "20230708", "rootUrl": "https://webrisk.googleapis.com/", "schemas": { "GoogleCloudWebriskV1ComputeThreatListDiffResponse": { diff --git a/googleapiclient/discovery_cache/documents/websecurityscanner.v1.json b/googleapiclient/discovery_cache/documents/websecurityscanner.v1.json index 0847b55e6c3..8e29febc4d2 100644 --- a/googleapiclient/discovery_cache/documents/websecurityscanner.v1.json +++ b/googleapiclient/discovery_cache/documents/websecurityscanner.v1.json @@ -526,7 +526,7 @@ } } }, - "revision": "20230622", + "revision": "20230701", "rootUrl": "https://websecurityscanner.googleapis.com/", "schemas": { "Authentication": { @@ -539,6 +539,7 @@ }, "googleAccount": { "$ref": "GoogleAccount", + "deprecated": true, "description": "Authentication using a Google account." }, "iapCredential": { @@ -722,6 +723,7 @@ "type": "object" }, "GoogleAccount": { + "deprecated": true, "description": "Describes authentication configuration that uses a Google account.", "id": "GoogleAccount", "properties": { diff --git a/googleapiclient/discovery_cache/documents/websecurityscanner.v1alpha.json b/googleapiclient/discovery_cache/documents/websecurityscanner.v1alpha.json index 99cbbe39369..b285f2cb453 100644 --- a/googleapiclient/discovery_cache/documents/websecurityscanner.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/websecurityscanner.v1alpha.json @@ -526,7 +526,7 @@ } } }, - "revision": "20230622", + "revision": "20230701", "rootUrl": "https://websecurityscanner.googleapis.com/", "schemas": { "Authentication": { diff --git a/googleapiclient/discovery_cache/documents/websecurityscanner.v1beta.json b/googleapiclient/discovery_cache/documents/websecurityscanner.v1beta.json index 4bc0fecc3ea..86bd8d8d587 100644 --- a/googleapiclient/discovery_cache/documents/websecurityscanner.v1beta.json +++ b/googleapiclient/discovery_cache/documents/websecurityscanner.v1beta.json @@ -526,7 +526,7 @@ } } }, - "revision": "20230622", + "revision": "20230701", "rootUrl": "https://websecurityscanner.googleapis.com/", "schemas": { "Authentication": { @@ -539,6 +539,7 @@ }, "googleAccount": { "$ref": "GoogleAccount", + "deprecated": true, "description": "Authentication using a Google account." }, "iapCredential": { @@ -720,6 +721,7 @@ "type": "object" }, "GoogleAccount": { + "deprecated": true, "description": "Describes authentication configuration that uses a Google account.", "id": "GoogleAccount", "properties": { diff --git a/googleapiclient/discovery_cache/documents/workloadmanager.v1.json b/googleapiclient/discovery_cache/documents/workloadmanager.v1.json index 8b6e82d209c..984a5ae7b63 100644 --- a/googleapiclient/discovery_cache/documents/workloadmanager.v1.json +++ b/googleapiclient/discovery_cache/documents/workloadmanager.v1.json @@ -12,7 +12,7 @@ "baseUrl": "https://workloadmanager.googleapis.com/", "batchPath": "batch", "canonicalName": "Workload Manager", - "description": "", + "description": "Workload Manager is a service that provides tooling for enterprise workloads to automate the deployment and validation of your workloads against best practices and recommendations.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/workload-manager/docs", "fullyEncodeReservedExpansion": true, @@ -707,7 +707,7 @@ } } }, - "revision": "20230621", + "revision": "20230630", "rootUrl": "https://workloadmanager.googleapis.com/", "schemas": { "CancelOperationRequest": { @@ -1429,11 +1429,39 @@ "type": "array" }, "resourceKind": { - "description": "ComputeInstance, ComputeDisk, VPC, Bare Metal server, etc.", + "description": "Required. ComputeInstance, ComputeDisk, VPC, Bare Metal server, etc.", + "enum": [ + "RESOURCE_KIND_UNSPECIFIED", + "RESOURCE_KIND_INSTANCE", + "RESOURCE_KIND_DISK", + "RESOURCE_KIND_ADDRESS", + "RESOURCE_KIND_FILESTORE", + "RESOURCE_KIND_HEALTH_CHECK", + "RESOURCE_KIND_FORWARDING_RULE", + "RESOURCE_KIND_BACKEND_SERVICE", + "RESOURCE_KIND_SUBNETWORK", + "RESOURCE_KIND_NETWORK", + "RESOURCE_KIND_PUBLIC_ADDRESS", + "RESOURCE_KIND_INSTANCE_GROUP" + ], + "enumDescriptions": [ + "Unspecified resource kind.", + "This is a compute instance.", + "This is a compute disk.", + "This is a compute address.", + "This is a filestore instance.", + "This is a compute health check.", + "This is a compute forwarding rule.", + "This is a compute backend service.", + "This is a compute subnetwork.", + "This is a compute network.", + "This is a public accessible IP Address.", + "This is a compute instance group." + ], "type": "string" }, "resourceType": { - "description": "The type of this resource.", + "description": "Required. The type of this resource.", "enum": [ "RESOURCE_TYPE_UNSPECIFIED", "COMPUTE", @@ -1527,6 +1555,14 @@ "description": "The agent version collected this data point", "type": "string" }, + "instance": { + "description": "Required. The instance_name of the instance that the Insight data comes from. According to https://linter.aip.dev/122/name-suffix: field names should not use the _name suffix unless the field would be ambiguous without it.", + "type": "string" + }, + "projectId": { + "description": "Required. The project_id of the cloud project that the Insight data comes from.", + "type": "string" + }, "validationDetails": { "description": "A list of SqlServer validation metrics data.", "items": { diff --git a/googleapiclient/discovery_cache/documents/workstations.v1beta.json b/googleapiclient/discovery_cache/documents/workstations.v1beta.json index 0e237b9aa7e..bcaea7c599e 100644 --- a/googleapiclient/discovery_cache/documents/workstations.v1beta.json +++ b/googleapiclient/discovery_cache/documents/workstations.v1beta.json @@ -1127,7 +1127,7 @@ } } }, - "revision": "20230619", + "revision": "20230630", "rootUrl": "https://workstations.googleapis.com/", "schemas": { "Accelerator": { diff --git a/googleapiclient/discovery_cache/documents/youtube.v3.json b/googleapiclient/discovery_cache/documents/youtube.v3.json index 126f2d80cab..c5c6cdb099f 100644 --- a/googleapiclient/discovery_cache/documents/youtube.v3.json +++ b/googleapiclient/discovery_cache/documents/youtube.v3.json @@ -3833,7 +3833,7 @@ } } }, - "revision": "20230628", + "revision": "20230708", "rootUrl": "https://youtube.googleapis.com/", "schemas": { "AbuseReport": { @@ -4201,6 +4201,7 @@ "type": "string" }, "eventId": { + "deprecated": true, "description": "Serialized EventId of the request which produced this response.", "type": "string" }, @@ -4228,9 +4229,11 @@ "type": "string" }, "tokenPagination": { - "$ref": "TokenPagination" + "$ref": "TokenPagination", + "deprecated": true }, "visitorId": { + "deprecated": true, "description": "The visitorId identifies the visitor.", "type": "string" } @@ -4342,6 +4345,7 @@ "type": "string" }, "eventId": { + "deprecated": true, "description": "Serialized EventId of the request which produced this response.", "type": "string" }, @@ -4358,6 +4362,7 @@ "type": "string" }, "visitorId": { + "deprecated": true, "description": "The visitorId identifies the visitor.", "type": "string" } @@ -4492,6 +4497,7 @@ "youtube.liveStreams.update" ] }, + "deprecated": true, "description": "The format of the video stream that you are sending to Youtube. ", "type": "string" }, @@ -4584,6 +4590,7 @@ }, "conversionPings": { "$ref": "ChannelConversionPings", + "deprecated": true, "description": "The conversionPings object encapsulates information about conversion pings that need to be respected by the channel." }, "etag": { @@ -4672,6 +4679,7 @@ "description": "Branding properties for the channel view." }, "hints": { + "deprecated": true, "description": "Additional experimental branding properties.", "items": { "$ref": "PropertyValue" @@ -4684,6 +4692,7 @@ }, "watch": { "$ref": "WatchSettings", + "deprecated": true, "description": "Branding properties for the watch page." } }, @@ -4696,6 +4705,7 @@ "relatedPlaylists": { "properties": { "favorites": { + "deprecated": true, "description": "The ID of the playlist that contains the channel\"s favorite videos. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.", "type": "string" }, @@ -4708,10 +4718,12 @@ "type": "string" }, "watchHistory": { + "deprecated": true, "description": "The ID of the playlist that contains the channel\"s watch history. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.", "type": "string" }, "watchLater": { + "deprecated": true, "description": "The ID of the playlist that contains the channel\"s watch later playlist. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.", "type": "string" } @@ -4784,6 +4796,7 @@ "type": "string" }, "eventId": { + "deprecated": true, "description": "Serialized EventId of the request which produced this response.", "type": "string" }, @@ -4811,9 +4824,11 @@ "type": "string" }, "tokenPagination": { - "$ref": "TokenPagination" + "$ref": "TokenPagination", + "deprecated": true }, "visitorId": { + "deprecated": true, "description": "The visitorId identifies the visitor.", "type": "string" } @@ -4881,6 +4896,7 @@ "additionalProperties": { "$ref": "ChannelSectionLocalization" }, + "deprecated": true, "description": "Localizations for different languages", "type": "object" }, @@ -4890,6 +4906,7 @@ }, "targeting": { "$ref": "ChannelSectionTargeting", + "deprecated": true, "description": "The targeting object contains basic targeting settings about the channel section." } }, @@ -4924,6 +4941,7 @@ "type": "string" }, "eventId": { + "deprecated": true, "description": "Serialized EventId of the request which produced this response.", "type": "string" }, @@ -4940,6 +4958,7 @@ "type": "string" }, "visitorId": { + "deprecated": true, "description": "The visitorId identifies the visitor.", "type": "string" } @@ -4951,6 +4970,7 @@ "id": "ChannelSectionLocalization", "properties": { "title": { + "deprecated": true, "description": "The localized strings for channel section's title.", "type": "string" } @@ -4966,11 +4986,13 @@ "type": "string" }, "defaultLanguage": { + "deprecated": true, "description": "The language of the channel section's default title and description.", "type": "string" }, "localized": { "$ref": "ChannelSectionLocalization", + "deprecated": true, "description": "Localized title, read-only." }, "position": { @@ -4979,6 +5001,7 @@ "type": "integer" }, "style": { + "deprecated": true, "description": "The style of the channel section.", "enum": [ "channelsectionStyleUnspecified", @@ -5017,6 +5040,25 @@ "postedPlaylists", "subscriptions" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + true, + false, + true, + true, + true, + false, + false, + false, + false, + true, + true, + false + ], "enumDescriptions": [ "", "", @@ -5046,6 +5088,7 @@ "id": "ChannelSectionTargeting", "properties": { "countries": { + "deprecated": true, "description": "The country the channel section is targeting.", "items": { "type": "string" @@ -5053,6 +5096,7 @@ "type": "array" }, "languages": { + "deprecated": true, "description": "The language the channel section is targeting.", "items": { "type": "string" @@ -5060,6 +5104,7 @@ "type": "array" }, "regions": { + "deprecated": true, "description": "The region the channel section is targeting.", "items": { "type": "string" @@ -5081,6 +5126,7 @@ "type": "string" }, "defaultTab": { + "deprecated": true, "description": "Which content tab users should see when viewing the channel.", "type": "string" }, @@ -5089,10 +5135,12 @@ "type": "string" }, "featuredChannelsTitle": { + "deprecated": true, "description": "Title for the featured channels tab.", "type": "string" }, "featuredChannelsUrls": { + "deprecated": true, "description": "The list of featured channels.", "items": { "type": "string" @@ -5108,14 +5156,17 @@ "type": "boolean" }, "profileColor": { + "deprecated": true, "description": "A prominent color that can be rendered on this channel page.", "type": "string" }, "showBrowseView": { + "deprecated": true, "description": "Whether the tab to browse the videos should be displayed.", "type": "boolean" }, "showRelatedChannels": { + "deprecated": true, "description": "Whether related channels should be proposed.", "type": "boolean" }, @@ -5284,6 +5335,7 @@ "type": "array" }, "topicIds": { + "deprecated": true, "description": "A list of Freebase topic IDs associated with the channel. You can retrieve information about each topic using the Freebase Topic API.", "items": { "type": "string" @@ -5325,6 +5377,7 @@ "type": "string" }, "eventId": { + "deprecated": true, "description": "Serialized EventId of the request which produced this response.", "type": "string" }, @@ -5349,9 +5402,11 @@ "description": "General pagination information." }, "tokenPagination": { - "$ref": "TokenPagination" + "$ref": "TokenPagination", + "deprecated": true }, "visitorId": { + "deprecated": true, "description": "The visitorId identifies the visitor.", "type": "string" } @@ -5495,6 +5550,7 @@ "type": "string" }, "eventId": { + "deprecated": true, "description": "Serialized EventId of the request which produced this response.", "type": "string" }, @@ -5519,9 +5575,11 @@ "description": "General pagination information." }, "tokenPagination": { - "$ref": "TokenPagination" + "$ref": "TokenPagination", + "deprecated": true }, "visitorId": { + "deprecated": true, "description": "The visitorId identifies the visitor.", "type": "string" } @@ -6272,6 +6330,7 @@ "type": "string" }, "fmocRating": { + "deprecated": true, "description": "This property has been deprecated. Use the contentDetails.contentRating.cncRating instead.", "enum": [ "fmocUnspecified", @@ -6588,6 +6647,18 @@ "lsf21", "lsfUnrated" ], + "enumDeprecated": [ + false, + false, + false, + true, + false, + true, + false, + true, + false, + true + ], "enumDescriptions": [ "", "SU", @@ -7501,6 +7572,7 @@ "type": "string" }, "eventId": { + "deprecated": true, "description": "Serialized EventId of the request which produced this response.", "type": "string" }, @@ -7517,6 +7589,7 @@ "type": "string" }, "visitorId": { + "deprecated": true, "description": "The visitorId identifies the visitor.", "type": "string" } @@ -7544,6 +7617,7 @@ "properties": { "backgroundImageUrl": { "$ref": "LocalizedProperty", + "deprecated": true, "description": "The URL for the background image shown on the video watch page. The image should be 1200px by 615px, with a maximum file size of 128k." }, "bannerExternalUrl": { @@ -7551,82 +7625,102 @@ "type": "string" }, "bannerImageUrl": { + "deprecated": true, "description": "Banner image. Desktop size (1060x175).", "type": "string" }, "bannerMobileExtraHdImageUrl": { + "deprecated": true, "description": "Banner image. Mobile size high resolution (1440x395).", "type": "string" }, "bannerMobileHdImageUrl": { + "deprecated": true, "description": "Banner image. Mobile size high resolution (1280x360).", "type": "string" }, "bannerMobileImageUrl": { + "deprecated": true, "description": "Banner image. Mobile size (640x175).", "type": "string" }, "bannerMobileLowImageUrl": { + "deprecated": true, "description": "Banner image. Mobile size low resolution (320x88).", "type": "string" }, "bannerMobileMediumHdImageUrl": { + "deprecated": true, "description": "Banner image. Mobile size medium/high resolution (960x263).", "type": "string" }, "bannerTabletExtraHdImageUrl": { + "deprecated": true, "description": "Banner image. Tablet size extra high resolution (2560x424).", "type": "string" }, "bannerTabletHdImageUrl": { + "deprecated": true, "description": "Banner image. Tablet size high resolution (2276x377).", "type": "string" }, "bannerTabletImageUrl": { + "deprecated": true, "description": "Banner image. Tablet size (1707x283).", "type": "string" }, "bannerTabletLowImageUrl": { + "deprecated": true, "description": "Banner image. Tablet size low resolution (1138x188).", "type": "string" }, "bannerTvHighImageUrl": { + "deprecated": true, "description": "Banner image. TV size high resolution (1920x1080).", "type": "string" }, "bannerTvImageUrl": { + "deprecated": true, "description": "Banner image. TV size extra high resolution (2120x1192).", "type": "string" }, "bannerTvLowImageUrl": { + "deprecated": true, "description": "Banner image. TV size low resolution (854x480).", "type": "string" }, "bannerTvMediumImageUrl": { + "deprecated": true, "description": "Banner image. TV size medium resolution (1280x720).", "type": "string" }, "largeBrandedBannerImageImapScript": { "$ref": "LocalizedProperty", + "deprecated": true, "description": "The image map script for the large banner image." }, "largeBrandedBannerImageUrl": { "$ref": "LocalizedProperty", + "deprecated": true, "description": "The URL for the 854px by 70px image that appears below the video player in the expanded video view of the video watch page." }, "smallBrandedBannerImageImapScript": { "$ref": "LocalizedProperty", + "deprecated": true, "description": "The image map script for the small banner image." }, "smallBrandedBannerImageUrl": { "$ref": "LocalizedProperty", + "deprecated": true, "description": "The URL for the 640px by 70px banner image that appears below the video player in the default view of the video watch page. The URL for the image that appears above the top-left corner of the video player. This is a 25-pixel-high image with a flexible width that cannot exceed 170 pixels." }, "trackingImageUrl": { + "deprecated": true, "description": "The URL for a 1px by 1px tracking pixel that can be used to collect statistics for views of the channel or video pages.", "type": "string" }, "watchIconImageUrl": { + "deprecated": true, "type": "string" } }, @@ -7699,6 +7793,12 @@ "bottomLeft", "bottomRight" ], + "enumDeprecated": [ + true, + false, + true, + true + ], "enumDescriptions": [ "", "", @@ -7846,6 +7946,7 @@ "type": "boolean" }, "enableClosedCaptions": { + "deprecated": true, "description": "This setting indicates whether HTTP POST closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API. This is mutually exclusive with using the closed_captions_type property, and is equivalent to setting closed_captions_type to CLOSED_CAPTIONS_HTTP_POST.", "type": "boolean" }, @@ -7862,6 +7963,7 @@ "type": "boolean" }, "enableLowLatency": { + "deprecated": true, "description": "Indicates whether this broadcast has low latency enabled.", "type": "boolean" }, @@ -7941,6 +8043,7 @@ "type": "string" }, "eventId": { + "deprecated": true, "description": "Serialized EventId of the request which produced this response.", "type": "string" }, @@ -7969,9 +8072,11 @@ "type": "string" }, "tokenPagination": { - "$ref": "TokenPagination" + "$ref": "TokenPagination", + "deprecated": true }, "visitorId": { + "deprecated": true, "description": "The visitorId identifies the visitor.", "type": "string" } @@ -8365,6 +8470,7 @@ "type": "string" }, "eventId": { + "deprecated": true, "description": "Serialized EventId of the request which produced this response.", "type": "string" }, @@ -8397,9 +8503,11 @@ "type": "integer" }, "tokenPagination": { - "$ref": "TokenPagination" + "$ref": "TokenPagination", + "deprecated": true }, "visitorId": { + "deprecated": true, "description": "The visitorId identifies the visitor.", "type": "string" } @@ -8429,6 +8537,7 @@ }, "fanFundingEventDetails": { "$ref": "LiveChatFanFundingEventDetails", + "deprecated": true, "description": "Details about the funding event, this is only set if the type is 'fanFundingEvent'." }, "giftMembershipReceivedDetails": { @@ -8555,6 +8664,7 @@ "type": "string" }, "eventId": { + "deprecated": true, "description": "Serialized EventId of the request which produced this response.", "type": "string" }, @@ -8583,9 +8693,11 @@ "type": "string" }, "tokenPagination": { - "$ref": "TokenPagination" + "$ref": "TokenPagination", + "deprecated": true }, "visitorId": { + "deprecated": true, "description": "The visitorId identifies the visitor.", "type": "string" } @@ -8917,6 +9029,7 @@ "type": "string" }, "eventId": { + "deprecated": true, "description": "Serialized EventId of the request which produced this response.", "type": "string" }, @@ -8944,9 +9057,11 @@ "type": "string" }, "tokenPagination": { - "$ref": "TokenPagination" + "$ref": "TokenPagination", + "deprecated": true }, "visitorId": { + "deprecated": true, "description": "The visitorId identifies the visitor.", "type": "string" } @@ -9072,6 +9187,7 @@ "type": "string" }, "eventId": { + "deprecated": true, "description": "Serialized EventId of the request which produced this response.", "type": "string" }, @@ -9095,9 +9211,11 @@ "$ref": "PageInfo" }, "tokenPagination": { - "$ref": "TokenPagination" + "$ref": "TokenPagination", + "deprecated": true }, "visitorId": { + "deprecated": true, "description": "The visitorId identifies the visitor.", "type": "string" } @@ -9220,6 +9338,7 @@ "type": "string" }, "eventId": { + "deprecated": true, "description": "Serialized EventId of the request which produced this response.", "type": "string" }, @@ -9236,6 +9355,7 @@ "type": "string" }, "visitorId": { + "deprecated": true, "description": "The visitorId identifies the visitor.", "type": "string" } @@ -9393,6 +9513,7 @@ "id": "PlaylistItemContentDetails", "properties": { "endAt": { + "deprecated": true, "description": "The time, measured in seconds from the start of the video, when the video should stop playing. (The playlist owner can specify the times when the video should start and stop playing when the video is played in the context of the playlist.) By default, assume that the video.endTime is the end of the video.", "type": "string" }, @@ -9401,6 +9522,7 @@ "type": "string" }, "startAt": { + "deprecated": true, "description": "The time, measured in seconds from the start of the video, when the video should start playing. (The playlist owner can specify the times when the video should start and stop playing when the video is played in the context of the playlist.) The default value is 0.", "type": "string" }, @@ -9554,6 +9676,7 @@ "type": "string" }, "eventId": { + "deprecated": true, "description": "Serialized EventId of the request which produced this response.", "type": "string" }, @@ -9582,9 +9705,11 @@ "type": "string" }, "tokenPagination": { - "$ref": "TokenPagination" + "$ref": "TokenPagination", + "deprecated": true }, "visitorId": { + "deprecated": true, "description": "The visitorId identifies the visitor.", "type": "string" } @@ -9646,6 +9771,7 @@ "type": "string" }, "tags": { + "deprecated": true, "description": "Keyword tags associated with the playlist.", "items": { "type": "string" @@ -9931,6 +10057,7 @@ "type": "string" }, "eventId": { + "deprecated": true, "description": "Serialized EventId of the request which produced this response.", "type": "string" }, @@ -9958,9 +10085,11 @@ "type": "string" }, "tokenPagination": { - "$ref": "TokenPagination" + "$ref": "TokenPagination", + "deprecated": true }, "visitorId": { + "deprecated": true, "description": "The visitorId identifies the visitor.", "type": "string" } @@ -10063,6 +10192,7 @@ "type": "string" }, "eventId": { + "deprecated": true, "description": "Serialized EventId of the request which produced this response.", "type": "string" }, @@ -10086,9 +10216,11 @@ "$ref": "PageInfo" }, "tokenPagination": { - "$ref": "TokenPagination" + "$ref": "TokenPagination", + "deprecated": true }, "visitorId": { + "deprecated": true, "description": "The visitorId identifies the visitor.", "type": "string" } @@ -10336,6 +10468,7 @@ "type": "string" }, "eventId": { + "deprecated": true, "description": "Serialized EventId of the request which produced this response.", "type": "string" }, @@ -10352,6 +10485,7 @@ "type": "string" }, "visitorId": { + "deprecated": true, "description": "The visitorId identifies the visitor.", "type": "string" } @@ -10423,6 +10557,7 @@ }, "projectDetails": { "$ref": "VideoProjectDetails", + "deprecated": true, "description": "The projectDetails object contains information about the project specific video metadata. b/157517979: This part was never populated after it was added. However, it sees non-zero traffic because there is generated client code in the wild that refers to it [1]. We keep this field and do NOT remove it because otherwise V3 would return an error when this part gets requested [2]. [1] https://developers.google.com/resources/api-libraries/documentation/youtube/v3/csharp/latest/classGoogle_1_1Apis_1_1YouTube_1_1v3_1_1Data_1_1VideoProjectDetails.html [2] http://google3/video/youtube/src/python/servers/data_api/common.py?l=1565-1569&rcl=344141677" }, "recordingDetails": { @@ -10510,6 +10645,7 @@ "type": "string" }, "eventId": { + "deprecated": true, "description": "Serialized EventId of the request which produced this response.", "type": "string" }, @@ -10526,6 +10662,7 @@ "type": "string" }, "visitorId": { + "deprecated": true, "description": "The `visitorId` identifies the visitor.", "type": "string" } @@ -10626,6 +10763,7 @@ "type": "string" }, "eventId": { + "deprecated": true, "description": "Serialized EventId of the request which produced this response.", "type": "string" }, @@ -10654,9 +10792,11 @@ "type": "string" }, "tokenPagination": { - "$ref": "TokenPagination" + "$ref": "TokenPagination", + "deprecated": true }, "visitorId": { + "deprecated": true, "description": "The visitorId identifies the visitor.", "type": "string" } @@ -10748,6 +10888,7 @@ }, "regionRestriction": { "$ref": "VideoContentDetailsRegionRestriction", + "deprecated": true, "description": "The regionRestriction object contains information about the countries where a video is (or is not) viewable. The object will contain either the contentDetails.regionRestriction.allowed property or the contentDetails.regionRestriction.blocked property." } }, @@ -10935,6 +11076,7 @@ "type": "string" }, "eventId": { + "deprecated": true, "description": "Serialized EventId of the request which produced this response.", "type": "string" }, @@ -10951,6 +11093,7 @@ "type": "string" }, "visitorId": { + "deprecated": true, "description": "The visitorId identifies the visitor.", "type": "string" } @@ -10965,6 +11108,7 @@ "type": "string" }, "eventId": { + "deprecated": true, "description": "Serialized EventId of the request which produced this response.", "type": "string" }, @@ -10992,9 +11136,11 @@ "type": "string" }, "tokenPagination": { - "$ref": "TokenPagination" + "$ref": "TokenPagination", + "deprecated": true }, "visitorId": { + "deprecated": true, "description": "The visitorId identifies the visitor.", "type": "string" } @@ -11305,6 +11451,7 @@ "type": "string" }, "favoriteCount": { + "deprecated": true, "description": "The number of users who currently have the video marked as a favorite video.", "format": "uint64", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/youtubeAnalytics.v2.json b/googleapiclient/discovery_cache/documents/youtubeAnalytics.v2.json index 19f2c1e4288..d878f7840f0 100644 --- a/googleapiclient/discovery_cache/documents/youtubeAnalytics.v2.json +++ b/googleapiclient/discovery_cache/documents/youtubeAnalytics.v2.json @@ -421,7 +421,7 @@ } } }, - "revision": "20230704", + "revision": "20230710", "rootUrl": "https://youtubeanalytics.googleapis.com/", "schemas": { "EmptyResponse": { diff --git a/googleapiclient/discovery_cache/documents/youtubereporting.v1.json b/googleapiclient/discovery_cache/documents/youtubereporting.v1.json index 2bbb22cd63a..7344b4b9cb1 100644 --- a/googleapiclient/discovery_cache/documents/youtubereporting.v1.json +++ b/googleapiclient/discovery_cache/documents/youtubereporting.v1.json @@ -411,7 +411,7 @@ } } }, - "revision": "20230704", + "revision": "20230710", "rootUrl": "https://youtubereporting.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/version.py b/googleapiclient/version.py index 61199f844aa..b72d93a710a 100644 --- a/googleapiclient/version.py +++ b/googleapiclient/version.py @@ -12,4 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. -__version__ = "2.92.0" +__version__ = "2.93.0" diff --git a/samples/compute/requirements.txt b/samples/compute/requirements.txt index 1ede6ab6e2a..290dd1121f2 100644 --- a/samples/compute/requirements.txt +++ b/samples/compute/requirements.txt @@ -1,3 +1,3 @@ -google-api-python-client==2.92.0 -google-auth==2.21.0 +google-api-python-client==2.93.0 +google-auth==2.22.0 google-auth-httplib2==0.1.0 diff --git a/scripts/decrypt-secrets.sh b/scripts/decrypt-secrets.sh index 21f6d2a26d9..0018b421ddf 100755 --- a/scripts/decrypt-secrets.sh +++ b/scripts/decrypt-secrets.sh @@ -1,6 +1,6 @@ #!/bin/bash -# Copyright 2015 Google Inc. All rights reserved. +# Copyright 2023 Google LLC All rights reserved. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. diff --git a/scripts/readme-gen/readme_gen.py b/scripts/readme-gen/readme_gen.py index 2473846c3c8..a5fb6ba59ba 100644 --- a/scripts/readme-gen/readme_gen.py +++ b/scripts/readme-gen/readme_gen.py @@ -1,6 +1,6 @@ #!/usr/bin/env python -# Copyright 2016 Google Inc +# Copyright 2023 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License.